diff options
| author | nfagerlund <nick.fagerlund@gmail.com> | 2011-08-02 11:19:14 -0700 |
|---|---|---|
| committer | nfagerlund <nick.fagerlund@gmail.com> | 2011-08-09 15:56:45 -0700 |
| commit | 51d989ef5da1d0a9257bb402eb7708385cac798a (patch) | |
| tree | 245b18925d1d234c3ce0fc748e2b17929fb6fd54 /lib | |
| parent | a110d83fb81bf35d2d4d66d1d04e271877b79948 (diff) | |
| download | puppet-51d989ef5da1d0a9257bb402eb7708385cac798a.tar.gz puppet-51d989ef5da1d0a9257bb402eb7708385cac798a.tar.xz puppet-51d989ef5da1d0a9257bb402eb7708385cac798a.zip | |
Maint: Adjust wording for file type's content parameter
The content parameter's doc string said: "The primary purpose of this
parameter is to provide a kind of limited templating... This attribute
is especially useful when used with templating." This commit clarifies
said awkward wording.
Diffstat (limited to 'lib')
| -rwxr-xr-x | lib/puppet/type/file/content.rb | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/lib/puppet/type/file/content.rb b/lib/puppet/type/file/content.rb index 827183213..93b8e6913 100755 --- a/lib/puppet/type/file/content.rb +++ b/lib/puppet/type/file/content.rb @@ -16,8 +16,10 @@ module Puppet attr_reader :actual_content desc "Specify the contents of a file as a string. Newlines, tabs, and - spaces can be specified using the escaped syntax (e.g., \\n for a newline). The primary purpose of this parameter is to provide a - kind of limited templating: + spaces can be specified using standard escaped syntax in + double-quoted strings (e.g., \\n for a newline). + + With very small files, you can construct strings directly... define resolve(nameserver1, nameserver2, domain, search) { $str = \"search $search @@ -31,7 +33,9 @@ module Puppet } } - This attribute is especially useful when used with templating." + ...but for larger files, this attribute is more useful when combined with the + [template](http://docs.puppetlabs.com/references/latest/function.html#template) + function." # Store a checksum as the value, rather than the actual content. # Simplifies everything. |
