summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMickaël Canévet <mickael.canevet@camptocamp.com>2015-03-17 15:58:12 +0100
committerMickaël Canévet <mickael.canevet@camptocamp.com>2015-03-17 16:02:10 +0100
commitf02d6faadd181493ccc9236f43296f2ba56ed592 (patch)
tree5d048513fa82cd2a5add47e74d2c03a253b9df96 /README.md
parent6277f0a189e6e8e457dba9ee5bfe2e303746157b (diff)
Encourage file() usage
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index e2055b0..863f4d6 100644
--- a/README.md
+++ b/README.md
@@ -36,18 +36,22 @@ The `augeas::lens` definition allows you to deploy an Augeas lens and any associ
Parameters:
- *ensure*: present/absent
-- *lens_source*: the source for the lens
-- *test_source*: optionally, the source for the test file.
+- *lens_content*: the content of the lens
+- *lens_source*: deprecated, the source for the lens
+- *test_content*: optionally, the content of the test file
+- *test_source*: deprecated, the source for the test file.
- *stock_since*: optionally, indicate in which version of Augeas
the lens became stock, so it will not be deployed above that version.
Example usage:
- augeas::lens { 'networkmanager':
- lens_source => 'puppet:///modules/networkmanager/lenses/networkmanager.aug',
- test_source => 'puppet:///modules/networkmanager/lenses/test_networkmanager.aug',
- stock_since => '1.0.0',
- }
+```puppet
+augeas::lens { 'networkmanager':
+ lens_content => file('networkmanager/lenses/networkmanager.aug'),
+ test_content => file('networkmanager/lenses/test_networkmanager.aug'),
+ stock_since => '1.0.0',
+}
+```
### Functions