Merge pull request #29 from nfagerlund/maint/2.7.x/minor_docs_fixes

Maint/2.7.x/minor docs fixes

2 files changed, 33 insertions, 30 deletions

diff --git a/lib/puppet/application/agent.rb b/lib/puppet/application/agent.rb
index ea7cbdfb5..b8645c3ce 100644
--- a/lib/puppet/application/agent.rb
+++ b/lib/puppet/application/agent.rb
@@ -100,12 +100,11 @@ similar), or run interactively for testing purposes.
 
 USAGE
 -----
-puppet agent  [-D|--daemonize|--no-daemonize] [-d|--debug]
-  [--detailed-exitcodes] [--disable] [--enable] [-h|--help]
-  [--certname <host name>] [-l|--logdest syslog|<file>|console]
-  [-o|--onetime] [--serve <handler>] [-t|--test] [--noop]
-  [--digest <digest>] [--fingerprint] [-V|--version]
-  [-v|--verbose] [-w|--waitforcert <seconds>]
+puppet agent [--certname <name>] [-D|--daemonize|--no-daemonize]
+  [-d|--debug] [--detailed-exitcodes] [--digest <digest>] [--disable] [--enable]
+  [--fingerprint] [-h|--help] [-l|--logdest syslog|<file>|console]
+  [--no-client] [--noop] [-o|--onetime] [--serve <handler>] [-t|--test]
+  [-v|--verbose] [-V|--version] [-w|--waitforcert <seconds>]
 
 
 DESCRIPTION
@@ -172,6 +171,13 @@ full list of acceptable parameters. A commented list of all
 configuration options can also be generated by running puppet agent with
 '--genconfig'.
 
+* --certname:
+  Set the certname (unique ID) of the client. The master reads this
+  unique identifying string, which is usually set to the node's
+  fully-qualified domain name, to determine which configurations the
+  node will receive. Use this option to debug setup problems or
+  implement unusual node identification schemes.
+
 * --daemonize:
   Send the process into the background. This is the default.
 
@@ -181,17 +187,17 @@ configuration options can also be generated by running puppet agent with
 * --debug:
   Enable full debugging.
 
-* --digest:
-  Change the certificate fingerprinting digest algorithm. The default is
-  MD5. Valid values depends on the version of OpenSSL installed, but
-  should always at least contain MD5, MD2, SHA1 and SHA256.
-
 * --detailed-exitcodes:
   Provide transaction information via exit codes. If this is enabled, an exit
   code of '2' means there were changes, an exit code of '4' means there were
   failures during the transaction, and an exit code of '6' means there were both
   changes and failures.
 
+* --digest:
+  Change the certificate fingerprinting digest algorithm. The default is
+  MD5. Valid values depends on the version of OpenSSL installed, but
+  should always at least contain MD5, MD2, SHA1 and SHA256.
+
 * --disable:
   Disable working on the local system. This puts a lock file in place,
   causing 'puppet agent' not to work on the system until the lock file
@@ -212,12 +218,10 @@ configuration options can also be generated by running puppet agent with
 
   'puppet agent' exits after executing this.
 
-* --certname:
-  Set the certname (unique ID) of the client. The master reads this
-  unique identifying string, which is usually set to the node's
-  fully-qualified domain name, to determine which configurations the
-  node will receive. Use this option to debug setup problems or
-  implement unusual node identification schemes.
+* --fingerprint:
+  Display the current certificate or certificate signing request
+  fingerprint and then exit. Use the '--digest' option to change the
+  digest algorithm used.
 
 * --help:
   Print this help message
@@ -230,18 +234,19 @@ configuration options can also be generated by running puppet agent with
 * --no-client:
   Do not create a config client. This will cause the daemon to run
   without ever checking for its configuration automatically, and only
-  makes sense
+  makes sense when puppet agent is being run with listen = true in puppet.conf
+  or was started with the `--listen` option.
+
+* --noop:
+  Use 'noop' mode where the daemon runs in a no-op or dry-run mode. This
+  is useful for seeing what changes Puppet will make without actually
+  executing the changes.
 
 * --onetime:
   Run the configuration once. Runs a single (normally daemonized) Puppet
   run. Useful for interactively running puppet agent when used in
   conjunction with the --no-daemonize option.
 
-* --fingerprint:
-  Display the current certificate or certificate signing request
-  fingerprint and then exit. Use the '--digest' option to change the
-  digest algorithm used.
-
 * --serve:
   Start another type of server. By default, 'puppet agent' will start a
   service handler that allows authenticated and authorized remote nodes
@@ -256,11 +261,6 @@ configuration options can also be generated by running puppet agent with
   'verbose', 'ignorecache', 'no-daemonize', 'no-usecacheonfailure',
   'detailed-exit-codes', 'no-splay', and 'show_diff'.
 
-* --noop:
-  Use 'noop' mode where the daemon runs in a no-op or dry-run mode. This
-  is useful for seeing what changes Puppet will make without actually
-  executing the changes.
-
 * --verbose:
   Turn on verbose reporting.
 
@@ -290,7 +290,7 @@ Puppet agent accepts the following signals:
   Restart the puppet agent daemon.
 * SIGINT and SIGTERM:
   Shut down the puppet agent daemon.
-* SIGUSR1: 
+* SIGUSR1:
   Immediately retrieve and apply configurations from the puppet master.
 
 AUTHOR
diff --git a/lib/puppet/defaults.rb b/lib/puppet/defaults.rb
index 2247634b3..d714305b3 100644
--- a/lib/puppet/defaults.rb
+++ b/lib/puppet/defaults.rb
@@ -545,7 +545,10 @@ module Puppet
     :puppetport => [8139, "Which port puppet agent listens on."],
     :noop => [false, "Whether puppet agent should be run in noop mode."],
     :runinterval => [1800, # 30 minutes
-      "How often puppet agent applies the client configuration; in seconds."],
+      "How often puppet agent applies the client configuration; in seconds.
+      Note that a runinterval of 0 means \"run continuously\" rather than
+      \"never run.\" If you want puppet agent to never run, you should start
+      it with the `--no-client` option."],
     :listen => [false, "Whether puppet agent should listen for
       connections.  If this is true, then puppet agent will accept incoming
       REST API requests, subject to the default ACLs and the ACLs set in