diff options
| author | nfagerlund <nick.fagerlund@gmail.com> | 2011-04-27 10:46:47 -0700 |
|---|---|---|
| committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-05-04 16:01:49 -0700 |
| commit | dce072a87c0a47b4edc76ca988029ee8b626eeb6 (patch) | |
| tree | fbe957fa36250a44821f8f5d19ffbc1481a5ae34 /lib/puppet/face/node.rb | |
| parent | 855a0ec0deba9fdbaa113260eef8cb8c28e6f5b6 (diff) | |
| download | puppet-dce072a87c0a47b4edc76ca988029ee8b626eeb6.tar.gz puppet-dce072a87c0a47b4edc76ca988029ee8b626eeb6.tar.xz puppet-dce072a87c0a47b4edc76ca988029ee8b626eeb6.zip | |
(#6962) Add self-documentation data to puppet faces
This patch adds documentation strings to most of the faces, actions, and options
introduced in 2.7.0. There are a small number of TK notes remaining, and longer strings
have not been indented to take advantage of the patch from issue #7221.
Diffstat (limited to 'lib/puppet/face/node.rb')
| -rw-r--r-- | lib/puppet/face/node.rb | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/lib/puppet/face/node.rb b/lib/puppet/face/node.rb index c4cf30b98..64002909e 100644 --- a/lib/puppet/face/node.rb +++ b/lib/puppet/face/node.rb @@ -3,9 +3,22 @@ Puppet::Indirector::Face.define(:node, '0.0.1') do copyright "Puppet Labs", 2011 license "Apache 2 license; see COPYING" - summary "View and manage nodes" + summary "View and manage node definitions" description <<-EOT -It defaults to using whatever your node terminus is set as. +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. + 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` +* `exec` +* `ldap` +* `memory` +* `plain` +* `rest` +* `yaml` EOT end |