diff options
author | nfagerlund <nick.fagerlund@gmail.com> | 2011-04-01 10:35:41 -0700 |
---|---|---|
committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-04-01 10:35:41 -0700 |
commit | 0675c9a7ae90b25e1d723c19a7691b12eac9becd (patch) | |
tree | 57bebac66a85d6514c9f29698b0b866a9d9dd386 | |
parent | 2cdadf9b7fa7a4a1b826150549e5faffc4e494f3 (diff) | |
download | puppet-0675c9a7ae90b25e1d723c19a7691b12eac9becd.tar.gz puppet-0675c9a7ae90b25e1d723c19a7691b12eac9becd.tar.xz puppet-0675c9a7ae90b25e1d723c19a7691b12eac9becd.zip |
(#6937) Adjust formatting of recurse's desc
Prevous formatting would result in broken Markdown after the docs were generated,
as Markdown does not recognize a two-space tab as a syntactical element.
This patch also changes the list of values to a bulleted list instead of a code block.
-rw-r--r-- | lib/puppet/type/file.rb | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/lib/puppet/type/file.rb b/lib/puppet/type/file.rb index 79f4b81ab..630ebe5de 100644 --- a/lib/puppet/type/file.rb +++ b/lib/puppet/type/file.rb @@ -123,15 +123,16 @@ Puppet::Type.newtype(:file) do newparam(:recurse) do desc "Whether and how deeply to do recursive 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. + + * `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]+` --- Same as true, but limit recursion. Warning: this syntax + has been deprecated in favor of the `recurselimit` attribute. " newvalues(:true, :false, :inf, :remote, /^[0-9]+$/) |