Sha256: 5043a6672afd64603aede5e4cf1e82ed49e8df6bfa295bf3ee945bac8856b8ba

Contents?: true

Size: 1.99 KB

Versions: 39

Compression:

Stored size: 1.99 KB

Contents

config = Puppet::Util::Reference.newreference(:configuration, :depth => 1, :doc => "A reference for all configuration parameters") do
  docs = {}
  Puppet.settings.each do |name, object|
    docs[name] = object
  end

  str = ""
  docs.sort { |a, b|
    a[0].to_s <=> b[0].to_s
  }.each do |name, object|
    # Make each name an anchor
    header = name.to_s
    str << markdown_header(header, 3)

    # Print the doc string itself
    begin
      str << object.desc.gsub(/\n/, " ")
    rescue => detail
      puts detail.backtrace
      puts detail
    end
    str << "\n\n"

    # Now print the data about the item.
    str << ""
    val = object.default
    if name.to_s == "vardir"
      val = "/var/lib/puppet"
    elsif name.to_s == "confdir"
      val = "/etc/puppet"
    end

    # Leave out the section information; it was apparently confusing people.
    #str << "- **Section**: #{object.section}\n"
    unless val == ""
      str << "- *Default*: #{val}\n"
    end
    str << "\n"
  end

  return str
end

config.header = <<EOT
## Configuration Settings

* Each of these settings can be specified in `puppet.conf` or on the
  command line.
* When using boolean settings on the command line, use `--setting` and
  `--no-setting` instead of `--setting (true|false)`.
* Settings can be interpolated as `$variables` in other settings; `$environment`
  is special, in that puppet master will interpolate each agent node's
  environment instead of its own.
* Multiple values should be specified as comma-separated lists; multiple
  directories should be separated with the system path separator (usually
  a colon).
* Settings that take a single file or directory can optionally set the owner,
  group, and mode for their value: `rundir = $vardir/run { owner = puppet,
  group = puppet, mode = 644 }`
* The Puppet executables will ignore any setting that isn't relevant to
  their function.

See the [configuration guide][confguide] for more details.

[confguide]: http://docs.puppetlabs.com/guides/configuring.html

* * *

EOT

Version data entries

39 entries across 39 versions & 4 rubygems

Version Path
puppet-parse-0.1.4 lib/vendor/puppet/reference/configuration.rb
puppet-parse-0.1.3 lib/vendor/puppet/reference/configuration.rb
puppet-parse-0.1.2 lib/vendor/puppet/reference/configuration.rb
puppet-parse-0.1.1 lib/vendor/puppet/reference/configuration.rb
puppet-2.7.26 lib/puppet/reference/configuration.rb
puppet-2.7.25 lib/puppet/reference/configuration.rb
puppet-2.7.24 lib/puppet/reference/configuration.rb
puppet-2.7.23 lib/puppet/reference/configuration.rb
puppet-2.7.22 lib/puppet/reference/configuration.rb
puppet-parse-0.1.0 lib/vendor/puppet/reference/configuration.rb
puppet-parse-0.0.6 lib/vendor/puppet/reference/configuration.rb
puppet-2.7.21 lib/puppet/reference/configuration.rb
puppet-parse-0.0.5 lib/vendor/puppet/reference/configuration.rb
puppet-parse-0.0.4 lib/vendor/puppet/reference/configuration.rb
puppet-parse-0.0.2 lib/vendor/puppet/reference/configuration.rb
puppet-2.7.20 lib/puppet/reference/configuration.rb
puppet-2.7.20.rc1 lib/puppet/reference/configuration.rb
librarian-puppet-0.9.4 vendor/gems/ruby/1.8/gems/puppet-2.7.18/lib/puppet/reference/configuration.rb
puppet-2.7.19 lib/puppet/reference/configuration.rb
supply_drop-0.11.0 examples/vendored-puppet/vendor/puppet-2.7.8/lib/puppet/reference/configuration.rb