From 2cdadf9b7fa7a4a1b826150549e5faffc4e494f3 Mon Sep 17 00:00:00 2001 From: Ben Hughes Date: Fri, 1 Apr 2011 12:48:38 +1100 Subject: (#6937) Document the recurse parameter of File type. 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. --- lib/puppet/type/file.rb | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'lib/puppet') diff --git a/lib/puppet/type/file.rb b/lib/puppet/type/file.rb index e1a4ecbb9..79f4b81ab 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]+$/) -- cgit