fix(mangen): Honor the bin_name when rendering manpages #4758
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
Use the user-supplied bin_name over the command name for the synopsis and subcommand name. This presents a sample invocation more in line with how the CLI will be used.
arusahni
changed the title
epage
reviewed
Mar 13, 2023
Comment on lines
+12
to
+18
| my/-app help/-test(1) | ||
| tests things | ||
| .TP | ||
| my/-app/-help/-some_cmd(1) | ||
| my/-app help/-some_cmd(1) | ||
| top level subcommand | ||
| .TP | ||
| my/-app/-help/-help(1) | ||
| my/-app help/-help(1) |
There was a problem hiding this comment.
Shouldn't these have - all the way through?
Comment on lines
+31
to
+35
| fn get_command_name(cmd: &clap::Command) -> &str { | ||
| cmd.get_bin_name() | ||
| .or_else(|| cmd.get_display_name()) | ||
| .unwrap_or_else(|| cmd.get_name()) | ||
| } |
There was a problem hiding this comment.
The main risk for this is if the user parsed with the Command before calling this, leading it to have a .exe in the root bin name which can cause problems with this approach
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.
Suggestion cannot be applied right now. Please check back later.
This feels like an inoffensive update to the manpage renderer. As the synopsis section provides a sample invocation, we should prefer to use the
bin_nameover the Crate's name if one has been specified.This did cause an interesting diff in the help subcommand ROFF snapshot test, where I discovered that the
helpcommand was not being prefixed with the parent command in the synopsis. Nor were spaces being used to delimit the app command from the subcommand name. What's introduced in this PR feels right to me, but I'll be interested to hear y'alls thoughts.Thanks for the review!
Fixes #4757