summaryrefslogtreecommitdiff
path: root/lib/chef/resource/execute.rb
diff options
context:
space:
mode:
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.