diff options
| -rwxr-xr-x | bin/puppetdoc | 10 | ||||
| -rw-r--r-- | lib/puppet/type/pfile.rb | 7 | ||||
| -rwxr-xr-x | lib/puppet/type/pfilebucket.rb | 17 |
3 files changed, 26 insertions, 8 deletions
diff --git a/bin/puppetdoc b/bin/puppetdoc index fc5d13c1a..bc7146a2d 100755 --- a/bin/puppetdoc +++ b/bin/puppetdoc @@ -94,7 +94,14 @@ Meta-Parameters --------------- } +params = [] Puppet::Type.eachmetaparam { |param| + params << param +} + +params.sort { |a,b| + a.to_s <=> b.to_s +}.each { |param| puts "- **" + param.to_s + "**" puts tab(1) + Puppet::Type.metaparamdoc(param).gsub(/\n\s*/,' ') } @@ -107,8 +114,7 @@ Types - *namevar* is the parameter used to uniquely identify a type instance. This is the parameter that gets assigned when a string is provided before the colon in a type declaration. -- *states* are the aspects of a type that can be changed. -- *params* control how a type implements the state changes. +- *parameters* determine the specific configuration of the instance. } diff --git a/lib/puppet/type/pfile.rb b/lib/puppet/type/pfile.rb index 9a0798581..074d86ab1 100644 --- a/lib/puppet/type/pfile.rb +++ b/lib/puppet/type/pfile.rb @@ -831,8 +831,7 @@ module Puppet :backup, :linkmaker, :source, - :recurse, - :filebucket + :recurse ] @paramdoc[:path] = "The path to the file to manage. Must be fully @@ -855,10 +854,6 @@ module Puppet using either a full local path or using a URI (currently only *file* is supported as a protocol)." - @paramdoc[:filebucket] = "A repository for backing up files, including - over the network. Argument must be the name of an existing - filebucket." - @name = :file @namevar = :path diff --git a/lib/puppet/type/pfilebucket.rb b/lib/puppet/type/pfilebucket.rb index c5d1eeb22..7d38a612a 100755 --- a/lib/puppet/type/pfilebucket.rb +++ b/lib/puppet/type/pfilebucket.rb @@ -18,6 +18,23 @@ module Puppet :port ] + @doc = "A repository for backing up files. If no filebucket is + defined, then files will be backed up in their current directory, + but the filebucket can be either a host- or site-global repository + for backing up. It stores files and returns the MD5 sum, which + can later be used to retrieve the file if restoration becomes + necessary. A filebucket does not do any work itself; instead, + it can be specified as the value of *backup* in a **file** object." + + @paramdoc[:name] = "The name of the filebucket." + @paramdoc[:server] = "The server providing the filebucket. If this is + not specified, then the bucket is local and *path* must be specified." + @paramdoc[:port] = "The port on which the remote server is listening. + Defaults to the normal Puppet port, %s." % Puppet[:masterport] + @paramdoc[:path] = "The path to the local filebucket. If this is + not specified, then the bucket is remote and *server* must be + specified." + @name = :filebucket @namevar = :name |