summaryrefslogtreecommitdiff
path: root/lib/chef/resource/dsc_script.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-07-25 10:42:17 -0700
committerTim Smith <tsmith@chef.io>2018-07-25 10:42:17 -0700
commit77f21e4284b04d27b972589e6fed071d1f516733 (patch)
tree4d4e8edb7cd66375d7bd441dcb3a6aa5cebbee68 /lib/chef/resource/dsc_script.rb
parent0f374934172e2ec699c9891e8b136e1aa7ddde06 (diff)
downloadchef-77f21e4284b04d27b972589e6fed071d1f516733.tar.gz
Add descriptions to dsc_script
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/dsc_script.rb')
-rw-r--r--lib/chef/resource/dsc_script.rb15
1 files changed, 11 insertions, 4 deletions
diff --git a/lib/chef/resource/dsc_script.rb b/lib/chef/resource/dsc_script.rb
index 86be3ddd70..e941e4e918 100644
--- a/lib/chef/resource/dsc_script.rb
+++ b/lib/chef/resource/dsc_script.rb
@@ -115,10 +115,17 @@ class Chef
end
end
- property :flags, Hash
- property :cwd, String
- property :environment, Hash
- property :timeout, Integer
+ property :flags, Hash,
+ description: "Pass parameters to the DSC script that is specified by the command property. Parameters are defined as key-value pairs, where the value of each key is the parameter to pass. This property may not be used in the same recipe as the code property."
+
+ property :cwd, String,
+ description: "The current working directory."
+
+ property :environment, Hash,
+ description: "A Hash of environment variables in the form of ({'ENV_VARIABLE' => 'VALUE'}). (These variables must exist for a command to be run successfully)."
+
+ property :timeout, Integer,
+ description: "The amount of time (in seconds) a command is to wait before timing out."
end
end
end