summaryrefslogtreecommitdiff
path: root/lib/chef/resource/execute.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-02-13 16:34:47 +0000
committerTim Smith <tsmith@chef.io>2018-02-14 11:37:36 -0800
commit5c2b9e201f65d04252a86b1ad89d756f3e73792f (patch)
tree7eaa3b8131eef7afa79422a79b0219021a5972b6 /lib/chef/resource/execute.rb
parentc563a379b2ac9a47f5bd5c9e0c40bebed86aae8c (diff)
downloadchef-5c2b9e201f65d04252a86b1ad89d756f3e73792f.tar.gz
Add new introduced and description resource properties to many resource
Not all of them, but a good chunk. Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/execute.rb')
-rw-r--r--lib/chef/resource/execute.rb8
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/chef/resource/execute.rb b/lib/chef/resource/execute.rb
index 616195deee..0c1b187ed0 100644
--- a/lib/chef/resource/execute.rb
+++ b/lib/chef/resource/execute.rb
@@ -22,13 +22,15 @@ require "chef/provider/execute"
class Chef
class Resource
- # Use the execute resource to execute a single command. Commands that are executed with this resource are (by their
- # nature) not idempotent, as they are typically unique to the environment in which they are run. Use not_if and only_if
- # to guard this resource for idempotence.
class Execute < Chef::Resource
identity_attr :command
+ description "Use the execute resource to execute a single command. Commands that"\
+ " are executed with this resource are (by their nature) not idempotent,"\
+ " as they are typically unique to the environment in which they are run."\
+ " Use not_if and only_if to guard this resource for idempotence."
+
# The ResourceGuardInterpreter wraps a resource's guards in another resource. That inner resource
# needs to behave differently during (for example) why_run mode, so we flag it here. For why_run mode
# we still want to execute the guard resource even if we are not executing the wrapping resource.