summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-08-30 20:56:18 -0700
committerTim Smith <tsmith@chef.io>2018-08-31 17:17:24 -0700
commite16b9463c221f4e4a10c8eda7ec8ad034254c2fd (patch)
treee5de88f8def3cba4abff88a8bab8bf5888fde55f
parented10614c70131524e70ebd4d3d23b0749b587356 (diff)
downloadchef-e16b9463c221f4e4a10c8eda7ec8ad034254c2fd.tar.gz
Update descriptions in more windows resources
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/windows_env.rb4
-rw-r--r--lib/chef/resource/windows_feature_dism.rb9
-rw-r--r--lib/chef/resource/windows_package.rb3
-rw-r--r--lib/chef/resource/windows_task.rb3
-rw-r--r--lib/chef/resource/zypper_package.rb3
5 files changed, 8 insertions, 14 deletions
diff --git a/lib/chef/resource/windows_env.rb b/lib/chef/resource/windows_env.rb
index 3f1c13ecef..781a09fed7 100644
--- a/lib/chef/resource/windows_env.rb
+++ b/lib/chef/resource/windows_env.rb
@@ -26,9 +26,7 @@ class Chef
provides :windows_env
provides :env # backwards compat with the pre-Chef 14 resource name
- description "Use the 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 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."
default_action :create
allowed_actions :create, :delete, :modify
diff --git a/lib/chef/resource/windows_feature_dism.rb b/lib/chef/resource/windows_feature_dism.rb
index c5bdc6fdfa..ce818f494e 100644
--- a/lib/chef/resource/windows_feature_dism.rb
+++ b/lib/chef/resource/windows_feature_dism.rb
@@ -25,20 +25,19 @@ class Chef
resource_name :windows_feature_dism
provides(:windows_feature_dism) { true }
- description "Using the windows_feature_dism resource to add, remove or"\
- " delete Windows features and roles using DISM"
+ description "Use the windows_feature_dism resource to add, remove or delete Windows features and roles using DISM"
introduced "14.0"
property :feature_name, [Array, String],
- description: "The name of the feature/role(s) to install if it differs from the resource name.",
+ description: "The name of the feature(s) or role(s) to install, if it differs from the resource name.",
coerce: proc { |x| to_formatted_array(x) },
name_property: true
property :source, String,
- description: "Use a local repository for the feature install."
+ description: "Specify a local repository for the feature install."
property :all, [TrueClass, FalseClass],
- description: "Install all sub features. This is the equivalent of specifying the /All switch to dism.exe",
+ description: "Install all sub-features. When set to 'true', this is the equivalent of specifying the /All switch to dism.exe",
default: false
property :timeout, Integer,
diff --git a/lib/chef/resource/windows_package.rb b/lib/chef/resource/windows_package.rb
index 49496aed9a..9bfa51b9fd 100644
--- a/lib/chef/resource/windows_package.rb
+++ b/lib/chef/resource/windows_package.rb
@@ -30,8 +30,7 @@ class Chef
provides(:windows_package) { true }
provides :package, os: "windows"
- description "Use the windows_package resource to manage Microsoft Installer Package"\
- " (MSI) packages for the Microsoft Windows platform."
+ description "Use the windows_package resource to manage Microsoft Installer Package (MSI) packages for the Microsoft Windows platform."
introduced "11.12"
allowed_actions :install, :remove
diff --git a/lib/chef/resource/windows_task.rb b/lib/chef/resource/windows_task.rb
index a8bae8430e..0232fe3064 100644
--- a/lib/chef/resource/windows_task.rb
+++ b/lib/chef/resource/windows_task.rb
@@ -24,8 +24,7 @@ class Chef
resource_name :windows_task
provides(:windows_task) { true }
- description "Use the windows_task resource to create, delete or run a Windows"\
- " scheduled task. Requires Windows Server 2008 or later due to API usage."
+ description "Use the windows_task resource to create, delete or run a Windows scheduled task. Requires Windows Server 2008 or later due to API usage."
introduced "13.0"
allowed_actions :create, :delete, :run, :end, :enable, :disable, :change
diff --git a/lib/chef/resource/zypper_package.rb b/lib/chef/resource/zypper_package.rb
index 920a803b14..b04668472f 100644
--- a/lib/chef/resource/zypper_package.rb
+++ b/lib/chef/resource/zypper_package.rb
@@ -25,8 +25,7 @@ class Chef
resource_name :zypper_package
provides :package, platform_family: "suse"
- description "Use the zypper_package resource to install, upgrade, and remove"\
- " packages with Zypper for the SUSE Enterprise and OpenSUSE platforms."
+ description "Use the zypper_package resource to install, upgrade, and remove packages with Zypper for the SUSE Enterprise and OpenSUSE platforms."
property :gpg_check, [ TrueClass, FalseClass ],
description: "Verify the package's GPG signature",