summaryrefslogtreecommitdiffstats
path: root/lib/puppet/interface/documentation.rb
diff options
context:
space:
mode:
authorNick Lewis <nick@puppetlabs.com>2011-06-08 18:47:44 -0700
committerNick Lewis <nick@puppetlabs.com>2011-06-08 18:47:44 -0700
commit649b3dc58349d3bbb1bd28bf882013c2cf5b8000 (patch)
tree1f047edff3c51258b3367a1d5c9f5cfbb02b4c71 /lib/puppet/interface/documentation.rb
parente0573603c5780e79c2461ece604c6388e4222504 (diff)
parent8ccd00963d91f168438eaec4b29a18cd4a1ac583 (diff)
downloadpuppet-649b3dc58349d3bbb1bd28bf882013c2cf5b8000.tar.gz
puppet-649b3dc58349d3bbb1bd28bf882013c2cf5b8000.tar.xz
puppet-649b3dc58349d3bbb1bd28bf882013c2cf5b8000.zip
Merge branch '2.7.x'
Diffstat (limited to 'lib/puppet/interface/documentation.rb')
-rw-r--r--lib/puppet/interface/documentation.rb31
1 files changed, 31 insertions, 0 deletions
diff --git a/lib/puppet/interface/documentation.rb b/lib/puppet/interface/documentation.rb
index fcaec2568..47e478a44 100644
--- a/lib/puppet/interface/documentation.rb
+++ b/lib/puppet/interface/documentation.rb
@@ -61,6 +61,37 @@ class Puppet::Interface
end
attr_doc :description
+
+ def build_synopsis(face, action = nil, arguments = nil)
+ output = PrettyPrint.format do |s|
+ s.text("puppet #{face}")
+ s.text(" #{action}") unless action.nil?
+ s.text(" ")
+
+ options.each do |option|
+ option = get_option(option)
+ wrap = option.required? ? %w{ < > } : %w{ [ ] }
+
+ s.group(0, *wrap) do
+ option.optparse.each do |item|
+ unless s.current_group.first?
+ s.breakable
+ s.text '|'
+ s.breakable
+ end
+ s.text item
+ end
+ end
+
+ s.breakable
+ end
+
+ if arguments then
+ s.text arguments.to_s
+ end
+ end
+ end
+
end
module FullDocs