summaryrefslogtreecommitdiff
path: root/lib/puppet/type/file_line.rb
diff options
context:
space:
mode:
authorJeff McCune <jeff@puppetlabs.com>2011-12-30 11:48:21 -0800
committerJeff McCune <jeff@puppetlabs.com>2011-12-30 11:48:21 -0800
commit80c9a8feeae6203026f61215e100e95078c61a04 (patch)
treee70920f96b88bdc9e985e2439f395371d5ffe2be /lib/puppet/type/file_line.rb
parent1434f3cea6f6e2a1b939d91cb5ff66338cc87d32 (diff)
parenta8d4bbd9e234ea577e27d83df95a61b374ac484b (diff)
downloadpuppet-stdlib-80c9a8feeae6203026f61215e100e95078c61a04.tar.gz
puppet-stdlib-80c9a8feeae6203026f61215e100e95078c61a04.tar.bz2
Merge branch 'v2.1.x' into v2.2.x
* v2.1.x: (maint) Add semantic versioning info to README Docs: Clarify the use case for the anchor type Docs: Remove author emails from stdlib functions Docs: Copyedit function doc strings Docs: Correct indentation of markdown code examples Docs: Update documentation of stdlib classes Docs: Update file_line documentation Docs: Improve example in merge function
Diffstat (limited to 'lib/puppet/type/file_line.rb')
-rw-r--r--lib/puppet/type/file_line.rb27
1 files changed, 19 insertions, 8 deletions
diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb
index aacd6d9..8b45897 100644
--- a/lib/puppet/type/file_line.rb
+++ b/lib/puppet/type/file_line.rb
@@ -1,14 +1,25 @@
Puppet::Type.newtype(:file_line) do
desc <<-EOT
- Type that can append whole a line to a file if it does not already contain it.
-
- Example:
-
- file_line { 'sudo_rule':
- path => '/etc/sudoers',
- line => '%admin ALL=(ALL) ALL',
- }
+ Ensures that a given line is contained within a file. The implementation
+ matches the full line, including whitespace at the beginning and end. If
+ the line is not contained in the given file, Puppet will add the line to
+ ensure the desired state. Multiple resources may be declared to manage
+ multiple lines in the same file.
+
+ Example:
+
+ file_line { 'sudo_rule':
+ path => '/etc/sudoers',
+ line => '%sudo ALL=(ALL) ALL',
+ }
+ file_line { 'sudo_rule_nopw':
+ path => '/etc/sudoers',
+ line => '%sudonopw ALL=(ALL) NOPASSWD: ALL',
+ }
+
+ In this example, Puppet will ensure both of the specified lines are
+ contained in the file /etc/sudoers.
EOT