Sha256: 3fc32533fa1fc57787274e185b39380db1b4f7a86c32a52b85bc7d450f8221cf
Contents?: true
Size: 1.97 KB
Versions: 11
Compression:
Stored size: 1.97 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
Puppet.log_exception(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
11 entries across 11 versions & 1 rubygems