From aa31dc9e7ea2161c34826279c2302bacd8fa7233 Mon Sep 17 00:00:00 2001 From: micah Date: Wed, 20 Feb 2013 11:05:16 -0500 Subject: Update README The previous version said that one of the three things it did was to "provide a few lenses only included in recent augeas releases". The module doesn't do that anymore, and some of the other things it did do were not document, so this updates the README to be more current. --- README | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) (limited to 'README') diff --git a/README b/README index 84d77c6..460e4c0 100644 --- a/README +++ b/README @@ -7,8 +7,24 @@ == Description == This module does 3 things: - - o provides a few lenses only included in recent augeas releases. - o let's you force the version by defining $augeas_version, else puppet will + o lets you force the augeas version by defining $augeas_version, otherwise puppet will only ensure the packages are present. + o lets you force the ruby library version by defining $augeas_ruby_version, otherwise puppet will + only ensure the libagueas-ruby version will be installed according to internal critera + o lets you deploy an augeas lens and any associated test files, running unit tests and not installing if they fail: + + Parameters: + - *ensure*: present/absent + - *lens_source*: the source for the lens + - *test_source*: optionally, 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', + } -- cgit v1.2.3 From e4f9a282b86566430652e69d40b9ecaa723fbb05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Pinson?= Date: Wed, 13 Mar 2013 10:12:04 +0100 Subject: Rename README as README.markdown --- README | 30 ------------------------------ 1 file changed, 30 deletions(-) delete mode 100644 README (limited to 'README') diff --git a/README b/README deleted file mode 100644 index 460e4c0..0000000 --- a/README +++ /dev/null @@ -1,30 +0,0 @@ -= Augeas Puppet module = - -== Usage == - - include augeas - -== Description == - -This module does 3 things: - - o lets you force the augeas version by defining $augeas_version, otherwise puppet will - only ensure the packages are present. - o lets you force the ruby library version by defining $augeas_ruby_version, otherwise puppet will - only ensure the libagueas-ruby version will be installed according to internal critera - o lets you deploy an augeas lens and any associated test files, running unit tests and not installing if they fail: - - Parameters: - - *ensure*: present/absent - - *lens_source*: the source for the lens - - *test_source*: optionally, 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', - } -- cgit v1.2.3