summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authornfagerlund <nick.fagerlund@gmail.com>2011-05-24 10:22:00 -0700
committerMatt Robinson <matt@puppetlabs.com>2011-05-26 16:04:42 -0700
commit76887064b7691eb6f6751739df5bc83beee76a80 (patch)
tree789e702e099685168f68a327b9d56c79d48790d7
parent4662f4d0aa57a8792b824338e82e89ca4ddb0960 (diff)
downloadpuppet-76887064b7691eb6f6751739df5bc83beee76a80.tar.gz
puppet-76887064b7691eb6f6751739df5bc83beee76a80.tar.xz
puppet-76887064b7691eb6f6751739df5bc83beee76a80.zip
(#7563) DRY: Remove indirector boilerplate from individual faces
Termini lists are now being generated in the help templates. This commit removes the hardcoded lists from each of the affected faces.
-rw-r--r--lib/puppet/face/catalog.rb11
-rw-r--r--lib/puppet/face/certificate.rb9
-rw-r--r--lib/puppet/face/certificate_request.rb9
-rw-r--r--lib/puppet/face/certificate_revocation_list.rb9
-rw-r--r--lib/puppet/face/facts.rb14
-rw-r--r--lib/puppet/face/file.rb7
-rw-r--r--lib/puppet/face/key.rb8
-rw-r--r--lib/puppet/face/node.rb13
-rw-r--r--lib/puppet/face/report.rb9
-rw-r--r--lib/puppet/face/resource.rb8
-rw-r--r--lib/puppet/face/resource_type.rb8
-rw-r--r--lib/puppet/face/status.rb8
12 files changed, 0 insertions, 113 deletions
diff --git a/lib/puppet/face/catalog.rb b/lib/puppet/face/catalog.rb
index c7501ff37..13351540a 100644
--- a/lib/puppet/face/catalog.rb
+++ b/lib/puppet/face/catalog.rb
@@ -13,17 +13,6 @@ Puppet::Indirector::Face.define(:catalog, '0.0.1') do
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 termini
- for this face include:
-
- * `active_record`
- * `compiler`
- * `queue`
- * `rest`
- * `yaml`
- EOT
get_action(:destroy).summary "Invalid for this face."
get_action(:search).summary "Query format unknown; potentially invalid for this face."
diff --git a/lib/puppet/face/certificate.rb b/lib/puppet/face/certificate.rb
index d77525ba8..cab8817e3 100644
--- a/lib/puppet/face/certificate.rb
+++ b/lib/puppet/face/certificate.rb
@@ -13,15 +13,6 @@ Puppet::Indirector::Face.define(:certificate, '0.0.1') do
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 termini
- for this face include:
-
- * `ca`
- * `file`
- * `rest`
- EOT
option "--ca-location LOCATION" do
summary "The certificate authority to query"
diff --git a/lib/puppet/face/certificate_request.rb b/lib/puppet/face/certificate_request.rb
index de52b7fb7..29cf7dc78 100644
--- a/lib/puppet/face/certificate_request.rb
+++ b/lib/puppet/face/certificate_request.rb
@@ -11,15 +11,6 @@ Puppet::Indirector::Face.define(:certificate_request, '0.0.1') do
`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 termini
- for this face include:
-
- * `ca`
- * `file`
- * `rest`
- EOT
# Per-action doc overrides
get_action(:destroy).summary "Invalid for this face."
diff --git a/lib/puppet/face/certificate_revocation_list.rb b/lib/puppet/face/certificate_revocation_list.rb
index db00ea3ca..0525a601f 100644
--- a/lib/puppet/face/certificate_revocation_list.rb
+++ b/lib/puppet/face/certificate_revocation_list.rb
@@ -10,15 +10,6 @@ Puppet::Indirector::Face.define(:certificate_revocation_list, '0.0.1') do
list from the CA. Although it exposes search/save/destroy methods,
they shouldn't be used under normal circumstances.
EOT
- notes <<-'EOT'
- This is an indirector face, which exposes `find`, `search`, `save`, and
- `destroy` actions for an indirected subsystem of Puppet. Valid termini
- for this face include:
-
- * `ca`
- * `file`
- * `rest`
- EOT
get_action(:find).summary "Retrieve the certificate revocation list."
get_action(:find).arguments "<dummy_key>"
diff --git a/lib/puppet/face/facts.rb b/lib/puppet/face/facts.rb
index d7ddf1d51..05028a435 100644
--- a/lib/puppet/face/facts.rb
+++ b/lib/puppet/face/facts.rb
@@ -16,20 +16,6 @@ Puppet::Indirector::Face.define(:facts, '0.0.1') do
front-end to the inventory service REST API. See the inventory
service documentation for more detail.
EOT
- notes <<-'EOT'
- This is an indirector face, which exposes `find`, `search`, `save`, and
- `destroy` actions for an indirected subsystem of Puppet. Valid termini
- for this face include:
-
- * `active_record`
- * `couch`
- * `facter`
- * `inventory_active_record`
- * `memory`
- * `network_device`
- * `rest`
- * `yaml`
- EOT
find = get_action(:find)
find.summary "Retrieve a host's facts."
diff --git a/lib/puppet/face/file.rb b/lib/puppet/face/file.rb
index 70b44c38f..1cf9bc7f3 100644
--- a/lib/puppet/face/file.rb
+++ b/lib/puppet/face/file.rb
@@ -11,13 +11,6 @@ Puppet::Indirector::Face.define(:file, '0.0.1') do
examples for the relevant syntax.
EOT
notes <<-'EOT'
- This is an indirector face, which exposes `find`, `search`, `save`, and
- `destroy` actions for an indirected subsystem of Puppet. Valid termini
- for this face include:
-
- * `file`
- * `rest`
-
To retrieve the unmunged contents of a file, you must call find with
--render-as s. Rendering as yaml will return a hash of metadata
about the file, including its contents.
diff --git a/lib/puppet/face/key.rb b/lib/puppet/face/key.rb
index f19ae198f..54c4975c5 100644
--- a/lib/puppet/face/key.rb
+++ b/lib/puppet/face/key.rb
@@ -11,13 +11,5 @@ Puppet::Indirector::Face.define(:key, '0.0.1') do
certificate generate', and it should not be necessary to use this action
directly.
EOT
- notes <<-'EOT'
- This is an indirector face, which exposes `find`, `search`, `save`, and
- `destroy` actions for an indirected subsystem of Puppet. Valid termini
- for this face include:
-
- * `ca`
- * `file`
- EOT
end
diff --git a/lib/puppet/face/node.rb b/lib/puppet/face/node.rb
index c68d71846..d244127a4 100644
--- a/lib/puppet/face/node.rb
+++ b/lib/puppet/face/node.rb
@@ -10,19 +10,6 @@ Puppet::Indirector::Face.define(:node, '0.0.1') do
environment, node parameters (exposed in the parser as 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 termini
- for this face include:
-
- * `active_record`
- * `exec`
- * `ldap`
- * `memory`
- * `plain`
- * `rest`
- * `yaml`
- EOT
get_action(:destroy).summary "Invalid for this face."
get_action(:search).summary "Invalid for this face."
diff --git a/lib/puppet/face/report.rb b/lib/puppet/face/report.rb
index a5718bc0c..1345d6359 100644
--- a/lib/puppet/face/report.rb
+++ b/lib/puppet/face/report.rb
@@ -5,15 +5,6 @@ Puppet::Indirector::Face.define(:report, '0.0.1') do
license "Apache 2 license; see COPYING"
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 termini
- for this face include:
-
- * `processor`
- * `rest`
- * `yaml`
- EOT
get_action(:find).summary "Invalid for this face."
get_action(:search).summary "Invalid for this face."
diff --git a/lib/puppet/face/resource.rb b/lib/puppet/face/resource.rb
index 593776e53..59f628675 100644
--- a/lib/puppet/face/resource.rb
+++ b/lib/puppet/face/resource.rb
@@ -10,14 +10,6 @@ Puppet::Indirector::Face.define(:resource, '0.0.1') do
resource (originally 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 termini
- for this face include:
-
- * `ral`
- * `rest`
- EOT
get_action(:destroy).summary "Invalid for this face."
diff --git a/lib/puppet/face/resource_type.rb b/lib/puppet/face/resource_type.rb
index 3973eb3b8..9d7639fc5 100644
--- a/lib/puppet/face/resource_type.rb
+++ b/lib/puppet/face/resource_type.rb
@@ -12,14 +12,6 @@ Puppet::Indirector::Face.define(:resource_type, '0.0.1') do
It will eventually be extended to examine native resource types.
EOT
- notes <<-'EOT'
- This is an indirector face, which exposes `find`, `search`, `save`, and
- `destroy` actions for an indirected subsystem of Puppet. Valid termini
- for this face include:
-
- * `parser`
- * `rest`
- EOT
# Action documentation overrides:
get_action(:save).summary = "Invalid for this face."
diff --git a/lib/puppet/face/status.rb b/lib/puppet/face/status.rb
index 08379550c..4ae24e81b 100644
--- a/lib/puppet/face/status.rb
+++ b/lib/puppet/face/status.rb
@@ -5,14 +5,6 @@ Puppet::Indirector::Face.define(:status, '0.0.1') do
license "Apache 2 license; see COPYING"
summary "View puppet server status."
- notes <<-'EOT'
- This is an indirector face, which exposes `find`, `search`, `save`, and
- `destroy` actions for an indirected subsystem of Puppet. Valid termini
- for this face include:
-
- * `local`
- * `rest`
- EOT
get_action(:destroy).summary "Invalid for this face."
get_action(:save).summary "Invalid for this face."