diff options
| author | Michael Stahnke <stahnma@puppetlabs.com> | 2011-08-17 10:37:23 -0700 |
|---|---|---|
| committer | Michael Stahnke <stahnma@puppetlabs.com> | 2011-08-17 10:37:23 -0700 |
| commit | 0702c0cde0f161e2f43bdf195eb3fb0b749aa3d7 (patch) | |
| tree | f31de098035402cf400d47c8cd632ea418b5eef2 | |
| parent | fe22c1c4819d035af02c9db5d065a712dc2d0e3c (diff) | |
| parent | 7ac10930b30f13b5fdb7aea094283c8c122a0918 (diff) | |
| download | puppet-0702c0cde0f161e2f43bdf195eb3fb0b749aa3d7.tar.gz puppet-0702c0cde0f161e2f43bdf195eb3fb0b749aa3d7.tar.xz puppet-0702c0cde0f161e2f43bdf195eb3fb0b749aa3d7.zip | |
Merge pull request #44 from nfagerlund/ticket/2.7.x/8037_incorrect_augeas_example
(#8037) Fix incorrect example in Augeas type reference
| -rw-r--r-- | lib/puppet/type/augeas.rb | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/lib/puppet/type/augeas.rb b/lib/puppet/type/augeas.rb index f4d3c43e1..c96986e7e 100644 --- a/lib/puppet/type/augeas.rb +++ b/lib/puppet/type/augeas.rb @@ -20,7 +20,8 @@ Puppet::Type.newtype(:augeas) do feature :need_to_run?, "If the command should run" feature :execute_changes, "Actually make the changes" - @doc = "Apply the changes (single or array of changes) to the filesystem + @doc = <<-EOT + Apply the changes (single or array of changes) to the filesystem via the augeas tool. Requires: @@ -30,24 +31,24 @@ Puppet::Type.newtype(:augeas) do Sample usage with a string: - augeas{\"test1\" : - context => \"/files/etc/sysconfig/firstboot\", - changes => \"set RUN_FIRSTBOOT YES\", - onlyif => \"match other_value size > 0\", + 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: - augeas{\"jboss_conf\": - context => \"/files\", + augeas{"jboss_conf": + context => "/files", changes => [ - \"set /etc/jbossas/jbossas.conf/JBOSS_IP $ipaddress\", - \"set /etc/jbossas/jbossas.conf/JAVA_HOME /usr\" + "set etc/jbossas/jbossas.conf/JBOSS_IP $ipaddress", + "set etc/jbossas/jbossas.conf/JAVA_HOME /usr", ], - load_path => \"$/usr/share/jbossas/lenses\", + load_path => "$/usr/share/jbossas/lenses", } - " + EOT newparam (:name) do desc "The name of this task. Used for uniqueness" |