rearranging some documentation

git-svn-id: https://reductivelabs.com/svn/puppet/trunk@632 980ebf18-57e1-0310-9a29-db15c13687c0

2 files changed, 18 insertions, 6 deletions

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