diff options
| author | Tim Smith <tsmith84@gmail.com> | 2020-09-15 10:31:36 -0700 |
|---|---|---|
| committer | Tim Smith <tsmith84@gmail.com> | 2020-09-15 14:39:14 -0700 |
| commit | e21b0e14d1855edc53a8116fcaaf648287c71ab3 (patch) | |
| tree | 9399f09e557c3c8618f145f1dcf042fc06b4e2c3 | |
| parent | e4db9c3f4edc696274786187967006273c2c8652 (diff) | |
| download | chef-e21b0e14d1855edc53a8116fcaaf648287c71ab3.tar.gz | |
Improve the plugin property description
It doesn't work how you'd think it does
Signed-off-by: Tim Smith <tsmith@chef.io>
| -rw-r--r-- | lib/chef/resource/ohai.rb | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/chef/resource/ohai.rb b/lib/chef/resource/ohai.rb index 0aa1d947d6..8e550c0301 100644 --- a/lib/chef/resource/ohai.rb +++ b/lib/chef/resource/ohai.rb @@ -29,7 +29,7 @@ class Chef provides :ohai - description "Use the **ohai** resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the #{ChefUtils::Dist::Infra::CLIENT} run." + description "Use the **ohai** resource to reload the Ohai configuration on a node. This allows recipes that change system attributes (like a recipe that adds a user) to refer to those attributes later on during the #{ChefUtils::Dist::Infra::PRODUCT} run." examples <<~DOC Reload All Ohai Plugins @@ -40,11 +40,11 @@ class Chef end ``` - Reload A Single Ohai Plugins + Reload A Single Ohai Plugin ```ruby ohai 'reload' do - plugin 'cloud' + plugin 'ipaddress' action :reload end ``` @@ -75,7 +75,7 @@ class Chef DOC property :plugin, String, - description: "The name of an Ohai plugin to be reloaded. If this property is not specified, #{ChefUtils::Dist::Infra::PRODUCT} will reload all plugins." + description: "Specific Ohai attribute data to reload. This property behaves similar to specifying attributes when running Ohai on the command line and takes the attribute that you wish to reload instead of the actual plugin name. For instance you you can pass `ipaddress` to reload `node['ipaddress']` even though that data comes from the `Network` plugin. If this property is not specified, #{ChefUtils::Dist::Infra::PRODUCT} will reload all plugins." def load_current_resource true |