summaryrefslogtreecommitdiffstats
path: root/lib/puppet/face/help
diff options
context:
space:
mode:
authorDaniel Pittman <daniel@puppetlabs.com>2011-04-13 00:17:57 -0700
committerDaniel Pittman <daniel@puppetlabs.com>2011-04-13 00:17:57 -0700
commit4dd6a77481400b7eeac3377267d092d4c6d22da3 (patch)
treef95d292596144832805a9b57a55bc440f7cfaa43 /lib/puppet/face/help
parent941c56a283265cdf5a951ecaae63580b60486c52 (diff)
downloadpuppet-4dd6a77481400b7eeac3377267d092d4c6d22da3.tar.gz
puppet-4dd6a77481400b7eeac3377267d092d4c6d22da3.tar.xz
puppet-4dd6a77481400b7eeac3377267d092d4c6d22da3.zip
(#7056) Use 'face' rather than 'faces' in the production code.
After some discussion we decided that most uses of the Puppet Face infrastructure were about single faces on their own, not about the collection, and so we were better referring to Puppet::Face[...] in code. This implements that by translating names and references in the Ruby code to the new, s-less, name.
Diffstat (limited to 'lib/puppet/face/help')
-rw-r--r--lib/puppet/face/help/action.erb3
-rw-r--r--lib/puppet/face/help/face.erb7
-rw-r--r--lib/puppet/face/help/global.erb20
3 files changed, 30 insertions, 0 deletions
diff --git a/lib/puppet/face/help/action.erb b/lib/puppet/face/help/action.erb
new file mode 100644
index 000000000..eaf131464
--- /dev/null
+++ b/lib/puppet/face/help/action.erb
@@ -0,0 +1,3 @@
+Use: puppet <%= face.name %> [options] <%= action.name %> [options]
+
+Summary: <%= action.summary %>
diff --git a/lib/puppet/face/help/face.erb b/lib/puppet/face/help/face.erb
new file mode 100644
index 000000000..efe5fd809
--- /dev/null
+++ b/lib/puppet/face/help/face.erb
@@ -0,0 +1,7 @@
+Use: puppet <%= face.name %> [options] <action> [options]
+
+Available actions:
+% face.actions.each do |actionname|
+% action = face.get_action(actionname)
+ <%= action.name.to_s.ljust(16) %> <%= action.summary %>
+% end
diff --git a/lib/puppet/face/help/global.erb b/lib/puppet/face/help/global.erb
new file mode 100644
index 000000000..f4c761b2b
--- /dev/null
+++ b/lib/puppet/face/help/global.erb
@@ -0,0 +1,20 @@
+puppet <subcommand> [options] <action> [options]
+
+Available subcommands, from Puppet Faces:
+% Puppet::Face.faces.sort.each do |name|
+% face = Puppet::Face[name, :current]
+ <%= face.name.to_s.ljust(16) %> <%= face.summary %>
+% end
+
+% unless legacy_applications.empty? then # great victory when this is true!
+Available applications, soon to be ported to Faces:
+% legacy_applications.each do |appname|
+% summary = horribly_extract_summary_from appname
+ <%= appname.to_s.ljust(16) %> <%= summary %>
+% end
+% end
+
+See 'puppet help <subcommand> <action>' for help on a specific subcommand action.
+See 'puppet help <subcommand>' for help on a specific subcommand.
+See 'puppet man <subcommand>' for the full man page.
+Puppet v<%= Puppet::PUPPETVERSION %>