summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-10-29 22:13:53 -0700
committerTim Smith <tsmith@chef.io>2018-10-31 12:46:50 -0700
commite1ca9756ab7da9233f539ab1236a5c5b4aa6e5bb (patch)
tree10c9a0f846952ab636ebb1abbb713a8d234b8587
parente6a1cc4028c77684b7954ccb2e59106f64afc400 (diff)
downloadchef-e1ca9756ab7da9233f539ab1236a5c5b4aa6e5bb.tar.gz
Description fixes from review
Thanks @stuartpreston Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/windows_certificate.rb2
-rw-r--r--lib/chef/resource/windows_share.rb10
2 files changed, 6 insertions, 6 deletions
diff --git a/lib/chef/resource/windows_certificate.rb b/lib/chef/resource/windows_certificate.rb
index 6c35eb7c96..f97093cb47 100644
--- a/lib/chef/resource/windows_certificate.rb
+++ b/lib/chef/resource/windows_certificate.rb
@@ -27,7 +27,7 @@ class Chef
preview_resource true
resource_name :windows_certificate
- description "The the windows_certificate resource to install a certificate into the Windows certificate store from a file. The resource grants read-only access to the private key for designated accounts. Due to current limitations in WinRM, installing certificated remotely may not work if the operation requires a user profile. Operations on the local machine store should still work."
+ description "Use the windows_certificate resource to install a certificate into the Windows certificate store from a file. The resource grants read-only access to the private key for designated accounts. Due to current limitations in WinRM, installing certificates remotely may not work if the operation requires a user profile. Operations on the local machine store should still work."
introduced "14.6"
property :source, String,
diff --git a/lib/chef/resource/windows_share.rb b/lib/chef/resource/windows_share.rb
index 1f39130fbb..fd04b218b1 100644
--- a/lib/chef/resource/windows_share.rb
+++ b/lib/chef/resource/windows_share.rb
@@ -33,12 +33,12 @@ class Chef
# Specifies a name for the SMB share. The name may be composed of any valid file name characters, but must be less than 80 characters long. The names pipe and mailslot are reserved for use by the computer.
property :share_name, String,
- description: "The share to assign to the share.",
+ description: "The name to assign to the share.",
name_property: true
# Specifies the path of the location of the folder to share. The path must be fully qualified. Relative paths or paths that contain wildcard characters are not permitted.
property :path, String,
- description: "The path of the location of the folder to share. Required when creating. If the share already exists on a different path then it is deleted and re-created."
+ description: "The path of the folder to share. Required when creating. If the share already exists on a different path then it is deleted and re-created."
# Specifies an optional description of the SMB share. A description of the share is displayed by running the Get-SmbShare cmdlet. The description may not contain more than 256 characters.
property :description, String,
@@ -47,17 +47,17 @@ class Chef
# Specifies which accounts are granted full permission to access the share. Use a comma-separated list to specify multiple accounts. An account may not be specified more than once in the FullAccess, ChangeAccess, or ReadAccess parameter lists, but may be specified once in the FullAccess, ChangeAccess, or ReadAccess parameter list and once in the NoAccess parameter list.
property :full_users, Array,
- description: "The users which should have 'Full control' permissions on the share..",
+ description: "The users that should have 'Full control' permissions on the share in domain\username format.",
default: [], coerce: proc { |u| u.sort }
# Specifies which users are granted modify permission to access the share
property :change_users, Array,
- description: "The users which should have 'modify' permission on the share.",
+ description: "The users that should have 'modify' permission on the share in domain\username format".",
default: [], coerce: proc { |u| u.sort }
# Specifies which users are granted read permission to access the share. Multiple users can be specified by supplying a comma-separated list.
property :read_users, Array,
- description: "The users which should have 'read' permission on the share.",
+ description: "The users that should have 'read' permission on the share in domain\username format".",
default: [], coerce: proc { |u| u.sort }
# Specifies the lifetime of the new SMB share. A temporary share does not persist beyond the next restart of the computer. By default, new SMB shares are persistent, and non-temporary.