diff options
| author | Tim Smith <tsmith84@gmail.com> | 2021-02-06 21:24:45 -0800 |
|---|---|---|
| committer | Tim Smith <tsmith84@gmail.com> | 2021-02-06 21:24:45 -0800 |
| commit | 1b34688d1c94e9eadc0541b9132b763c7aedd32e (patch) | |
| tree | 858427a7a7df3e000afb1efb44c37b517f74dd81 | |
| parent | 6ba03b3d7d86d8fc4922ae29580dc0c6b23db8cf (diff) | |
| download | chef-more_docs.tar.gz | |
Expand windows_env resource descriptionmore_docs
Signed-off-by: Tim Smith <tsmith@chef.io>
| -rw-r--r-- | lib/chef/resource/windows_env.rb | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/chef/resource/windows_env.rb b/lib/chef/resource/windows_env.rb index 0e23922b3a..a714ef5aaa 100644 --- a/lib/chef/resource/windows_env.rb +++ b/lib/chef/resource/windows_env.rb @@ -19,6 +19,7 @@ require_relative "../resource" require_relative "../mixin/windows_env_helper" +require "chef-utils/dist" unless defined?(ChefUtils::Dist) class Chef class Resource @@ -28,7 +29,7 @@ class Chef provides :windows_env provides :env # backwards compat with the pre-Chef 14 resource name - description "Use the **windows_env** resource to manage environment keys in Microsoft Windows. After an environment key is set, Microsoft Windows must be restarted before the environment key will be available to the Task Scheduler." + description "Use the **windows_env** resource to manage environment keys in Microsoft Windows. After an environment key is set, Microsoft Windows must be restarted before the environment key will be available to the Task Scheduler.\nThis resource was previously called the **env** resource; its name was updated in #{ChefUtils::Dist::Infra::PRODUCT} 14.0 to reflect the fact that only Windows is supported. Existing cookbooks using `env` will continue to function, but should be updated to use the new name. Note: On UNIX-based systems, the best way to manipulate environment keys is with the `ENV` variable in Ruby; however, this approach does not have the same permanent effect as using the windows_env resource." examples <<~DOC **Set an environment variable**: |