Update the desc block with information gleaned from #1469 and the code
about recurse => remote and other types of recursion.
The auto generated documentation was sparse and this is an area that often
comes up on the mailing list/IRC.
Signed-off-by: Ben Hughes <b...@puppetlabs.com>
---
lib/puppet/type/file.rb | 12 +++++++++++-
1 files changed, 11 insertions(+), 1 deletions(-)
diff --git a/lib/puppet/type/file.rb b/lib/puppet/type/file.rb
index 963b9e5..cbaefef 100644
--- a/lib/puppet/type/file.rb
+++ b/lib/puppet/type/file.rb
@@ -120,7 +120,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]+$/)
--
1.7.4.2
--
You received this message because you are subscribed to the Google Groups
"Puppet Developers" group.
To post to this group, send email to puppet-dev@googlegroups.com.
To unsubscribe from this group, send email to
puppet-dev+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/puppet-dev?hl=en.
