-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(PUP-12075) Render puppet man page correctly
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.
- Loading branch information
1 parent
0bf9a62
commit ef2fc04
Showing
3 changed files
with
165 additions
and
16 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
puppet(8) - an automated configuration management tool | ||
========= | ||
|
||
## SYNOPSIS | ||
|
||
`puppet` <subcommand> [options] <action> [options] | ||
|
||
## DESCRIPTION | ||
|
||
Puppet, an automated administrative engine for your Linux, Unix, and Windows systems, performs administrative tasks | ||
(such as adding users, installing packages, and updating server configurations) based on a centralized specification. | ||
|
||
## COMMANDS | ||
|
||
### Common | ||
|
||
<% common.each do |appname, summary, _| -%> | ||
`<%= appname.to_s %>`<br> | ||
<%= summary %> | ||
<% end -%> | ||
|
||
### Specialized | ||
|
||
<% specialized.each do |appname, summary, _| -%> | ||
`<%= appname.to_s %>`<br> | ||
<%= summary %> | ||
<% end -%> | ||
|
||
## SEE ALSO | ||
See `puppet help <subcommand>` for help on a specific subcommand. | ||
|
||
See `puppet help <subcommand> <action>` for help on a specific subcommand action. |
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