summaryrefslogtreecommitdiffstats
path: root/lib/puppet/face/help/man.erb
diff options
context:
space:
mode:
authornfagerlund <nick.fagerlund@gmail.com>2011-06-07 14:35:43 -0700
committernfagerlund <nick.fagerlund@gmail.com>2011-06-07 14:35:43 -0700
commit26a6e3937ac0f720a193ee0ec72d66b889a78b5c (patch)
tree7875a3832c4b1a9acccb12ba1609da997c8cac1d /lib/puppet/face/help/man.erb
parentd0d1e2ef64c4a6eecf3465dff82b62cf2cc79afb (diff)
parent17723634875e308b2752efed8ebdfd3db3239215 (diff)
downloadpuppet-26a6e3937ac0f720a193ee0ec72d66b889a78b5c.tar.gz
puppet-26a6e3937ac0f720a193ee0ec72d66b889a78b5c.tar.xz
puppet-26a6e3937ac0f720a193ee0ec72d66b889a78b5c.zip
Merge branch 'ticket/2.7rc/7764-Faces_help_revisions' into 2.7rc
Diffstat (limited to 'lib/puppet/face/help/man.erb')
-rw-r--r--lib/puppet/face/help/man.erb20
1 files changed, 12 insertions, 8 deletions
diff --git a/lib/puppet/face/help/man.erb b/lib/puppet/face/help/man.erb
index 6f21fe413..90e27964c 100644
--- a/lib/puppet/face/help/man.erb
+++ b/lib/puppet/face/help/man.erb
@@ -1,4 +1,4 @@
-puppet-<%= face.name %>(8) -- <%= face.summary || "Unknown face." %>
+puppet-<%= face.name %>(8) -- <%= face.summary || "Undocumented subcommand." %>
<%= '=' * (_erbout.length - 1) %>
<% if face.synopsis -%>
@@ -32,7 +32,7 @@ configuration options can also be generated by running puppet with
and `master`.
* --render-as FORMAT:
The format in which to render output. The most common formats are `json`,
- `s` (string), and `yaml`, but other options such as `dot` are
+ `s` (string), `yaml`, and `console`, but other options such as `dot` are
sometimes available.
* --verbose:
Whether to log verbosely.
@@ -57,12 +57,15 @@ ACTIONS
<%= action.synopsis %>
<% end -%>
-<% if action.description -%>
`DESCRIPTION`
+<% if action.description -%>
<%= action.description.gsub(/^/, ' ') %>
-<% end
- unique_options = action.options - face.options
+<% else -%>
+ <%= action.summary || "Undocumented action." %>
+<% end -%>
+
+<% unique_options = action.options - face.options
unless unique_options.empty? -%>
`OPTIONS`
@@ -101,6 +104,7 @@ EXAMPLES
`<%= action.name.to_s %>`
<%= action.examples.strip %>
+
<% end
end -%>
@@ -112,9 +116,9 @@ NOTES
<% end # notes
if face.respond_to? :indirection -%>
-This is an indirector face, which exposes `find`, `search`, `save`, and
-`destroy` actions for an indirected subsystem of Puppet. Valid termini
-for this face include:
+This subcommand is an indirector face, which exposes `find`, `search`, `save`,
+and `destroy` actions for an indirected subsystem of Puppet. Valid termini for
+this face include:
* `<%= face.class.terminus_classes(face.indirection.name).join("`\n* `") %>`