Class: Puppet::Application::Doc

Inherits:
Puppet::Application show all
Defined in:
lib/vendor/puppet/application/doc.rb

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows

Instance Attribute Summary collapse

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary collapse

Methods inherited from Puppet::Application

[], banner, clear!, clear?, #configure_indirector_routes, controlled_run, exit, find, #handlearg, #initialize, interrupted?, #main, #name, option, option_parser_commands, #parse_options, restart!, restart_requested?, #run, run_mode, #set_run_mode, #setup_logs, should_not_parse_config, should_parse_config, #should_parse_config?, should_parse_config?, stop!, stop_requested?

Methods included from Util

absolute_path?, activerecord_version, benchmark, binread, chuser, classproxy, #execfail, #execpipe, execute, execute_posix, execute_windows, logmethods, memory, path_to_uri, proxy, replace_file, safe_posix_fork, symbolize, symbolizehash, symbolizehash!, synchronize_on, thinmark, #threadlock, uri_to_path, wait_for_output, which, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Attribute Details

#manifest ⇒ Object

Returns the value of attribute manifest.



7
8
9
 
# File 'lib/vendor/puppet/application/doc.rb', line 7

def manifest
  @manifest
end

#unknown_args ⇒ Object

Returns the value of attribute unknown_args.



7
8
9
 
# File 'lib/vendor/puppet/application/doc.rb', line 7

def unknown_args
  @unknown_args
end

Instance Method Details

#handle_unknown(opt, arg) ⇒ Object 



155
156
157
158
 
# File 'lib/vendor/puppet/application/doc.rb', line 155

def handle_unknown( opt, arg )
  @unknown_args << {:opt => opt, :arg => arg }
  true
end

#help ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/vendor/puppet/application/doc.rb', line 52

def help
  <<-'HELP'

puppet-doc(8) -- Generate Puppet documentation and references
========

SYNOPSIS
--------
Generates a reference for all Puppet types. Largely meant for internal
Puppet Labs use.


USAGE
-----
puppet doc [-a|--all] [-h|--help] [-o|--outputdir <rdoc-outputdir>]
[-m|--mode text|pdf|rdoc] [-r|--reference <reference-name>]
[--charset <charset>] [<manifest-file>]


DESCRIPTION
-----------
If mode is not 'rdoc', then this command generates a Markdown document
describing all installed Puppet types or all allowable arguments to
puppet executables. It is largely meant for internal use and is used to
generate the reference document available on the Puppet Labs web site.

In 'rdoc' mode, this command generates an html RDoc hierarchy describing
the manifests that are in 'manifestdir' and 'modulepath' configuration
directives. The generated documentation directory is doc by default but
can be changed with the 'outputdir' option.

If the command is run with the name of a manifest file as an argument,
puppet doc will output a single manifest's documentation on stdout.


OPTIONS
-------
* --all:
Output the docs for all of the reference types. In 'rdoc' mode, this also
outputs documentation for all resources.

* --help:
Print this help message

* --outputdir:
Used only in 'rdoc' mode. The directory to which the rdoc output should
be written.

* --mode:
Determine the output mode. Valid modes are 'text', 'pdf' and 'rdoc'. The 'pdf'
mode creates PDF formatted files in the /tmp directory. The default mode is
'text'. In 'rdoc' mode you must provide 'manifests-path'

* --reference:
Build a particular reference. Get a list of references by running
'puppet doc --list'.

* --charset:
Used only in 'rdoc' mode. It sets the charset used in the html files produced.

* --manifestdir:
Used only in 'rdoc' mode. The directory to scan for stand-alone manifests.
If not supplied, puppet doc will use the manifestdir from puppet.conf.

* --modulepath:
Used only in 'rdoc' mode. The directory or directories to scan for modules.
If not supplied, puppet doc will use the modulepath from puppet.conf.

* --environment:
Used only in 'rdoc' mode. The configuration environment from which
to read the modulepath and manifestdir settings, when reading said settings
from puppet.conf. Due to a known bug, this option is not currently effective.


EXAMPLE
-------
  $ puppet doc -r type > /tmp/type_reference.markdown

or

  $ puppet doc --outputdir /tmp/rdoc --mode rdoc /path/to/manifests

or

  $ puppet doc /etc/puppet/manifests/site.pp

or

  $ puppet doc -m pdf -r configuration


AUTHOR
------
Luke Kanies


COPYRIGHT
---------
Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License

HELP
end

#other ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/vendor/puppet/application/doc.rb', line 192

def other
  text = ""
  with_contents = options[:references].length <= 1
  exit_code = 0
  require 'puppet/util/reference'
  options[:references].sort { |a,b| a.to_s <=> b.to_s }.each do |name|
    raise "Could not find reference #{name}" unless section = Puppet::Util::Reference.reference(name)

    begin
      # Add the per-section text, but with no ToC
      text += section.send(options[:format], with_contents)
    rescue => detail
      puts detail.backtrace
      $stderr.puts "Could not generate reference #{name}: #{detail}"
      exit_code = 1
      next
    end
  end

  text += Puppet::Util::Reference.footer unless with_contents # We've only got one reference

  if options[:mode] == :pdf
    Puppet::Util::Reference.pdf(text)
  else
    puts text
  end

  exit exit_code
end

#preinit ⇒ Object 



9
10
11
12
13
14
15
 
# File 'lib/vendor/puppet/application/doc.rb', line 9

def preinit
  {:references => [], :mode => :text, :format => :to_markdown }.each do |name,value|
    options[name] = value
  end
  @unknown_args = []
  @manifest = false
end

#rdoc ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/vendor/puppet/application/doc.rb', line 164

def rdoc
  exit_code = 0
  files = []
  unless @manifest
    env = Puppet::Node::Environment.new
    files += env.modulepath
    files << ::File.dirname(env[:manifest])
  end
  files += command_line.args
  Puppet.info "scanning: #{files.inspect}"

  Puppet.settings[:document_all] = options[:all] || false
  begin
    require 'puppet/util/rdoc'
    if @manifest
      Puppet::Util::RDoc.manifestdoc(files)
    else
      options[:outputdir] = "doc" unless options[:outputdir]
      Puppet::Util::RDoc.rdoc(options[:outputdir], files, options[:charset])
    end
  rescue => detail
    puts detail.backtrace if Puppet[:trace]
    $stderr.puts "Could not generate documentation: #{detail}"
    exit_code = 1
  end
  exit exit_code
end

#run_command ⇒ Object 



160
161
162
 
# File 'lib/vendor/puppet/application/doc.rb', line 160

def run_command
  return[:rdoc].include?(options[:mode]) ? send(options[:mode]) : other
end

#setup ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/vendor/puppet/application/doc.rb', line 222

def setup
  # sole manifest documentation
  if command_line.args.size > 0
    options[:mode] = :rdoc
    @manifest = true
  end

  if options[:mode] == :rdoc
    setup_rdoc
  else
    setup_reference
  end
end

#setup_rdoc(dummy_argument = :work_arround_for_ruby_GC_bug) ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/vendor/puppet/application/doc.rb', line 248

def setup_rdoc(dummy_argument=:work_arround_for_ruby_GC_bug)
  # consume the unknown options
  # and feed them as settings
  if @unknown_args.size > 0
    @unknown_args.each do |option|
      # force absolute path for modulepath when passed on commandline
      if option[:opt]=="--modulepath" or option[:opt] == "--manifestdir"
        option[:arg] = option[:arg].split(::File::PATH_SEPARATOR).collect { |p| ::File.expand_path(p) }.join(::File::PATH_SEPARATOR)
      end
      Puppet.settings.handlearg(option[:opt], option[:arg])
    end
  end

  # Now parse the config
  Puppet.parse_config

  # Handle the logging settings.
  if options[:debug] or options[:verbose]
    if options[:debug]
      Puppet::Util::Log.level = :debug
    else
      Puppet::Util::Log.level = :info
    end

    Puppet::Util::Log.newdestination(:console)
  end
end

#setup_reference ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/vendor/puppet/application/doc.rb', line 236

def setup_reference
  if options[:all]
    # Don't add dynamic references to the "all" list.
    require 'puppet/util/reference'
    options[:references] = Puppet::Util::Reference.references.reject do |ref|
      Puppet::Util::Reference.reference(ref).dynamic?
    end
  end

  options[:references] << :type if options[:references].empty?
end