summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2021-02-06 21:24:17 -0800
committerTim Smith <tsmith84@gmail.com>2021-02-06 21:24:17 -0800
commit6ba03b3d7d86d8fc4922ae29580dc0c6b23db8cf (patch)
tree6f0f615f6f30052c8facee4f62838f1a31fdcd3d /lib
parenta7004cae76f89507a279351fdcb767cbce059574 (diff)
downloadchef-6ba03b3d7d86d8fc4922ae29580dc0c6b23db8cf.tar.gz
Add more action descriptions
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib')
-rw-r--r--lib/chef/resource/windows_env.rb8
1 files changed, 5 insertions, 3 deletions
diff --git a/lib/chef/resource/windows_env.rb b/lib/chef/resource/windows_env.rb
index ab65465ed6..0e23922b3a 100644
--- a/lib/chef/resource/windows_env.rb
+++ b/lib/chef/resource/windows_env.rb
@@ -192,7 +192,8 @@ class Chef
end
end
- action :create do
+ action :create, description: "Create an environment variable. If an environment variable
+ already exists (but does not match), update that environment variable to match." do
if key_exists?
if requires_modify_or_create?
modify_env
@@ -206,7 +207,7 @@ class Chef
end
end
- action :delete do
+ action :delete, description: "Delete an environment variable." do
if ( ENV[new_resource.key_name] || key_exists? ) && !delete_element
delete_env
logger.info("#{new_resource} deleted")
@@ -214,7 +215,8 @@ class Chef
end
end
- action :modify do
+ action :modify, description: "Modify an existing environment variable. This prepends the new value
+ to the existing value, using the delimiter specified by the `delim` property." do
if key_exists?
if requires_modify_or_create?
modify_env