diff options
author | Chris Price <chris@pupppetlabs.com> | 2012-08-16 19:30:58 -0700 |
---|---|---|
committer | Chris Price <chris@pupppetlabs.com> | 2012-08-16 21:50:20 -0700 |
commit | 4f0e7264e3c3089e489d05bbb4371c449b0ed78d (patch) | |
tree | fea109b142afa7bc9233dd651d849cd61cc1d327 /README.markdown | |
parent | bf06644b4a38a40a36c629e7dc619fba4c35c730 (diff) | |
download | puppet-inifile-4f0e7264e3c3089e489d05bbb4371c449b0ed78d.tar.gz puppet-inifile-4f0e7264e3c3089e489d05bbb4371c449b0ed78d.tar.bz2 |
final commit for 0.0.1 release
* Updated README
* Fixed a small bug that would be triggered if the file specified
by `path` didn't exist.
* Added a smoke test manifest
Diffstat (limited to 'README.markdown')
-rw-r--r-- | README.markdown | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..3e6532e --- /dev/null +++ b/README.markdown @@ -0,0 +1,22 @@ +# INI-file module # + +This module provides resource types for use in managing INI-style configuration +files. The main resource type is `ini_setting`, which is used to manage an +individual setting in an INI file. Here's an example usage: + + ini_setting { "sample setting": + path => '/tmp/foo.ini', + section => 'foo', + setting => 'foosetting', + value => 'FOO!', + ensure => present, + } + +A few noteworthy features: + + * The module tries *hard* not to manipulate your file any more than it needs to. + In most cases, it should leave the original whitespace, comments, ordering, + etc. perfectly intact. + * Supports comments starting with either '#' or ';'. + * Will add missing sections if they don't exist. + |