diff options
author | Tim Smith <tsmith@chef.io> | 2018-07-09 21:09:55 -0700 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2018-07-09 21:09:55 -0700 |
commit | 5b2fd637fde5c3b893db3b76a2e1ce4f2deed80a (patch) | |
tree | 880fb8a9dd9b5cac5bd0c35c88b9016d26ed2419 /lib/chef/resource | |
parent | 23d33adf3d4c879a67067e52f0850bb510571f28 (diff) | |
download | chef-5b2fd637fde5c3b893db3b76a2e1ce4f2deed80a.tar.gz |
Add missing periods in descriptions
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource')
-rw-r--r-- | lib/chef/resource/homebrew_tap.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/hostname.rb | 10 | ||||
-rw-r--r-- | lib/chef/resource/ifconfig.rb | 4 | ||||
-rw-r--r-- | lib/chef/resource/kernel_module.rb | 4 | ||||
-rw-r--r-- | lib/chef/resource/ohai_hint.rb | 6 | ||||
-rw-r--r-- | lib/chef/resource/openssl_dhparam.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/powershell_package.rb | 3 | ||||
-rw-r--r-- | lib/chef/resource/powershell_package_source.rb | 8 | ||||
-rw-r--r-- | lib/chef/resource/rhsm_errata.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/rhsm_errata_level.rb | 2 | ||||
-rw-r--r-- | lib/chef/resource/rhsm_register.rb | 8 | ||||
-rw-r--r-- | lib/chef/resource/rhsm_repo.rb | 4 | ||||
-rw-r--r-- | lib/chef/resource/rhsm_subscription.rb | 4 | ||||
-rw-r--r-- | lib/chef/resource/sudo.rb | 8 |
14 files changed, 34 insertions, 33 deletions
diff --git a/lib/chef/resource/homebrew_tap.rb b/lib/chef/resource/homebrew_tap.rb index 2028ce80c8..ab56f6a4c9 100644 --- a/lib/chef/resource/homebrew_tap.rb +++ b/lib/chef/resource/homebrew_tap.rb @@ -49,7 +49,7 @@ class Chef default: "/usr/local/bin/brew" property :owner, String, - description: "The owner of the homebrew installation", + description: "The owner of the homebrew installation.", default: lazy { find_homebrew_username } action :tap do diff --git a/lib/chef/resource/hostname.rb b/lib/chef/resource/hostname.rb index f213ae47ad..d4b977bb78 100644 --- a/lib/chef/resource/hostname.rb +++ b/lib/chef/resource/hostname.rb @@ -27,7 +27,7 @@ class Chef introduced "14.0" property :hostname, String, - description: "The hostname if different than the resource's name", + description: "The hostname if different than the resource's name.", name_property: true property :compile_time, [ TrueClass, FalseClass ], @@ -35,15 +35,15 @@ class Chef default: true property :ipaddress, String, - description: "The ip address to use when configuring the hosts file", + description: "The ip address to use when configuring the hosts file.", default: lazy { node["ipaddress"] } property :aliases, [ Array, nil ], - description: "An array of hostname aliases to use when configuring the hosts file", + description: "An array of hostname aliases to use when configuring the hosts file.", default: nil property :windows_reboot, [ TrueClass, FalseClass ], - description: "Should Windows nodes be rebooted upon changing the name so it can take effect", + description: "Should Windows nodes be rebooted upon changing the name so it can take effect.", default: true action_class do @@ -80,7 +80,7 @@ class Chef end action :set do - description "Sets the node's hostname" + description "Sets the node's hostname." if node["platform_family"] != "windows" ohai "reload hostname" do diff --git a/lib/chef/resource/ifconfig.rb b/lib/chef/resource/ifconfig.rb index 84ee249ec4..d43b8c2d58 100644 --- a/lib/chef/resource/ifconfig.rb +++ b/lib/chef/resource/ifconfig.rb @@ -79,11 +79,11 @@ class Chef property :ethtool_opts, String, introduced: "13.4", - description: "Options to be passed to ethtool(8). For example: -A eth0 autoneg off rx off tx off" + description: "Options to be passed to ethtool(8). For example: -A eth0 autoneg off rx off tx off." property :bonding_opts, String, introduced: "13.4", - description: "Bonding options to pass via BONDING_OPTS on RHEL and CentOS. For example: mode=active-backup miimon=100" + description: "Bonding options to pass via BONDING_OPTS on RHEL and CentOS. For example: mode=active-backup miimon=100." property :master, String, introduced: "13.4", diff --git a/lib/chef/resource/kernel_module.rb b/lib/chef/resource/kernel_module.rb index bea56dedc2..54f213cd11 100644 --- a/lib/chef/resource/kernel_module.rb +++ b/lib/chef/resource/kernel_module.rb @@ -30,7 +30,7 @@ class Chef default: "/etc/modprobe.d" action :install do - description "Load kernel module, and ensure it loads on reboot" + description "Load kernel module, and ensure it loads on reboot." # load the module first before installing new_resource.run_action(:load) @@ -98,7 +98,7 @@ class Chef end action :unload do - description "Unload kernel module" + description "Unload kernel module." if module_loaded? converge_by("unload kernel module #{new_resource.modname}") do diff --git a/lib/chef/resource/ohai_hint.rb b/lib/chef/resource/ohai_hint.rb index f485222ec6..dcfffdba40 100644 --- a/lib/chef/resource/ohai_hint.rb +++ b/lib/chef/resource/ohai_hint.rb @@ -34,11 +34,11 @@ class Chef description: "Values to include in the hint file." property :compile_time, [TrueClass, FalseClass], - description: "Should the resource execute during the compile time phase", + description: "Should the resource execute during the compile time phase.", default: true, desired_state: false action :create do - description "Create an Ohai hint file" + description "Create an Ohai hint file." declare_resource(:directory, ::Ohai::Config.ohai.hints_path.first) do action :create @@ -52,7 +52,7 @@ class Chef end action :delete do - description "Delete an Ohai hint file" + description "Delete an Ohai hint file." declare_resource(:file, ohai_hint_file_path(new_resource.hint_name)) do action :delete diff --git a/lib/chef/resource/openssl_dhparam.rb b/lib/chef/resource/openssl_dhparam.rb index ec98237a1b..b7bc8438f2 100644 --- a/lib/chef/resource/openssl_dhparam.rb +++ b/lib/chef/resource/openssl_dhparam.rb @@ -59,7 +59,7 @@ class Chef default: "0640" action :create do - description "Create the dhparam file" + description "Create the dhparam file." unless dhparam_pem_valid?(new_resource.path) converge_by("Create a dhparam file #{new_resource.path}") do diff --git a/lib/chef/resource/powershell_package.rb b/lib/chef/resource/powershell_package.rb index ae6e410f21..58c38a6d32 100644 --- a/lib/chef/resource/powershell_package.rb +++ b/lib/chef/resource/powershell_package.rb @@ -37,7 +37,8 @@ class Chef property :package_name, [String, Array], coerce: proc { |x| [x].flatten } property :version, [String, Array], coerce: proc { |x| [x].flatten } property :source, [String] - property :skip_publisher_check, [true, false], default: false, introduced: "14.3", description: "Skip validating module author" + property :skip_publisher_check, [true, false], default: false, introduced: "14.3", + description: "Skip validating module author" end end end diff --git a/lib/chef/resource/powershell_package_source.rb b/lib/chef/resource/powershell_package_source.rb index 9fa4bc8497..1ed3b895a1 100644 --- a/lib/chef/resource/powershell_package_source.rb +++ b/lib/chef/resource/powershell_package_source.rb @@ -24,19 +24,19 @@ class Chef preview_resource true resource_name "powershell_package_source" - description "Use the powershell_package_source resource to register a powershell package repository" + description "Use the powershell_package_source resource to register a powershell package repository." introduced "14.3" property :source_name, String, - description: "The name of the package source", + description: "The name of the package source.", name_property: true property :url, String, - description: "The url to the package source", + description: "The url to the package source.", required: true property :trusted, [TrueClass, FalseClass], - description: "Whether or not to trust packages from this source", + description: "Whether or not to trust packages from this source.", default: false property :provider_name, String, diff --git a/lib/chef/resource/rhsm_errata.rb b/lib/chef/resource/rhsm_errata.rb index 96de1bafe7..15b6dab8bc 100644 --- a/lib/chef/resource/rhsm_errata.rb +++ b/lib/chef/resource/rhsm_errata.rb @@ -33,7 +33,7 @@ class Chef name_property: true action :install do - description "Installs a package for a specific errata ID" + description "Installs a package for a specific errata ID." execute "Install errata packages for #{new_resource.errata_id}" do command "yum update --advisory #{new_resource.errata_id} -y" diff --git a/lib/chef/resource/rhsm_errata_level.rb b/lib/chef/resource/rhsm_errata_level.rb index 73c9dc0423..ee94a3e60f 100644 --- a/lib/chef/resource/rhsm_errata_level.rb +++ b/lib/chef/resource/rhsm_errata_level.rb @@ -35,7 +35,7 @@ class Chef name_property: true action :install do - descripton "Install all packages of the specified errata level" + descripton "Install all packages of the specified errata level." yum_package "yum-plugin-security" do action :install diff --git a/lib/chef/resource/rhsm_register.rb b/lib/chef/resource/rhsm_register.rb index 0e478eff38..f0c86ccaac 100644 --- a/lib/chef/resource/rhsm_register.rb +++ b/lib/chef/resource/rhsm_register.rb @@ -36,10 +36,10 @@ class Chef description: "The FQDN of the Satellite host to register with. If not specified, the host will be registered with Red Hat's public RHSM service." property :organization, String, - description: "The organization to use when registering, required when using an activation key" + description: "The organization to use when registering, required when using an activation key." property :environment, String, - description: "The environment to use when registering, required when using username and password" + description: "The environment to use when registering, required when using username and password." property :username, String, description: "The username to use when registering. Not applicable if using an activation key. If specified, password and environment are also required." @@ -61,7 +61,7 @@ class Chef default: false, desired_state: false action :register do - description "Register the node with RHSM" + description "Register the node with RHSM." package "subscription-manager" @@ -98,7 +98,7 @@ class Chef end action :unregister do - description "Unregister the node from RHSM" + description "Unregister the node from RHSM." execute "Unregister from RHSM" do command "subscription-manager unregister" diff --git a/lib/chef/resource/rhsm_repo.rb b/lib/chef/resource/rhsm_repo.rb index 9eba096f51..54f829e79e 100644 --- a/lib/chef/resource/rhsm_repo.rb +++ b/lib/chef/resource/rhsm_repo.rb @@ -32,7 +32,7 @@ class Chef name_property: true action :enable do - description "Enable a RHSM repository" + description "Enable a RHSM repository." execute "Enable repository #{new_resource.repo_name}" do command "subscription-manager repos --enable=#{new_resource.repo_name}" @@ -42,7 +42,7 @@ class Chef end action :disable do - description "Disable a RHSM repository" + description "Disable a RHSM repository." execute "Enable repository #{new_resource.repo_name}" do command "subscription-manager repos --disable=#{new_resource.repo_name}" diff --git a/lib/chef/resource/rhsm_subscription.rb b/lib/chef/resource/rhsm_subscription.rb index 9f198dc917..1f6eb9edee 100644 --- a/lib/chef/resource/rhsm_subscription.rb +++ b/lib/chef/resource/rhsm_subscription.rb @@ -33,7 +33,7 @@ class Chef name_property: true action :attach do - description "Attach the node to a subscription pool" + description "Attach the node to a subscription pool." execute "Attach subscription pool #{new_resource.pool_id}" do command "subscription-manager attach --pool=#{new_resource.pool_id}" @@ -43,7 +43,7 @@ class Chef end action :remove do - description "Remove the node from a subscription pool" + description "Remove the node from a subscription pool." execute "Remove subscription pool #{new_resource.pool_id}" do command "subscription-manager remove --serial=#{pool_serial(new_resource.pool_id)}" diff --git a/lib/chef/resource/sudo.rb b/lib/chef/resource/sudo.rb index af26bde595..87799e5bbb 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.", name_property: true, coerce: proc { |x| x.gsub(/[\.~]/, "__") } @@ -60,11 +60,11 @@ class Chef default: "ALL" property :runas, String, - description: "User the command(s) can be run as", + description: "User the command(s) can be run as.", default: "ALL" property :nopasswd, [TrueClass, FalseClass], - description: "Allow running sudo without specifying a password sudo", + description: "Allow running sudo without specifying a password sudo.", default: false property :noexec, [TrueClass, FalseClass], @@ -83,7 +83,7 @@ class Chef default: lazy { [] } property :command_aliases, Array, - description: "Command aliases that can be used as allowed commands later in the config", + description: "Command aliases that can be used as allowed commands later in the config.", default: lazy { [] } property :setenv, [TrueClass, FalseClass], |