Fix missing text in "man gh-codespace-ssh" #6368
Merged
+5
−6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
|
Hi! Thanks for the pull request. Please ensure that this change is linked to an issue by mentioning an issue number in the description of the pull request. If this pull request would close the issue, please put the word 'Fixes' before the issue number somewhere in the pull request body. If this is a tiny change like fixing a typo, feel free to ignore this message. |
mislav
approved these changes
Sep 29, 2022
Thanks for the workaround!
For a long-term fix, I'd like us to report this and fix it in the upstream md2man library which is supposed to be escaping these things. This issue might be related cpuguy83/go-md2man#46
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
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 (i.e. not renders) the content of that whole line:
To reproduce:
Discovered by the Debian Lintian tool.