Skip to content

Commit

Permalink
Render man/man5/puppetconf.5 correctly
Browse files Browse the repository at this point in the history
Previously, `rake genmanpages` generated warnings when converting ronn to man:

    roff: ./man/man5/puppetconf.5
    warn: unrecognized block tag: "hr"
    warn: unexpected text: "Return a YAML hash with up to three keys:"

The first warning was because definition lists need to have a space between each
item. As a result the entire line "Return a YAML hash with up to three keys" was
omitted from the output.

The second warning was because '* * *' is not valid in ronn.
  • Loading branch information
joshcooper committed Aug 12, 2024
1 parent d20cc43 commit ef22dc8
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions lib/puppet/defaults.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2126,10 +2126,12 @@ def self.initialize_default_settings!(settings)
can produce node information. The command must:
* Take the name of a node as a command-line argument.
* Return a YAML hash with up to three keys:
* `classes` --- A list of classes, as an array or hash.
* `environment` --- A string.
* `parameters` --- A list of top-scope variables to set, as a hash.
* For unknown nodes, exit with a non-zero exit code.
Generally, an ENC script makes requests to an external data source.
Expand Down
1 change: 0 additions & 1 deletion lib/puppet/reference/configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,5 @@
[confguide]: https://puppet.com/docs/puppet/latest/config_about_settings.html
* * *
EOT
1 change: 1 addition & 0 deletions man/man5/puppet.conf.5
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,7 @@ This setting\'s value must be the path to an executable command that can produce
Take the name of a node as a command\-line argument\.
.
.IP "\(bu" 4
Return a YAML hash with up to three keys:
.
.IP "\(bu" 4
\fBclasses\fR \-\-\- A list of classes, as an array or hash\.
Expand Down

0 comments on commit ef22dc8

Please sign in to comment.