Add a COMMANDS section to generated man pages #939
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
|
|
orobardet
force-pushed
the
add-COMMANDS-section-man-pages
branch
3 times, most recently
from
65614da to
cfa3fa1
Compare
|
I finished working on this PR, it's ready to be reviewed. |
|
This PR is being marked as stale due to a long period of inactivity |
|
Is there anything to do or change to help on this PR? |
|
cc @jharshman |
|
Would need fixed up to use a StringWriter instead of the bytes.Buffer. Untagged the issue as stale and mentioned it with maintainers to see if others want to see this merged. |
orobardet
force-pushed
the
add-COMMANDS-section-man-pages
branch
from
cfa3fa1 to
28b69df
Compare
github-actions
bot
added
area/docs-generation
orobardet
force-pushed
the
add-COMMANDS-section-man-pages
branch
2 times, most recently
from
9a6f197 to
94cc3e9
Compare
|
Hi @johnSchnake I just pushed an update rebased on the latest master, and using StringWriter. Which maintainer do I need to mention to have a look on this PR? |
When a command has available sub-commands, the COMMANDS man section is generated with the list of sub-commands, with their name, short description, and the name of the dedicated man page.
orobardet
force-pushed
the
add-COMMANDS-section-man-pages
branch
from
94cc3e9 to
98e8c71
Compare
hoshsadiq
pushed a commit
to zulucmd/zulu
that referenced
this pull request
Dec 31, 2022
When a command has available sub-commands, the COMMANDS man section is generated with the list of sub-commands, with their name, short description, and the name of the dedicated man page. Merge spf13/cobra#939 Fixes spf13/cobra#680
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 PR enhance the man generation with the ability to add a COMMANDS section in generated man page for sub-commands.
When a command has available sub-commands, the COMMANDS
man section is generated with the list of sub-commands, with
their name, short description, and the name of the dedicated
man page.
This fixes #680