summaryrefslogtreecommitdiff
path: root/lib/chef
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-03-27 09:40:18 -0700
committerTim Smith <tsmith@chef.io>2018-03-27 09:40:37 -0700
commit07d83384b60d973b1245baf5b0a8817465e13fd1 (patch)
treeda3bc1fe6d8e3b32e454d05aed8067dbe347ea18 /lib/chef
parent753e67a25421c03d82979449b62006aa72486c1d (diff)
downloadchef-07d83384b60d973b1245baf5b0a8817465e13fd1.tar.gz
Update release notes and resources to match
Fixed the resoruce docs while I was in there. Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef')
-rw-r--r--lib/chef/resource/dmg_package.rb4
-rw-r--r--lib/chef/resource/macos_userdefaults.rb7
-rw-r--r--lib/chef/resource/rhsm_subscription.rb4
-rw-r--r--lib/chef/resource/sudo.rb8
-rw-r--r--lib/chef/resource/swap_file.rb2
-rw-r--r--lib/chef/resource/windows_feature.rb4
-rw-r--r--lib/chef/resource/windows_font.rb2
7 files changed, 16 insertions, 15 deletions
diff --git a/lib/chef/resource/dmg_package.rb b/lib/chef/resource/dmg_package.rb
index 9825372070..f825db804e 100644
--- a/lib/chef/resource/dmg_package.rb
+++ b/lib/chef/resource/dmg_package.rb
@@ -22,8 +22,8 @@ class Chef
class DmgPackage < Chef::Resource
resource_name :dmg_package
- description "Use the dmg_package resourceto install a DMG 'Package'. The resource will retrieve the"\
- " DMG file from a remote URL, mount it using hdid, copy the application (.app directory)"\
+ description "Use the dmg_package resource to install a dmg 'package'. The resource will retrieve the"\
+ " dmg file from a remote URL, mount it using OS X's hdidutil, copy the application (.app directory)"\
" to the specified destination (/Applications), and detach the image using hdiutil. The dmg file"\
" will be stored in the Chef::Config[:file_cache_path]."
introduced "14.0"
diff --git a/lib/chef/resource/macos_userdefaults.rb b/lib/chef/resource/macos_userdefaults.rb
index 45be356d1b..abdf08c1d4 100644
--- a/lib/chef/resource/macos_userdefaults.rb
+++ b/lib/chef/resource/macos_userdefaults.rb
@@ -25,10 +25,9 @@ class Chef
provides :mac_os_x_userdefaults
provides :macos_userdefaults
- description "Use the macos_userdefaults resource to manage the macOS user defaults"\
- " system. The properties to the resource are passed to the defaults command"\
- " and the parameters follow convention of the macOS command. See the defaults(1)"\
- " man page for details on how the tool works."
+ description "Use the macos_userdefaults resource to manage the macOS user defaults system. The properties"\
+ " of this resource are passed to the defaults command, and the parameters follow the convention"\
+ " of that command. See the defaults(1) man page for details on how the tool works."
introduced "14.0"
property :domain, String,
diff --git a/lib/chef/resource/rhsm_subscription.rb b/lib/chef/resource/rhsm_subscription.rb
index 60ea7a7dd8..4fad8fa650 100644
--- a/lib/chef/resource/rhsm_subscription.rb
+++ b/lib/chef/resource/rhsm_subscription.rb
@@ -22,8 +22,8 @@ class Chef
class RhsmSubscription < Chef::Resource
resource_name :rhsm_subscription
- description "Use tthe rhsm_subscription resource to add additional Redhat Subscription Manager subscriptions"\
- " to your host. This can be used when a host's activation_key"\
+ description "Use the rhsm_subscription resource to add or remove Red Hat Subscription Manager"\
+ " subscriptions from your host. This can be used when a host's activation_key"\
" does not attach all necessary subscriptions to your host."
introduced "14.0"
diff --git a/lib/chef/resource/sudo.rb b/lib/chef/resource/sudo.rb
index ec60b419a4..a2e5d21515 100644
--- a/lib/chef/resource/sudo.rb
+++ b/lib/chef/resource/sudo.rb
@@ -28,10 +28,10 @@ class Chef
provides "sudo"
description "Use the sudo resource to add or remove individual sudo entries using sudoers.d files."\
- " Sudo version 1.7.2 or newer is required to use the sudo resource as it relies on the"\
- " '#includedir' directive introduced in version 1.7.2. The resource does not enforce"\
- " installing the version. Supported releases of Ubuntu, Debian and RHEL (6+) all support"\
- " this feature."
+ " Sudo version 1.7.2 or newer is required to use the sudo resource, as it relies on the"\
+ " '#includedir' directive introduced in version 1.7.2. This resource does not enforce"\
+ " installation of the required sudo version. Supported releases of Ubuntu, SuSE, Debian,"\
+ " and RHEL (6+) all support this feature."
introduced "14.0"
# acording to the sudo man pages sudo will ignore files in an include dir that have a `.` or `~`
diff --git a/lib/chef/resource/swap_file.rb b/lib/chef/resource/swap_file.rb
index 6beb20c976..6bb29515ae 100644
--- a/lib/chef/resource/swap_file.rb
+++ b/lib/chef/resource/swap_file.rb
@@ -23,7 +23,7 @@ class Chef
resource_name :swap_file
provides :swap_file
- description "Use the swap_file resource to create or delete swap files on Linux systems."
+ description "Use the swap_file resource to create or delete swap files on Linux systems, and optionally to manage the swappiness configuration for a host."
introduced "14.0"
property :path, String,
diff --git a/lib/chef/resource/windows_feature.rb b/lib/chef/resource/windows_feature.rb
index 84778e2bcb..d7bb1180c4 100644
--- a/lib/chef/resource/windows_feature.rb
+++ b/lib/chef/resource/windows_feature.rb
@@ -24,7 +24,9 @@ class Chef
resource_name :windows_feature
provides :windows_feature
- description "Using the windows_feature resource to add, remove or delete Windows features and roles"
+ description "Use the windows_feature resource to add, remove or delete Windows features and roles. This resource calls"\
+ " the 'windows_feature_dism' or 'windows_feature_powershell' resources depending on the specified installation"\
+ " method and defaults to dism, which is available on both Workstation and Server editions of Windows."
introduced "14.0"
property :feature_name, [Array, String],
diff --git a/lib/chef/resource/windows_font.rb b/lib/chef/resource/windows_font.rb
index 7ff098cc88..6f82e3cd8f 100644
--- a/lib/chef/resource/windows_font.rb
+++ b/lib/chef/resource/windows_font.rb
@@ -26,7 +26,7 @@ class Chef
provides :windows_font
description "Use the windows_font resource to install or remove font files on Windows."\
- " Sources the font by default from the cookbook using the resource, but a URI"\
+ " By default, the font is sourced from the cookbook using the resource, but a URI"\
" source can be specified as well."
introduced "14.0"