(PUP-12075) Render puppet man page correctly #9466
Merged
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
joshcooper
force-pushed
the
puppet_man
branch
2 times, most recently
from
ab8f969 to
ef2fc04
Compare
joshcooper
changed the title
Add common_app_summaries and specialized_app_summaries methods and refactor help face to call them.
Previously, the man/man8/puppet.8 man page wasn't formatted correctly with each subcommand and summary on a new line. This was because `puppet --help` doesn't output ronn format, just raw text. So generate `puppet.8.ronn` in valid ronn format so that it can be converted to roff. Use `man --local-file man/man8/puppet.8` to verify the results. Also don't blindly run `<bin>/<app> --help` for every app. That's left over from when puppet had multiple bin stubs. Since ronn shells out to groff, abort if the latter is not installed. Hardcode the http_user_agent value so it's not sensitive to the puppet version or the ruby version/architecture the user is running.
AriaXLi
approved these changes
Aug 30, 2024
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.
Previously, the man/man8/puppet.8 man page wasn't formatted correctly
with each subcommand and summary on a new line. This was because
puppet --helpdoesn't output ronn format, just raw text. So generatepuppet.8.ronnin valid ronn format so that it can be converted toroff. Use
man --local-file man/man8/puppet.8to verify the results.Also don't blindly run
<bin>/<app> --helpfor every app. That's leftover from when puppet had multiple bin stubs.
Since ronn shells out to groff, abort if the latter is not installed.
Hardcode the http_user_agent value so it's not sensitive to the puppet
version or the ruby version/architecture the user is running.