aboutsummaryrefslogtreecommitdiff
path: root/lib/puppet
diff options
context:
space:
mode:
Diffstat (limited to 'lib/puppet')
-rw-r--r--lib/puppet/type/augeas.rb11
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",