summaryrefslogtreecommitdiff
path: root/lib/chef/resource/batch.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2017-12-19 11:22:19 -0800
committerTim Smith <tsmith@chef.io>2017-12-19 11:22:19 -0800
commit034f00f6c466c3924e5fdb069b484d1961283c76 (patch)
treee2f6d9b911c838df661d1bd9cd643858a19847b9 /lib/chef/resource/batch.rb
parentfc813e21f253d5278cb42710874a34cfebfcc8ca (diff)
downloadchef-034f00f6c466c3924e5fdb069b484d1961283c76.tar.gz
Add descriptions and @since comments to all resources
From the docs site Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/batch.rb')
-rw-r--r--lib/chef/resource/batch.rb5
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/chef/resource/batch.rb b/lib/chef/resource/batch.rb
index 10e96839fb..b3c7b17cef 100644
--- a/lib/chef/resource/batch.rb
+++ b/lib/chef/resource/batch.rb
@@ -20,6 +20,11 @@ require "chef/resource/windows_script"
class Chef
class Resource
+ # Use the batch resource to execute a batch script using the cmd.exe interpreter on Windows. The batch resource
+ # creates and executes a temporary file (similar to how the script resource behaves), rather than running the
+ # command inline. 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 Batch < Chef::Resource::WindowsScript
provides :batch, os: "windows"