class Puppet::Application::Doc

# File lib/puppet/application/doc.rb, line 161
def handle_unknown( opt, arg )
  @unknown_args << {:opt => opt, :arg => arg }
  true
end

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

WARNING: RDoc support is only available under Ruby 1.8.7 and earlier.


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.

WARNING: RDoc support is only available under Ruby 1.8.7 and earlier.
The internal API used to support manifest documentation has changed
radically in newer versions, and support is not yet available for
using those versions of RDoc.


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

# File lib/puppet/application/doc.rb, line 197
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

# 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

# File lib/puppet/application/doc.rb, line 170
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
    Puppet.log_exception(detail, "Could not generate documentation: #{detail}")
    exit_code = 1
  end
  exit exit_code
end

# File lib/puppet/application/doc.rb, line 166
def run_command
  return[:rdoc].include?(options[:mode]) ? send(options[:mode]) : other
end

# File lib/puppet/application/doc.rb, line 226
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

# File lib/puppet/application/doc.rb, line 252
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

  # 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

# File lib/puppet/application/doc.rb, line 240
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