Class: Puppet::Application::Doc

Inherits:

Puppet::Application

• Object
• Puppet::Application
• Puppet::Application::Doc

Defined in:

lib/puppet/application/doc.rb

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN, SHOULD_PARSE_CONFIG_DEPRECATION_MSG

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Instance Attribute Summary

• #manifest ⇒ Object
• #unknown_args ⇒ Object

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary

• #handle_unknown(opt, arg) ⇒ Object
• #help ⇒ Object
• #other ⇒ Object
• #preinit ⇒ Object
• #rdoc ⇒ Object
• #run_command ⇒ Object
• #setup ⇒ Object
• #setup_logging ⇒ Object
• #setup_rdoc(dummy_argument = :work_arround_for_ruby_GC_bug) ⇒ Object
• #setup_reference ⇒ Object

Methods inherited from Puppet::Application

[], #app_defaults, available_application_names, banner, clear!, clear?, clear_everything_for_tests, #configure_indirector_routes, controlled_run, exit, find, #handle_logdest_arg, #handlearg, #initialize, #initialize_app_defaults, interrupted?, #log_runtime_environment, #main, #name, option, option_parser_commands, #parse_options, restart!, restart_requested?, #run, run_mode, #set_log_level, #setup_logs, should_not_parse_config, should_parse_config, should_parse_config?, stop!, stop_requested?, try_load_class

Methods included from Util

absolute_path?, activerecord_version, benchmark, binread, chuser, classproxy, deterministic_rand, execfail, execpipe, execute, exit_on_fail, logmethods, memory, path_to_uri, pretty_backtrace, proxy, replace_file, safe_posix_fork, symbolizehash, thinmark, uri_to_path, which, withenv, withumask

Methods included from Util::POSIX

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

Methods included from Util::SymbolicFileMode

#normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Attribute Details

#manifest ⇒ Object

# File 'lib/puppet/application/doc.rb', line 6

def manifest
  @manifest
end

#unknown_args ⇒ Object

# File 'lib/puppet/application/doc.rb', line 6

def unknown_args
  @unknown_args
end

Instance Method Details

#handle_unknown(opt, arg) ⇒ Object

# File 'lib/puppet/application/doc.rb', line 154

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

#help ⇒ Object

# File 'lib/puppet/application/doc.rb', line 51

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] [-l|--list] [-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'.

* --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.


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

# File 'lib/puppet/application/doc.rb', line 190

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
      Puppet.log_exception(detail, "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

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

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

#rdoc ⇒ Object

# File 'lib/puppet/application/doc.rb', line 163

def rdoc
  exit_code = 0
  files = []
  unless @manifest
    env = Puppet.lookup(:current_environment)
    files += env.modulepath
    files << ::File.dirname(env.manifest) if env.manifest != Puppet::Node::Environment::NO_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
    Puppet.log_exception(detail, "Could not generate documentation: #{detail}")
    exit_code = 1
  end
  exit exit_code
end

#run_command ⇒ Object

# File 'lib/puppet/application/doc.rb', line 159

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

#setup ⇒ Object

# File 'lib/puppet/application/doc.rb', line 219

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

  setup_logging
end

#setup_logging ⇒ Object

# File 'lib/puppet/application/doc.rb', line 261

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

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

#setup_rdoc(dummy_argument = :work_arround_for_ruby_GC_bug) ⇒ Object

# File 'lib/puppet/application/doc.rb', line 247

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
end

#setup_reference ⇒ Object

# File 'lib/puppet/application/doc.rb', line 235

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