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

nfagerlund nick.fagerlund at gmail.com
Tue May 10 08:19:41 UTC 2011


The following commit has been merged in the experimental branch:
commit 7b71745ac4507375fc452d87e5130e504cef53c8
Author: nfagerlund <nick.fagerlund at gmail.com>
Date:   Wed May 4 16:11:39 2011 -0700

    (Maint) Adjust documentation whitespace
    
    The patch from issue #7221 permits indented heredocs. This patch takes advantage
    of that to make the doc strings less messy.

diff --git a/lib/puppet/face/catalog.rb b/lib/puppet/face/catalog.rb
index 660574e..4624313 100644
--- a/lib/puppet/face/catalog.rb
+++ b/lib/puppet/face/catalog.rb
@@ -6,45 +6,45 @@ Puppet::Indirector::Face.define(:catalog, '0.0.1') do
 
   summary "Compile, save, view, and convert catalogs."
   description <<-EOT
-This face primarily interacts with the compiling subsystem. By default,
-it compiles a catalog using the default manifest and the hostname from
-`certname`, but you can choose to retrieve a catalog from the server by
-specifying `--terminus rest`.  You can also choose to print any catalog
-in 'dot' format (for easy graph viewing with OmniGraffle or Graphviz)
-with '--render-as dot'.
+    This face primarily interacts with the compiling subsystem. By default,
+    it compiles a catalog using the default manifest and the hostname from
+    `certname`, but you can choose to retrieve a catalog from the server by
+    specifying `--terminus rest`.  You can also choose to print any catalog
+    in 'dot' format (for easy graph viewing with OmniGraffle or Graphviz)
+    with '--render-as dot'.
   EOT
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
-
-* `active_record`
-* `compiler`
-* `queue`
-* `rest`
-* `yaml`
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
+
+    * `active_record`
+    * `compiler`
+    * `queue`
+    * `rest`
+    * `yaml`
   EOT
 
   action(:apply) do
     summary "Apply a Puppet::Resource::Catalog object"
     description <<-EOT
-Applies a catalog object retrieved with the `download` action. This
-action cannot consume a serialized catalog, and is not intended for
-command-line use."
+      Applies a catalog object retrieved with the `download` action. This
+      action cannot consume a serialized catalog, and is not intended for
+      command-line use."
     EOT
     notes <<-EOT
-This action returns a Puppet::Transaction::Report object.
+      This action returns a Puppet::Transaction::Report object.
     EOT
     examples <<-EOT
-From `secret_agent.rb`:
+      From `secret_agent.rb`:
 
-    Puppet::Face[:plugin, '0.0.1'].download
+          Puppet::Face[:plugin, '0.0.1'].download
 
-    facts   = Puppet::Face[:facts, '0.0.1'].find(certname)
-    catalog = Puppet::Face[:catalog, '0.0.1'].download(certname, facts)
-    report  = Puppet::Face[:catalog, '0.0.1'].apply(catalog)
+          facts   = Puppet::Face[:facts, '0.0.1'].find(certname)
+          catalog = Puppet::Face[:catalog, '0.0.1'].download(certname, facts)
+          report  = Puppet::Face[:catalog, '0.0.1'].apply(catalog)
 
-    Puppet::Face[:report, '0.0.1'].submit(report)
+          Puppet::Face[:report, '0.0.1'].submit(report)
     EOT
 
     when_invoked do |options|
@@ -73,21 +73,21 @@ From `secret_agent.rb`:
   action(:download) do
     summary "Download this node's catalog from the puppet master server"
     description <<-EOT
-Retrieves a catalog from the puppet master. Unlike the `find` action,
-`download` submits facts to the master as part of the request. This
-action is not intended for command-line use.
+      Retrieves a catalog from the puppet master. Unlike the `find` action,
+      `download` submits facts to the master as part of the request. This
+      action is not intended for command-line use.
     EOT
     notes "This action returns a Puppet::Resource::Catalog object."
     examples <<-EOT
-From `secret_agent.rb`:
+      From `secret_agent.rb`:
 
-    Puppet::Face[:plugin, '0.0.1'].download
+          Puppet::Face[:plugin, '0.0.1'].download
 
-    facts   = Puppet::Face[:facts, '0.0.1'].find(certname)
-    catalog = Puppet::Face[:catalog, '0.0.1'].download(certname, facts)
-    report  = Puppet::Face[:catalog, '0.0.1'].apply(catalog)
+          facts   = Puppet::Face[:facts, '0.0.1'].find(certname)
+          catalog = Puppet::Face[:catalog, '0.0.1'].download(certname, facts)
+          report  = Puppet::Face[:catalog, '0.0.1'].apply(catalog)
 
-    Puppet::Face[:report, '0.0.1'].submit(report)
+          Puppet::Face[:report, '0.0.1'].submit(report)
     EOT
     when_invoked do |options|
       Puppet::Resource::Catalog.indirection.terminus_class = :rest
diff --git a/lib/puppet/face/catalog/select.rb b/lib/puppet/face/catalog/select.rb
index c5d37eb..a6c97a6 100644
--- a/lib/puppet/face/catalog/select.rb
+++ b/lib/puppet/face/catalog/select.rb
@@ -3,19 +3,19 @@ Puppet::Face.define(:catalog, '0.0.1') do
   action :select do
     summary "Select and show a list of resources of a given type"
     description <<-EOT
-Retrieves a catalog for the specified host and returns an array of
-resources of the given type. This action is not intended for
-command-line use.
+      Retrieves a catalog for the specified host and returns an array of
+      resources of the given type. This action is not intended for
+      command-line use.
     EOT
     notes <<-NOTES
-The type name for this action must be given in its capitalized form.
-That is, calling `catalog select mynode file` will return an empty
-array, whereas calling it with 'File' will return a list of the node's
-file resources.
+      The type name for this action must be given in its capitalized form.
+      That is, calling `catalog select mynode file` will return an empty
+      array, whereas calling it with 'File' will return a list of the node's
+      file resources.
 
-By default, this action will retrieve a catalog from Puppet's compiler
-subsystem; you must call the action with `--terminus rest` if you wish
-to retrieve a catalog from the puppet master.
+      By default, this action will retrieve a catalog from Puppet's compiler
+      subsystem; you must call the action with `--terminus rest` if you wish
+      to retrieve a catalog from the puppet master.
     NOTES
     when_invoked do |host, type, options|
       # REVISIT: Eventually, type should have a default value that triggers
diff --git a/lib/puppet/face/certificate.rb b/lib/puppet/face/certificate.rb
index d1bdbec..ee2b287 100644
--- a/lib/puppet/face/certificate.rb
+++ b/lib/puppet/face/certificate.rb
@@ -7,27 +7,27 @@ Puppet::Indirector::Face.define(:certificate, '0.0.1') do
 
   summary "Provide access to the CA for certificate management"
   description <<-EOT
-This face interacts with a local or remote Puppet certificate
-authority. Currently, its behavior is not a full superset of puppet
-cert; specifically, it is unable to mimic puppet cert's "clean" option,
-and its "generate" action submits a CSR rather than creating a
-signed certificate.
+    This face interacts with a local or remote Puppet certificate
+    authority. Currently, its behavior is not a full superset of puppet
+    cert; specifically, it is unable to mimic puppet cert's "clean" option,
+    and its "generate" action submits a CSR rather than creating a
+    signed certificate.
   EOT
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `ca`
-* `file`
-* `rest`
+    * `ca`
+    * `file`
+    * `rest`
   EOT
 
   option "--ca-location LOCATION" do
     summary "The certificate authority to query"
     description <<-EOT
-Whether to act on the local certificate authority or one provided by a
-remote puppet master. Allowed values are 'local' and 'remote.'
+      Whether to act on the local certificate authority or one provided by a
+      remote puppet master. Allowed values are 'local' and 'remote.'
     EOT
 
     before_action do |action, args, options|
@@ -38,13 +38,13 @@ remote puppet master. Allowed values are 'local' and 'remote.'
   action :generate do
     summary "Generate a new certificate signing request for HOST"
     description <<-EOT
-Generates and submits a certificate signing request (CSR) for the
-provided host identifier. This CSR will then have to be signed by a user
-with the proper authorization on the certificate authority.
+      Generates and submits a certificate signing request (CSR) for the
+      provided host identifier. This CSR will then have to be signed by a user
+      with the proper authorization on the certificate authority.
 
-Puppet agent handles CSR submission automatically. This action is
-primarily useful for requesting certificates for individual users and
-external applications.
+      Puppet agent handles CSR submission automatically. This action is
+      primarily useful for requesting certificates for individual users and
+      external applications.
     EOT
 
     when_invoked do |name, options|
diff --git a/lib/puppet/face/certificate_request.rb b/lib/puppet/face/certificate_request.rb
index 907bed1..cc60215 100644
--- a/lib/puppet/face/certificate_request.rb
+++ b/lib/puppet/face/certificate_request.rb
@@ -6,27 +6,27 @@ Puppet::Indirector::Face.define(:certificate_request, '0.0.1') do
 
   summary "Manage certificate requests."
   description <<-EOT
-Retrieves and submits certificate signing requests (CSRs). Invoke
-`search` with an unread key to retrieve all outstanding CSRs, invoke
-`find` with a node certificate name to retrieve a specific request, and
-invoke `save` to submit a CSR.
+    Retrieves and submits certificate signing requests (CSRs). Invoke
+    `search` with an unread key to retrieve all outstanding CSRs, invoke
+    `find` with a node certificate name to retrieve a specific request, and
+    invoke `save` to submit a CSR.
   EOT
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `ca`
-* `file`
-* `rest`
+    * `ca`
+    * `file`
+    * `rest`
   EOT
   examples <<-EOT
-Retrieve all CSRs from the local CA:
+    Retrieve all CSRs from the local CA:
 
-    puppet certificate_request search no_key --terminus ca
+        puppet certificate_request search no_key --terminus ca
 
-Retrieve a single CSR from the puppet master's CA:
+    Retrieve a single CSR from the puppet master's CA:
 
-    puppet certificate_request find mynode.puppetlabs.lan --terminus rest
+        puppet certificate_request find mynode.puppetlabs.lan --terminus rest
   EOT
 end
diff --git a/lib/puppet/face/certificate_revocation_list.rb b/lib/puppet/face/certificate_revocation_list.rb
index 4d5e26f..2722b20 100644
--- a/lib/puppet/face/certificate_revocation_list.rb
+++ b/lib/puppet/face/certificate_revocation_list.rb
@@ -6,24 +6,25 @@ Puppet::Indirector::Face.define(:certificate_revocation_list, '0.0.1') do
 
   summary "Manage the list of revoked certificates."
   description <<-EOT
-TK This is just for retrieving the CRL, right? Do the
-search/save/destroy methods do anything?
+    This face is primarily for retrieving the certificate revocation
+    list from the CA. Although it exposes search/save/destroy methods,
+    they shouldn't be used under normal circumstances.
   EOT
   notes <<-EOT
-Although the find action must be given an argument, this argument is
-never read, and can contain the descriptive text of your choice.
+    Although the find action must be given an argument, this argument is
+    never read, and can contain the descriptive text of your choice.
 
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `ca`
-* `file`
-* `rest`
+    * `ca`
+    * `file`
+    * `rest`
   EOT
   examples <<-EXAMPLES
-Retrieve the CRL:
+    Retrieve the CRL:
 
-    puppet certificate_revocation_list find crl
+        puppet certificate_revocation_list find crl
   EXAMPLES
 end
diff --git a/lib/puppet/face/config.rb b/lib/puppet/face/config.rb
index 6b4131f..9ca4108 100644
--- a/lib/puppet/face/config.rb
+++ b/lib/puppet/face/config.rb
@@ -9,33 +9,33 @@ Puppet::Face.define(:config, '0.0.1') do
   action(:print) do
     summary "Examine Puppet's current configuration options"
     description <<-EOT
-Prints the value of a single configuration option or a list of
-configuration options.
+      Prints the value of a single configuration option or a list of
+      configuration options.
 
-This action is an alternate interface to the information available with
-`puppet agent --configprint`.
+      This action is an alternate interface to the information available with
+      `puppet agent --configprint`.
     EOT
     notes <<-EOT
-The return data of this action varies depending on its arguments. When
-called with "all," `print` will return a complete list of option names
-and values. When called with a single configuration option name, it will
-return the value of that option. When called with a list of
-configuration option names, it will return the corresponding list of
-option names and values.
-
-By default, this action retrieves its configuration information in agent
-mode. To examine the master's configuration, supply Puppet's global
-`--mode master` option. To examine configurations from a specific
-environment, you can use the `--environment` option.
+      The return data of this action varies depending on its arguments. When
+      called with "all," `print` will return a complete list of option names
+      and values. When called with a single configuration option name, it will
+      return the value of that option. When called with a list of
+      configuration option names, it will return the corresponding list of
+      option names and values.
+
+      By default, this action retrieves its configuration information in agent
+      mode. To examine the master's configuration, supply Puppet's global
+      `--mode master` option. To examine configurations from a specific
+      environment, you can use the `--environment` option.
     EOT
     examples <<-EOT
-Get puppet's runfile directory:
+      Get puppet's runfile directory:
 
-    puppet config print rundir
+          puppet config print rundir
 
-Get a list of important directories from the master's config:
+      Get a list of important directories from the master's config:
 
-    puppet config print all --mode master | grep -E "(path|dir)"
+          puppet config print all --mode master | grep -E "(path|dir)"
     EOT
 
     when_invoked do |*args|
diff --git a/lib/puppet/face/facts.rb b/lib/puppet/face/facts.rb
index 12dbded..ecf4e37 100644
--- a/lib/puppet/face/facts.rb
+++ b/lib/puppet/face/facts.rb
@@ -7,32 +7,32 @@ Puppet::Indirector::Face.define(:facts, '0.0.1') do
 
   summary "Retrieve, store, and view facts."
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `active_record`
-* `couch`
-* `facter`
-* `inventory_active_record`
-* `memory`
-* `network_device`
-* `rest`
-* `yaml`
+    * `active_record`
+    * `couch`
+    * `facter`
+    * `inventory_active_record`
+    * `memory`
+    * `network_device`
+    * `rest`
+    * `yaml`
   EOT
 
   action(:upload) do
     summary "Upload our facts to the puppet master."
     description <<-EOT
-Retrieves facts for the local system and saves them to the puppet master
-server. This is essentially a shortcut action: it calls the `find`
-action with the facter terminus, then passes the returned facts object
-to the `save` action, which uses the rest terminus.
+      Retrieves facts for the local system and saves them to the puppet master
+      server. This is essentially a shortcut action: it calls the `find`
+      action with the facter terminus, then passes the returned facts object
+      to the `save` action, which uses the rest terminus.
     EOT
     notes <<-EOT
-This action uses the save action, which requires the puppet master's
-auth.conf to allow save access to the `facts` REST terminus. See
-`http://docs.puppetlabs.com/guides/rest_auth_conf.html` for more details.
+      This action uses the save action, which requires the puppet master's
+      auth.conf to allow save access to the `facts` REST terminus. See
+      `http://docs.puppetlabs.com/guides/rest_auth_conf.html` for more details.
     EOT
 
     render_as :yaml
diff --git a/lib/puppet/face/file.rb b/lib/puppet/face/file.rb
index 9c66f66..707ceaf 100644
--- a/lib/puppet/face/file.rb
+++ b/lib/puppet/face/file.rb
@@ -9,12 +9,12 @@ Puppet::Indirector::Face.define(:file, '0.0.1') do
   # some good use cases for retrieving/storing them. I can't write either
   # of these yet.
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `file`
-* `rest`
+    * `file`
+    * `rest`
   EOT
 
   set_indirection_name :file_bucket_file
diff --git a/lib/puppet/face/key.rb b/lib/puppet/face/key.rb
index 79c08b7..67d775c 100644
--- a/lib/puppet/face/key.rb
+++ b/lib/puppet/face/key.rb
@@ -7,17 +7,17 @@ Puppet::Indirector::Face.define(:key, '0.0.1') do
   summary "Create, save, and remove certificate keys"
 
   description <<-EOT
-Keys are created for you automatically when certificate requests are
-generated with 'puppet certificate generate'. You should not have to use
-this action directly from the command line.
+    Keys are created for you automatically when certificate requests are
+    generated with 'puppet certificate generate'. You should not have to use
+    this action directly from the command line.
   EOT
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `ca`
-* `file`
+    * `ca`
+    * `file`
   EOT
 
 end
diff --git a/lib/puppet/face/node.rb b/lib/puppet/face/node.rb
index 6400290..be38ad3 100644
--- a/lib/puppet/face/node.rb
+++ b/lib/puppet/face/node.rb
@@ -6,19 +6,21 @@ Puppet::Indirector::Face.define(:node, '0.0.1') do
   summary "View and manage node definitions"
 
   description <<-EOT
-This face interacts with node objects, which are what Puppet uses to build a catalog. A node object consists of the node's facts, environment, additional top-scope variables, and classes. TK need this fact-checked.
+    This face interacts with node objects, which are what Puppet uses to
+    build a catalog. A node object consists of the node's facts,
+    environment, additional top-scope variables, and classes.
   EOT
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `active_record`
-* `exec`
-* `ldap`
-* `memory`
-* `plain`
-* `rest`
-* `yaml`
+    * `active_record`
+    * `exec`
+    * `ldap`
+    * `memory`
+    * `plain`
+    * `rest`
+    * `yaml`
   EOT
 end
diff --git a/lib/puppet/face/parser.rb b/lib/puppet/face/parser.rb
index 26035d0..e6a9503 100644
--- a/lib/puppet/face/parser.rb
+++ b/lib/puppet/face/parser.rb
@@ -10,9 +10,9 @@ Puppet::Face.define(:parser, '0.0.1') do
   action :validate do
     summary "Validate the syntax of one or more Puppet manifests"
     description <<-EOT
-This action validates Puppet DSL syntax without compiling a catalog or
-syncing any resources. If no manifest files are provided, it will
-validate the default site manifest.
+      This action validates Puppet DSL syntax without compiling a catalog or
+      syncing any resources. If no manifest files are provided, it will
+      validate the default site manifest.
     EOT
     when_invoked do |*args|
       args.pop
diff --git a/lib/puppet/face/plugin.rb b/lib/puppet/face/plugin.rb
index f55bd3b..969d423 100644
--- a/lib/puppet/face/plugin.rb
+++ b/lib/puppet/face/plugin.rb
@@ -5,27 +5,27 @@ Puppet::Face.define(:plugin, '0.0.1') do
 
   summary "Interact with the Puppet plugin system"
   description <<-EOT
-This face provides network access to the puppet master's store of
-plugins. It is intended for use in other faces, rather than for direct
-command line access.
+    This face provides network access to the puppet master's store of
+    plugins. It is intended for use in other faces, rather than for direct
+    command line access.
   EOT
   notes <<-EOT
-The puppet master can serve Ruby code collected from the lib directories
-of its modules. These plugins can be used on agent nodes to extend
-Facter and implement custom types and providers.
+    The puppet master can serve Ruby code collected from the lib directories
+    of its modules. These plugins can be used on agent nodes to extend
+    Facter and implement custom types and providers.
   EOT
 
   action :download do
     summary "Download plugins from the configured master"
     returns <<-EOT
-            An array containing the files actually downloaded.
-            This will be empty array when everything was in sync.
-            EOT
+      An array containing the files actually downloaded. If all files
+      were in sync, this array will be empty.
+    EOT
     notes "This action modifies files on disk without returning any data."
     examples <<-EOT
-Retrieve plugins from the puppet master:
+      Retrieve plugins from the puppet master:
 
-    Puppet::Face[:plugin, '0.0.1'].download
+          Puppet::Face[:plugin, '0.0.1'].download
     EOT
 
     when_invoked do |options|
diff --git a/lib/puppet/face/report.rb b/lib/puppet/face/report.rb
index 7143d45..c8549b1 100644
--- a/lib/puppet/face/report.rb
+++ b/lib/puppet/face/report.rb
@@ -6,33 +6,32 @@ Puppet::Indirector::Face.define(:report, '0.0.1') do
 
   summary "Create, display, and submit reports"
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
-
-* `processor`
-* `rest`
-* `yaml`
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
+    * `processor`
+    * `rest`
+    * `yaml`
   EOT
 
   action(:submit) do
     summary "Submit a report object to the puppet master"
     description <<-EOT
-This action is essentially a shortcut and wrapper for the `save` action
-with a terminus of `rest`. It also can provide additional details in the
-event of a report submission failure. It is not intended for use from
-a command line.
+      This action is essentially a shortcut and wrapper for the `save` action
+      with a terminus of `rest`. It also can provide additional details in the
+      event of a report submission failure. It is not intended for use from
+      a command line.
     EOT
     examples <<-EOT
-From secret_agent.rb:
-    Puppet::Face[:plugin, '0.0.1'].download
+      From secret_agent.rb:
+          Puppet::Face[:plugin, '0.0.1'].download
 
-    facts   = Puppet::Face[:facts, '0.0.1'].find(certname)
-    catalog = Puppet::Face[:catalog, '0.0.1'].download(certname, facts)
-    report  = Puppet::Face[:catalog, '0.0.1'].apply(catalog)
+          facts   = Puppet::Face[:facts, '0.0.1'].find(certname)
+          catalog = Puppet::Face[:catalog, '0.0.1'].download(certname, facts)
+          report  = Puppet::Face[:catalog, '0.0.1'].apply(catalog)
 
-    Puppet::Face[:report, '0.0.1'].submit(report)
+          Puppet::Face[:report, '0.0.1'].submit(report)
     EOT
     when_invoked do |report, options|
       begin
diff --git a/lib/puppet/face/resource.rb b/lib/puppet/face/resource.rb
index 72e9a2a..ed63608 100644
--- a/lib/puppet/face/resource.rb
+++ b/lib/puppet/face/resource.rb
@@ -6,17 +6,17 @@ Puppet::Indirector::Face.define(:resource, '0.0.1') do
 
   summary "Interact directly with resources via the RAL, like ralsh"
   description <<-EOT
-This face provides a Ruby API with functionality similar to the puppet
-resource (née ralsh) command line application. It is not intended to be
-used from the command line.
+    This face provides a Ruby API with functionality similar to the puppet
+    resource (née ralsh) command line application. It is not intended to be
+    used from the command line.
   EOT
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `ral`
-* `rest`
+    * `ral`
+    * `rest`
   EOT
 
   examples "TK we really need some examples for this one."
diff --git a/lib/puppet/face/resource_type.rb b/lib/puppet/face/resource_type.rb
index c400437..77ccefa 100644
--- a/lib/puppet/face/resource_type.rb
+++ b/lib/puppet/face/resource_type.rb
@@ -7,11 +7,11 @@ Puppet::Indirector::Face.define(:resource_type, '0.0.1') do
   summary "View resource types, classes, and nodes from all manifests"
   description "TK I have no idea what this does."
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `parser`
-* `rest`
+    * `parser`
+    * `rest`
   EOT
 end
diff --git a/lib/puppet/face/secret_agent.rb b/lib/puppet/face/secret_agent.rb
index 2ddc5c9..c8c8e66 100644
--- a/lib/puppet/face/secret_agent.rb
+++ b/lib/puppet/face/secret_agent.rb
@@ -6,20 +6,20 @@ Puppet::Face.define(:secret_agent, '0.0.1') do
 
   summary "Provides agent-like behavior, with no plugin downloading or reporting"
   description <<-EOT
-This face currently functions as a proof of concept, demonstrating how
-Faces allows the separation of application logic from Puppet's internal
-systems; compare the code for puppet agent. It will eventually replace
-puppet agent entirely, and can provide a template for users who wish to
-implement agent-like functionality with drastically different
-application logic.
+    This face currently functions as a proof of concept, demonstrating how
+    Faces allows the separation of application logic from Puppet's internal
+    systems; compare the code for puppet agent. It will eventually replace
+    puppet agent entirely, and can provide a template for users who wish to
+    implement agent-like functionality with drastically different
+    application logic.
   EOT
 
   action(:synchronize) do
     summary "Retrieve and apply a catalog from the puppet master"
     description <<-EOT
-This action mimics the behavior of the puppet agent application. It does
-not currently daemonize, but can download plugins, submit facts,
-retrieve and apply a catalog, and submit a report to the puppet master.
+      This action mimics the behavior of the puppet agent application. It does
+      not currently daemonize, but can download plugins, submit facts,
+      retrieve and apply a catalog, and submit a report to the puppet master.
     EOT
 
     when_invoked do |options|
diff --git a/lib/puppet/face/status.rb b/lib/puppet/face/status.rb
index 0b53bef..6a29deb 100644
--- a/lib/puppet/face/status.rb
+++ b/lib/puppet/face/status.rb
@@ -6,25 +6,25 @@ Puppet::Indirector::Face.define(:status, '0.0.1') do
 
   summary "View puppet server status"
   description <<-EOT
-This subcommand is only useful for determining whether a puppet master
-server (or an agent node, if puppet was started with the `--listen`
-option) is responding to requests.
+    This subcommand is only useful for determining whether a puppet master
+    server (or an agent node, if puppet was started with the `--listen`
+    option) is responding to requests.
 
-Only the `find` action is valid. If the server is responding to
-requests, `find` will retrieve a status object; if not, the connection
-will be refused. When invoked with the `local` terminus, `find` will
-always return true.
+    Only the `find` action is valid. If the server is responding to
+    requests, `find` will retrieve a status object; if not, the connection
+    will be refused. When invoked with the `local` terminus, `find` will
+    always return true.
 
-If you wish to query a server other than the master configured in
-puppet.conf, you must set the `--server` and `--masterport` options on
-the command line.
+    If you wish to query a server other than the master configured in
+    puppet.conf, you must set the `--server` and `--masterport` options on
+    the command line.
   EOT
   notes <<-EOT
-This is an indirector face, which exposes find, search, save, and
-destroy actions for an indirected subsystem of Puppet. Valid terminuses
-for this face include:
+    This is an indirector face, which exposes find, search, save, and
+    destroy actions for an indirected subsystem of Puppet. Valid terminuses
+    for this face include:
 
-* `local`
-* `rest`
+    * `local`
+    * `rest`
   EOT
 end
diff --git a/lib/puppet/indirector/face.rb b/lib/puppet/indirector/face.rb
index 3140ce2..1371c64 100644
--- a/lib/puppet/indirector/face.rb
+++ b/lib/puppet/indirector/face.rb
@@ -61,8 +61,8 @@ face's manpage for more details.
   action :save do
     summary "Create or modify an object"
     notes <<-EOT
-Save actions cannot currently be invoked from the command line, and are
-for API use only.
+      Save actions cannot currently be invoked from the command line, and are
+      for API use only.
     EOT
     when_invoked { |key, options| call_indirection_method(:save, key, options) }
   end
@@ -76,9 +76,9 @@ for API use only.
   action :info do
     summary "Print the default terminus class for this face"
     description <<-EOT
-TK So this is per-face, right? No way to tell what the default terminus
-is per-action, for subsystems that switch to REST for save but query
-locally for find?
+      TK So this is per-face, right? No way to tell what the default terminus
+      is per-action, for subsystems that switch to REST for save but query
+      locally for find?
     EOT
 
     when_invoked do |*args|

-- 
Puppet packaging for Debian



More information about the Pkg-puppet-devel mailing list