diff options
Diffstat (limited to 'lib/chef/resource')
| -rw-r--r-- | lib/chef/resource/cab_package.rb | 2 | ||||
| -rw-r--r-- | lib/chef/resource/chef_gem.rb | 2 | ||||
| -rw-r--r-- | lib/chef/resource/dmg_package.rb | 4 | ||||
| -rw-r--r-- | lib/chef/resource/execute.rb | 2 | ||||
| -rw-r--r-- | lib/chef/resource/sudo.rb | 6 | ||||
| -rw-r--r-- | lib/chef/resource/swap_file.rb | 2 | ||||
| -rw-r--r-- | lib/chef/resource/sysctl.rb | 2 |
7 files changed, 10 insertions, 10 deletions
diff --git a/lib/chef/resource/cab_package.rb b/lib/chef/resource/cab_package.rb index a90ddc6891..501a0dfa26 100644 --- a/lib/chef/resource/cab_package.rb +++ b/lib/chef/resource/cab_package.rb @@ -39,7 +39,7 @@ class Chef uri_scheme?(s) ? s : Chef::Util::PathHelper.canonical_path(s, false) end end), - default: lazy { |r| r.package_name } + default: lazy { |r| r.package_name }, default_description: "The package name." end end end diff --git a/lib/chef/resource/chef_gem.rb b/lib/chef/resource/chef_gem.rb index 0a1b2ef736..6758a0c753 100644 --- a/lib/chef/resource/chef_gem.rb +++ b/lib/chef/resource/chef_gem.rb @@ -36,7 +36,7 @@ class Chef class ChefGem < Chef::Resource::Package::GemPackage resource_name :chef_gem - property :gem_binary, default: "#{RbConfig::CONFIG['bindir']}/gem", + property :gem_binary, default: "#{RbConfig::CONFIG['bindir']}/gem", default_description: "Chef's built-in gem binary.", description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by the chef-client will be installed.", callbacks: { "The chef_gem resource is restricted to the current gem environment, use gem_package to install to other environments." => proc { |v| v == "#{RbConfig::CONFIG['bindir']}/gem" }, diff --git a/lib/chef/resource/dmg_package.rb b/lib/chef/resource/dmg_package.rb index 17645e519b..cd2f0b5c3a 100644 --- a/lib/chef/resource/dmg_package.rb +++ b/lib/chef/resource/dmg_package.rb @@ -48,12 +48,12 @@ class Chef property :volumes_dir, String, description: "The Directory under /Volumes where the dmg is mounted as not all dmgs are mounted into a /Volumes location matching the name of the dmg.", - default: lazy { |r| r.app } + default: lazy { |r| r.app }, default_description: "The value passed for the application name." property :dmg_name, String, description: "The name of the dmg if it is not the same as app, or if the name has spaces.", desired_state: false, - default: lazy { |r| r.app } + default: lazy { |r| r.app }, default_description: "The value passed for the application name." property :type, String, description: "The type of package.", diff --git a/lib/chef/resource/execute.rb b/lib/chef/resource/execute.rb index 1becbf50a7..2643a45756 100644 --- a/lib/chef/resource/execute.rb +++ b/lib/chef/resource/execute.rb @@ -100,7 +100,7 @@ class Chef # lazy used to set default value of sensitive to true if password is set property :sensitive, [ TrueClass, FalseClass ], description: "Ensure that sensitive resource data is not logged by the chef-client.", - default: lazy { |r| r.password ? true : false } + default: lazy { |r| r.password ? true : false }, default_description: "True if the password property is set. False otherwise." property :elevated, [ TrueClass, FalseClass ], default: false, description: "Determines whether the script will run with elevated permissions to circumvent User Access Control (UAC) interactively blocking the process.\nThis will cause the process to be run under a batch login instead of an interactive login. The user running Chef needs the “Replace a process level token” and “Adjust Memory Quotas for a process” permissions. The user that is running the command needs the “Log on as a batch job” permission.\nBecause this requires a login, the user and password properties are required.", diff --git a/lib/chef/resource/sudo.rb b/lib/chef/resource/sudo.rb index c417a4d26c..3bfcb7589e 100644 --- a/lib/chef/resource/sudo.rb +++ b/lib/chef/resource/sudo.rb @@ -37,7 +37,7 @@ class Chef # acording to the sudo man pages sudo will ignore files in an include dir that have a `.` or `~` # We convert either to `__` property :filename, String, - description: "The name of the sudoers.d file.", + description: "The name of the sudoers.d file, if it differs from the name of the resource block", name_property: true, coerce: proc { |x| x.gsub(/[\.~]/, "__") } @@ -106,8 +106,8 @@ class Chef default: "/usr/sbin/visudo" property :config_prefix, String, - description: "The directory that contains the sudoers configuration file", - default: lazy { platform_config_prefix } + description: "The directory that contains the sudoers configuration file.", + default: lazy { platform_config_prefix }, default_description: "Prefix values based on the node's platform" # handle legacy cookbook property def after_created diff --git a/lib/chef/resource/swap_file.rb b/lib/chef/resource/swap_file.rb index c42c7b6d59..87920e3d9b 100644 --- a/lib/chef/resource/swap_file.rb +++ b/lib/chef/resource/swap_file.rb @@ -27,7 +27,7 @@ class Chef introduced "14.0" property :path, String, - description: "The path to put the swap file on the system.", + description: "The path where the swap file will be created on the system, if it differs from the resource block name.", name_property: true property :size, Integer, diff --git a/lib/chef/resource/sysctl.rb b/lib/chef/resource/sysctl.rb index 10d6177221..643ceb233a 100644 --- a/lib/chef/resource/sysctl.rb +++ b/lib/chef/resource/sysctl.rb @@ -33,7 +33,7 @@ class Chef introduced "14.0" property :key, String, - description: "The kernel parameter key in dotted format.", + description: "The kernel parameter key in dotted format, if it differs from the resource block name.", name_property: true property :ignore_error, [TrueClass, FalseClass], |