STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix missing text in gh-codespace-ssh.1 man page

Browse source 
Rearrange the long help text so that '--config' does not appear at the
start of a line which groff interprets as an undefined macro and skips
the content of that whole line.

To reproduce:

  $ go run cmd/gen-docs/main.go --man-page --doc-path /tmp/gh-manpages
  $ man --warnings -E UTF-8 -l -Tutf8 -Z /tmp/gh-manpages/gh-codespace-ssh.1 >/dev/null
  troff: <standard input>:26: warning: macro '--config'' not defined

Discovered by the Debian Lintian tool.
This commit is contained in:
Anthony Fok 2022-09-28 13:53:21 -06:00
parent 98d08cdcba
commit f6d0f82701
No known key found for this signature in database
GPG key ID: EA2500B412C59ACF
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
pkg/cmd/codespace/ssh.go
View file

@ -60,12 +60,11 @@ func newSSHCmd(app *App) *cobra.Command {
By default, the 'ssh' command will create a public/private ssh key pair to
authenticate with the codespace inside the ~/.ssh directory.
The 'ssh' command also supports deeper integration with OpenSSH using a
'--config' option that generates per-codespace ssh configuration in OpenSSH
format. Including this configuration in your ~/.ssh/config improves the user
experience of tools that integrate with OpenSSH, such as bash/zsh completion of
ssh hostnames, remote path completion for scp/rsync/sshfs, git ssh remotes, and
so on.
The 'ssh' command also supports deeper integration with OpenSSH using a '--config'
option that generates per-codespace ssh configuration in OpenSSH format.
Including this configuration in your ~/.ssh/config improves the user experience
of tools that integrate with OpenSSH, such as bash/zsh completion of ssh hostnames,
remote path completion for scp/rsync/sshfs, git ssh remotes, and so on.
Once that is set up (see the second example below), you can ssh to codespaces as
if they were ordinary remote hosts (using 'ssh', not 'gh cs ssh').