summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPete Higgins <pete@peterhiggins.org>2020-05-26 13:07:06 -0700
committerPete Higgins <pete@peterhiggins.org>2020-05-26 13:07:10 -0700
commit6b5baedecd8d6b89e9f6e96a797c3c3bf3341118 (patch)
tree54c3ac6326325f8d5e62ef220a64755154f81ff2
parente8b970318998f46ad964947fade8d3980ef92641 (diff)
downloadchef-6b5baedecd8d6b89e9f6e96a797c3c3bf3341118.tar.gz
Reformat description and add note.
Signed-off-by: Pete Higgins <pete@peterhiggins.org>
-rw-r--r--lib/chef/resource/execute.rb13
1 files changed, 9 insertions, 4 deletions
diff --git a/lib/chef/resource/execute.rb b/lib/chef/resource/execute.rb
index 643248bf70..aecf272444 100644
--- a/lib/chef/resource/execute.rb
+++ b/lib/chef/resource/execute.rb
@@ -27,10 +27,15 @@ class Chef
provides :execute, target_mode: true
- 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."
+ description <<~DESC
+ 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.
+
+ Note: Use the **script** resource to execute a script using a specific
+ interpreter (Ruby, Python, Perl, csh, or Bash).'
+ DESC
# 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