framework_tool: Add man page#352
Open
nadzyah wants to merge 3 commits into
Open
Conversation
a718d1e to
359d6af
Compare
Signed-off-by: Daniel Schaefer <dhs@frame.work>
So that we don't have to manually maintain it. Signed-off-by: Daniel Schaefer <dhs@frame.work>
Member
|
Thanks! Yes it's good to have a manpage but I don't want to maintain it, so I added clap_mangen to auto-gen it. |
Contributor
Author
Thanks so much for your review! I honestly think a hand-written version might be more helpful since it includes examples and organises options into clear blocks. But of course, since you’re an upstream, the final call is completely yours whether to go with a handwritten or autogenerated one :) |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
When I packaged this crate for Debian, I also wrote an mdoc-format manual page documenting the commands, options, and usage of the tool. I guess it would be useful to ship it together with the crate so other distros can also use it
Let me know if it needs any adjustments