From feb6e9c7124a928cda2dbe8597e70735407a4e65 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Mon, 26 Mar 2018 20:32:31 -0700 Subject: Add / update descriptions Use the same format that the docs team approved throughout and make a few minor changes Signed-off-by: Tim Smith --- lib/chef/resource/apt_update.rb | 3 +-- lib/chef/resource/dmg_package.rb | 4 ++-- lib/chef/resource/powershell_script.rb | 17 +++++++++-------- lib/chef/resource/rhsm_errata.rb | 2 +- lib/chef/resource/rhsm_errata_level.rb | 7 +++---- lib/chef/resource/rhsm_register.rb | 2 +- lib/chef/resource/rhsm_repo.rb | 2 +- lib/chef/resource/rhsm_subscription.rb | 2 +- 8 files changed, 19 insertions(+), 20 deletions(-) diff --git a/lib/chef/resource/apt_update.rb b/lib/chef/resource/apt_update.rb index 378edd2170..5be6dee2cf 100644 --- a/lib/chef/resource/apt_update.rb +++ b/lib/chef/resource/apt_update.rb @@ -24,8 +24,7 @@ class Chef resource_name :apt_update provides :apt_update - description "Use the apt_update resource to manage APT repository updates on"\ - " Debian and Ubuntu platforms." + description "Use the apt_update resource to manage APT repository updates on Debian and Ubuntu platforms." introduced "12.7" # allow bare apt_update with no name diff --git a/lib/chef/resource/dmg_package.rb b/lib/chef/resource/dmg_package.rb index cdfe764643..9825372070 100644 --- a/lib/chef/resource/dmg_package.rb +++ b/lib/chef/resource/dmg_package.rb @@ -23,9 +23,9 @@ class Chef 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 OS X's hdid, copy the application (.app directory)"\ + " DMG file from a remote URL, mount it using hdid, 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]." + " will be stored in the Chef::Config[:file_cache_path]." introduced "14.0" property :app, String, diff --git a/lib/chef/resource/powershell_script.rb b/lib/chef/resource/powershell_script.rb index 8ff58cfeab..99821bcefd 100644 --- a/lib/chef/resource/powershell_script.rb +++ b/lib/chef/resource/powershell_script.rb @@ -19,17 +19,18 @@ require "chef/resource/windows_script" class Chef class Resource - # Use the powershell_script resource to execute a script using the Windows PowerShell interpreter, much like how the - # script and script-based resources—bash, csh, perl, python, and ruby—are used. The powershell_script is specific to - # the Microsoft Windows platform and the Windows PowerShell interpreter. - # - # The powershell_script resource creates and executes a temporary file (similar to how the script resource behaves), - # rather than running the command inline. Commands that are executed with this resource are (by their nature) not - # idempotent, as they are typically unique to the environment in which they are run. Use not_if and only_if to guard - # this resource for idempotence. class PowershellScript < Chef::Resource::WindowsScript provides :powershell_script, os: "windows" + description "Use the powershell_script resource to execute a script using the Windows PowerShell"\ + " interpreter, much like how the script and script-based resources—bash, csh, perl, python,"\ + " and ruby—are used. The powershell_script is specific to the Microsoft Windows platform"\ + " and the Windows PowerShell interpreter.\n\n The powershell_script resource creates and"\ + " executes a temporary file (similar to how the script resource behaves), rather than running"\ + " the command inline. Commands that are executed with this resource are (by their nature) not"\ + " idempotent, as they are typically unique to the environment in which they are run. Use not_if"\ + " and only_if to guard this resource for idempotence." + def initialize(name, run_context = nil) super(name, run_context, :powershell_script, "powershell.exe") @convert_boolean_return = false diff --git a/lib/chef/resource/rhsm_errata.rb b/lib/chef/resource/rhsm_errata.rb index ca3e71648f..0af7cb724f 100644 --- a/lib/chef/resource/rhsm_errata.rb +++ b/lib/chef/resource/rhsm_errata.rb @@ -22,7 +22,7 @@ class Chef class RhsmErrata < Chef::Resource resource_name :rhsm_errata - description "A resource for installing packages associated with a given Red"\ + description "Use the rhsm_errata resource to install packages associated with a given Red"\ " Hat Subscription Manager Errata ID. This is helpful if packages"\ " to mitigate a single vulnerability must be installed on your hosts." introduced "14.0" diff --git a/lib/chef/resource/rhsm_errata_level.rb b/lib/chef/resource/rhsm_errata_level.rb index bab4d6ef26..b537686d55 100644 --- a/lib/chef/resource/rhsm_errata_level.rb +++ b/lib/chef/resource/rhsm_errata_level.rb @@ -22,10 +22,9 @@ class Chef class RhsmErrataLevel < Chef::Resource resource_name :rhsm_errata_level - description "A resource for installing all packages of a specified errata level"\ - " from the Red Hat Subscript Manager. For example, you can ensure"\ - " that all packages associated with errata marked at a 'Critical'"\ - " security level are installed." + description " Use the rhsm_errata_level resource to install all packages of a specified errata level"\ + " from the Red Hat Subscript Manager. For example, you can ensure that all packages associated"\ + " with errata marked at a 'Critical' security level are installed." introduced "14.0" property :errata_level, String, diff --git a/lib/chef/resource/rhsm_register.rb b/lib/chef/resource/rhsm_register.rb index fe2c6a2391..84bc858575 100644 --- a/lib/chef/resource/rhsm_register.rb +++ b/lib/chef/resource/rhsm_register.rb @@ -23,7 +23,7 @@ class Chef class RhsmRegister < Chef::Resource resource_name :rhsm_register - description "A resource for registering a node with the Red Hat Subscription Manager"\ + description "Use the rhsm_register resource to register a node with the Red Hat Subscription Manager"\ " or a local Red Hat Satellite server." introduced "14.0" diff --git a/lib/chef/resource/rhsm_repo.rb b/lib/chef/resource/rhsm_repo.rb index 689874a774..681fffc606 100644 --- a/lib/chef/resource/rhsm_repo.rb +++ b/lib/chef/resource/rhsm_repo.rb @@ -22,7 +22,7 @@ class Chef class RhsmRepo < Chef::Resource resource_name :rhsm_repo - description "A resource for enabling and disabling Red Hat Subscription Manager"\ + description "Use the rhsm_repo resource to enable or disable Red Hat Subscription Manager"\ " repositories that are made available via attached subscriptions." introduced "14.0" diff --git a/lib/chef/resource/rhsm_subscription.rb b/lib/chef/resource/rhsm_subscription.rb index 21ee539dda..60ea7a7dd8 100644 --- a/lib/chef/resource/rhsm_subscription.rb +++ b/lib/chef/resource/rhsm_subscription.rb @@ -22,7 +22,7 @@ class Chef class RhsmSubscription < Chef::Resource resource_name :rhsm_subscription - description "A resource for adding additional Redhat Subscription Manager subscriptions"\ + 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"\ " does not attach all necessary subscriptions to your host." introduced "14.0" -- cgit v1.2.1