[Pkg-puppet-devel] [SCM] Puppet packaging for Debian branch, experimental, updated. debian/2.6.8-1-844-g7ec39d5

Tue May 10 08:04:47 UTC 2011

The following commit has been merged in the experimental branch:
commit 3f1c26ff5699589e06f9fd48c0bd9ac3379a4c07
Author: nfagerlund <nick.fagerlund at gmail.com>
Date:   Wed Feb 16 14:55:58 2011 -0800

    (#1204) Reformat help text for puppet kick and inspect
    
    Markdown changes for compatibility with ronn.

diff --git a/lib/puppet/application/inspect.rb b/lib/puppet/application/inspect.rb
index 599898a..5785881 100644
--- a/lib/puppet/application/inspect.rb
+++ b/lib/puppet/application/inspect.rb
@@ -22,20 +22,22 @@ class Puppet::Application::Inspect < Puppet::Application
   def help
     <<-HELP
 
-SYNOPSIS
+puppet-inspect(8) -- Send an inspection report
 ========
 
-Prepare and submit an inspection report to the puppet master.
+SYNOPSIS
+--------
+
+Prepares and submits an inspection report to the puppet master.
 
 
 USAGE
-=====
-
-  puppet inspect
+-----
+puppet inspect
 
 
 DESCRIPTION
-===========
+-----------
 
 This command uses the cached catalog from the previous run of 'puppet
 agent' to determine which attributes of which resources have been
@@ -44,11 +46,12 @@ the current state of the system, writes the state of the specified
 resource attributes to a report, and submits the report to the puppet
 master.
 
-Puppet inspect does not run as a daemon, and must be run manually or from cron.
+Puppet inspect does not run as a daemon, and must be run manually or
+from cron.
 
 
 OPTIONS
-=======
+-------
 
 Any configuration setting which is valid in the configuration file is
 also a valid long argument, e.g. '--server=master.domain.com'. See the
@@ -58,13 +61,13 @@ the full list of acceptable settings.
 
 
 AUTHOR
-======
+------
 
 Puppet Labs
 
 
 COPYRIGHT
-=========
+---------
 
 Copyright (c) 2011 Puppet Labs, LLC
 Licensed under the GNU General Public License version 2
diff --git a/lib/puppet/application/kick.rb b/lib/puppet/application/kick.rb
index 4cf0603..9612a72 100644
--- a/lib/puppet/application/kick.rb
+++ b/lib/puppet/application/kick.rb
@@ -40,20 +40,23 @@ class Puppet::Application::Kick < Puppet::Application
   def help
     <<-HELP
 
-SYNOPSIS
+puppet-kick(8) -- Remotely control puppet agent
 ========
+
+SYNOPSIS
+--------
 Trigger a puppet agent run on a set of hosts.
 
 
 USAGE
-=====
-  puppet kick [-a|--all] [-c|--class <class>] [-d|--debug] [-f|--foreground]
-      [-h|--help] [--host <host>] [--no-fqdn] [--ignoreschedules]
-      [-t|--tag <tag>] [--test] [-p|--ping] <host> [<host> [...]]
+-----
+puppet kick [-a|--all] [-c|--class <class>] [-d|--debug] [-f|--foreground]
+  [-h|--help] [--host <host>] [--no-fqdn] [--ignoreschedules]
+  [-t|--tag <tag>] [--test] [-p|--ping] <host> [<host> [...]]
 
 
 DESCRIPTION
-===========
+-----------
 This script can be used to connect to a set of machines running 'puppet
 agent' and trigger them to run their configurations. The most common
 usage would be to specify a class of hosts and a set of tags, and
@@ -72,11 +75,11 @@ copy things like LDAP settings.
 
 
 USAGE NOTES
-===========
+-----------
 'puppet kick' is useless unless 'puppet agent' is listening. See its
 documentation for more information, but the gist is that you must enable
 'listen' on the 'puppet agent' daemon, either using '--listen' on the
-command line or adding 'listen: true' in its config file. In addition,
+command line or adding 'listen = true' in its config file. In addition,
 you need to set the daemons up to specifically allow connections by
 creating the 'namespaceauth' file, normally at
 '/etc/puppet/namespaceauth.conf'. This file specifies who has access to
@@ -84,7 +87,7 @@ each namespace; if you create the file you must add every namespace you
 want any Puppet daemon to allow -- it is currently global to all Puppet
 daemons.
 
-An example file looks like this::
+An example file looks like this:
 
     [fileserver]
         allow *.madstop.com
@@ -100,68 +103,75 @@ could leave off the 'fileserver' and 'puppetmaster' namespaces.
 
 
 OPTIONS
-=======
+-------
 Note that any configuration parameter that's valid in the configuration
 file is also a valid long argument. For example, 'ssldir' is a valid
 configuration parameter, so you can specify '--ssldir <directory>' as an
 argument.
 
 See the configuration file documentation at
-http://reductivelabs.com/projects/puppet/reference/configref.html for
+http://docs.puppetlabs.com/references/latest/configuration.html for
 the full list of acceptable parameters. A commented list of all
 configuration options can also be generated by running puppet master
 with '--genconfig'.
 
-all:             Connect to all available hosts. Requires LDAP support
-                 at this point.
-
-class:           Specify a class of machines to which to connect. This
-                 only works if you have LDAP configured, at the moment.
+* --all:
+  Connect to all available hosts. Requires LDAP support at this point.
 
-debug:           Enable full debugging.
+* --class:
+  Specify a class of machines to which to connect. This only works if
+  you have LDAP configured, at the moment.
 
-foreground:      Run each configuration in the foreground; that is, when
-                 connecting to a host, do not return until the host has
-                 finished its run. The default is false.
+* --debug:
+  Enable full debugging.
 
-help:            Print this help message
+* --foreground:
+  Run each configuration in the foreground; that is, when connecting to
+  a host, do not return until the host has finished its run. The default
+  is false.
 
-host:            A specific host to which to connect. This flag can be
-                 specified more than once.
+* --help:
+  Print this help message
 
-ignoreschedules: Whether the client should ignore schedules when running
-                 its configuration. This can be used to force the client
-                 to perform work it would not normally perform so soon.
-                 The default is false.
+* --host:
+  A specific host to which to connect. This flag can be specified more
+  than once.
 
-parallel:        How parallel to make the connections. Parallelization
-                 is provided by forking for each client to which to
-                 connect. The default is 1, meaning serial execution.
+* --ignoreschedules:
+  Whether the client should ignore schedules when running its
+  configuration. This can be used to force the client to perform work it
+  would not normally perform so soon. The default is false.
 
-tag:             Specify a tag for selecting the objects to apply. Does
-                 not work with the --test option.
+* --parallel:
+  How parallel to make the connections. Parallelization is provided by
+  forking for each client to which to connect. The default is 1, meaning
+  serial execution.
 
-test:            Print the hosts you would connect to but do not
-                 actually connect. This option requires LDAP support at
-                 this point.
+* --tag:
+  Specify a tag for selecting the objects to apply. Does not work with
+  the --test option.
 
-ping::
+* --test:
+  Print the hosts you would connect to but do not actually connect. This
+  option requires LDAP support at this point.
 
-  Do a ICMP echo against the target host. Skip hosts that don't respond to ping.
+* --ping:
+  Do a ICMP echo against the target host. Skip hosts that don't respond
+  to ping.
 
 
 EXAMPLE
-=======
-  sudo puppet kick -p 10 -t remotefile -t webserver host1 host2
+-------
+    $ sudo puppet kick -p 10 -t remotefile -t webserver host1 host2
 
 
 AUTHOR
-======
+------
 Luke Kanies
 
 
 COPYRIGHT
-=========
+---------
 Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public
 License
 

-- 
Puppet packaging for Debian

