From: David Bishop <david@gnuconsulting.com>
Date: Sat, 25 Jan 2014 18:23:17 +0000 (-0500)
Subject: (DOCUMENT-21) add docs for file_line to README.markdown
X-Git-Url: https://gitweb.fluxo.info/?a=commitdiff_plain;h=dbba655c106f951061206aaf0863f4f8d18da7b1;p=puppet-stdlib.git

(DOCUMENT-21) add docs for file_line to README.markdown

Without this, you have to look at the source file
(lib/puppet/type/file_line.rb) to know what it does. This adds that
documentation.
---

diff --git a/README.markdown b/README.markdown
index 822b8af..85bfada 100644
--- a/README.markdown
+++ b/README.markdown
@@ -305,6 +305,26 @@ the type and parameters specified if it doesn't already exist.
 
 - *Type*: statement
 
+file_line
+---------
+This resource ensures that a given line is contained within a file. You can also use 
+"match" to replace existing lines.
+
+*Examples:*
+
+    file_line { 'sudo_rule':
+      path => '/etc/sudoers',
+      line => '%sudo ALL=(ALL) ALL',
+    }
+
+    file_line { 'change_mount':
+      path  => '/etc/fstab',
+      line  => '10.0.0.1:/vol/data /opt/data nfs defaults 0 0',
+      match => '^172.16.17.2:/vol/old',
+    }
+
+- *Type*: resource
+
 flatten
 -------
 This function flattens any deeply nested arrays and returns a single flat array