diff options
| author | ciprianbadescu <51971875+ciprianbadescu@users.noreply.github.com> | 2021-10-01 11:19:45 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-01 11:19:45 +0300 |
| commit | b6e01188a676f34f6e8998de1a87c169c893fc17 (patch) | |
| tree | 0b276ccba799bf6f097186b7963565cad80d106e /lib | |
| parent | 8f8c5a5b8f2addd157d353740202539218f2be9c (diff) | |
| parent | 5762b07a5447684ab75b4cf0d2ed989d37b25459 (diff) | |
| download | puppet-augeas_core-b6e01188a676f34f6e8998de1a87c169c893fc17.tar.gz puppet-augeas_core-b6e01188a676f34f6e8998de1a87c169c893fc17.tar.bz2 | |
Merge pull request #42 from GabrielNagy/MODULES-8183/fix-reference-truncation
(MODULES-8183) Fix ToC truncation in REFERENCE.md
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/puppet/type/augeas.rb | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/lib/puppet/type/augeas.rb b/lib/puppet/type/augeas.rb index 2303fdc..ef93bce 100644 --- a/lib/puppet/type/augeas.rb +++ b/lib/puppet/type/augeas.rb @@ -23,25 +23,24 @@ Puppet::Type.newtype(:augeas) do feature :execute_changes, 'Actually make the changes' @doc = <<-'EOT' - Apply a change or an array of changes to the filesystem - using the augeas tool. + @summary Apply a change or an array of changes to the filesystem using the augeas tool. Requires: - [Augeas](http://www.augeas.net) - The ruby-augeas bindings - Sample usage with a string: + @example Sample usage with a string: - augeas{"test1" : + augeas { "test1": context => "/files/etc/sysconfig/firstboot", changes => "set RUN_FIRSTBOOT YES", onlyif => "match other_value size > 0", } - Sample usage with an array and custom lenses: + @example Sample usage with an array and custom lenses: - augeas{"jboss_conf": + augeas { "jboss_conf": context => "/files", changes => [ "set etc/jbossas/jbossas.conf/JBOSS_IP $ipaddress", |