summaryrefslogtreecommitdiffstats
path: root/lib/puppet/face/plugin.rb
diff options
context:
space:
mode:
authorNick Lewis <nick@puppetlabs.com>2011-06-08 18:47:44 -0700
committerNick Lewis <nick@puppetlabs.com>2011-06-08 18:47:44 -0700
commit649b3dc58349d3bbb1bd28bf882013c2cf5b8000 (patch)
tree1f047edff3c51258b3367a1d5c9f5cfbb02b4c71 /lib/puppet/face/plugin.rb
parente0573603c5780e79c2461ece604c6388e4222504 (diff)
parent8ccd00963d91f168438eaec4b29a18cd4a1ac583 (diff)
downloadpuppet-649b3dc58349d3bbb1bd28bf882013c2cf5b8000.tar.gz
puppet-649b3dc58349d3bbb1bd28bf882013c2cf5b8000.tar.xz
puppet-649b3dc58349d3bbb1bd28bf882013c2cf5b8000.zip
Merge branch '2.7.x'
Diffstat (limited to 'lib/puppet/face/plugin.rb')
-rw-r--r--lib/puppet/face/plugin.rb17
1 files changed, 9 insertions, 8 deletions
diff --git a/lib/puppet/face/plugin.rb b/lib/puppet/face/plugin.rb
index 541468d39..76c79f38d 100644
--- a/lib/puppet/face/plugin.rb
+++ b/lib/puppet/face/plugin.rb
@@ -5,13 +5,13 @@ 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
+ This subcommand provides network access to the puppet master's store of
plugins.
- EOT
- notes <<-'EOT'
- The puppet master can serve Ruby code collected from the lib directories
+
+ The puppet master serves 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.
+ Facter and implement custom types and providers. Plugins are normally
+ downloaded by puppet agent during the course of a run.
EOT
action :download do
@@ -19,12 +19,13 @@ Puppet::Face.define(:plugin, '0.0.1') do
description <<-'EOT'
Downloads plugins from the configured puppet master. Any plugins
downloaded in this way will be used in all subsequent Puppet activity.
+ This action modifies files on disk.
EOT
returns <<-'EOT'
- A display-formatted list of the files downloaded. If all plugin
- files were in sync, this list will be empty.
+ A list of the files downloaded, or a confirmation that no files were
+ downloaded. When used from the Ruby API, this action returns an array of
+ the files downloaded, which will be empty if none were retrieved.
EOT
- notes "This action modifies files on disk."
examples <<-'EOT'
Retrieve plugins from the puppet master: