summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJames Turnbull <james@lovedthanlost.net>2011-04-01 17:38:06 +1100
committerJames Turnbull <james@lovedthanlost.net>2011-04-01 17:38:06 +1100
commitb82bf9faa84447ac13b09d9d2db310fb3a35bd12 (patch)
tree7159c47f9ace706def98bde820bbf2a014caba1c
parent9c06fbd762cddcc41a7185a36f2a8e72879125eb (diff)
parentee1df783ddd4b72bd959735443b5dbdfea69e323 (diff)
downloadpuppet-b82bf9faa84447ac13b09d9d2db310fb3a35bd12.tar.gz
puppet-b82bf9faa84447ac13b09d9d2db310fb3a35bd12.tar.xz
puppet-b82bf9faa84447ac13b09d9d2db310fb3a35bd12.zip
Merge commit 'ee1df783ddd4b72bd959735443b5dbdfea69e323' into next
* commit 'ee1df783ddd4b72bd959735443b5dbdfea69e323': (#6937) Document the recurse parameter of File type.
-rw-r--r--lib/puppet/type/file.rb12
1 files changed, 11 insertions, 1 deletions
diff --git a/lib/puppet/type/file.rb b/lib/puppet/type/file.rb
index 1a6d0c3ac..a73ada57e 100644
--- a/lib/puppet/type/file.rb
+++ b/lib/puppet/type/file.rb
@@ -122,7 +122,17 @@ Puppet::Type.newtype(:file) do
newparam(:recurse) do
desc "Whether and how deeply to do recursive
- management."
+ management. Options are:
+ inf,true => Regular style recursion on both remote and local
+ directory structure.
+ remote => Descends recursively into the remote directory
+ but not the local directory. Allows copying of
+ a few files into a directory containing many
+ unmanaged files without scanning all the local files.
+ false => Default of no-recursion.
+ [0-9]+ => Both, but limit recursion. Warning: this syntax
+ is deprecated and has moved to recurselimit.
+ "
newvalues(:true, :false, :inf, :remote, /^[0-9]+$/)