diff options
author | luke <luke@980ebf18-57e1-0310-9a29-db15c13687c0> | 2007-06-20 00:16:41 +0000 |
---|---|---|
committer | luke <luke@980ebf18-57e1-0310-9a29-db15c13687c0> | 2007-06-20 00:16:41 +0000 |
commit | 3aafa84493dbc1f3764526a16fb1fdac6e1671e9 (patch) | |
tree | 5b053eaa0cbe90f238d2d83112fa1c12d6462643 | |
parent | 55a512c21c8a58689c0651376a9e99980cf4791e (diff) | |
download | puppet-3aafa84493dbc1f3764526a16fb1fdac6e1671e9.tar.gz puppet-3aafa84493dbc1f3764526a16fb1fdac6e1671e9.tar.xz puppet-3aafa84493dbc1f3764526a16fb1fdac6e1671e9.zip |
Updating reference docs
git-svn-id: https://reductivelabs.com/svn/puppet/trunk@2637 980ebf18-57e1-0310-9a29-db15c13687c0
-rwxr-xr-x | lib/puppet/network/handler/report.rb | 1 | ||||
-rw-r--r-- | lib/puppet/parser/functions.rb | 4 | ||||
-rw-r--r-- | lib/puppet/reference/configuration.rb | 30 |
3 files changed, 18 insertions, 17 deletions
diff --git a/lib/puppet/network/handler/report.rb b/lib/puppet/network/handler/report.rb index 827f5978b..8a82f5a58 100755 --- a/lib/puppet/network/handler/report.rb +++ b/lib/puppet/network/handler/report.rb @@ -52,6 +52,7 @@ class Puppet::Network::Handler docs = "" # Use this method so they all get loaded + instance_loader(:report).loadall loaded_instances(:report).sort { |a,b| a.to_s <=> b.to_s }.each do |name| mod = self.report(name) docs += "%s\n%s\n" % [name, "-" * name.to_s.length] diff --git a/lib/puppet/parser/functions.rb b/lib/puppet/parser/functions.rb index c2f27a6b0..00bd27bb0 100644 --- a/lib/puppet/parser/functions.rb +++ b/lib/puppet/parser/functions.rb @@ -160,7 +160,9 @@ module Functions # Test whether a given class or definition is defined newfunction(:defined, :type => :rvalue, :doc => "Determine whether a given type is defined, either as a native type or a defined type, or whether a class is defined. - This is useful for checking whether a class is defined and only including it if it is.") do |vals| + This is useful for checking whether a class is defined and only including it if it is. + This function can also test whether a resource has been defined, using resource references + (e.g., ``if defined(File['/tmp/myfile'] { ... }``).") do |vals| result = false vals.each do |val| case val diff --git a/lib/puppet/reference/configuration.rb b/lib/puppet/reference/configuration.rb index b7076a1e5..b83992290 100644 --- a/lib/puppet/reference/configuration.rb +++ b/lib/puppet/reference/configuration.rb @@ -46,25 +46,23 @@ Specifying Configuration Parameters On The Command-Line +++++++++++++++++++ Every Puppet executable (with the exception of ``puppetdoc``) accepts all of -the arguments below, but not all of the arguments make sense for every executable. -Each argument has a section listed with it in parentheses; often, that section +the parameters below, but not all of the arguments make sense for every executable. +Each parameter has a section listed with it in parentheses; often, that section will map to an executable (e.g., ``puppetd``), in which case it probably only -makes sense for that one executable. If ``puppet`` is listed as the section, +makes sense for that one executable. If ``main`` is listed as the section, it is most likely an option that is valid for everyone. -This will not always be the case. I have tried to be as thorough as possible -in the descriptions of the arguments, so it should be obvious whether an -argument is appropriate or not. +I have tried to be as thorough as possible in the descriptions of the +arguments, so it should be obvious whether an argument is appropriate or not. -These arguments can be supplied to the executables either as command-line -arugments or in the configuration file for the appropriate executable. For -instance, the command-line invocation below would set the configuration directory -to ``/private/puppet``:: +These parameters can be supplied to the executables either as command-line +options or in the configuration file. For instance, the command-line +invocation below would set the configuration directory to ``/private/puppet``:: $ puppetd --confdir=/private/puppet -Note that boolean options are turned on and off with a slightly different syntax -on the command line:: +Note that boolean options are turned on and off with a slightly different +syntax on the command line:: $ puppetd --storeconfigs @@ -76,14 +74,14 @@ the client configuration. Configuration Files +++++++++++++++++++ As mentioned above, the configuration parameters can also be stored in a -configuration file located in the configuration directory (`/etc/puppet` -by default). All executables look for ``puppet.conf`` in their -configuration directory (although they used to each look to separate files). +configuration file, located in the configuration directory (`/etc/puppet` +by default). As of 0.23.0, all executables look for ``puppet.conf`` in their +configuration directory (although they previously looked for separate files). All executables will set any parameters set within the ``main`` section, while each executable will also look for a section named for the executable and load those parameters. For example, ``puppetd`` will look for a -section named ``puppetd`, and ``puppetmasterd`` looks for a section +section named ``puppetd``, and ``puppetmasterd`` looks for a section named ``puppetmasterd``. This allows you to use a single configuration file to customize the settings for all of your executables. |