From 89e9fca8fd868882343928590ba564e685d1f185 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Wed, 29 Aug 2018 11:17:07 -0700 Subject: Cleanup existing property descriptions to match the docs We fixed up some wording on the docs site. This backports those fixes Signed-off-by: Tim Smith --- lib/chef/resource/openssl_dhparam.rb | 2 +- lib/chef/resource/openssl_ec_private_key.rb | 4 ++-- lib/chef/resource/openssl_ec_public_key.rb | 6 +++--- lib/chef/resource/openssl_rsa_private_key.rb | 4 ++-- lib/chef/resource/openssl_rsa_public_key.rb | 6 +++--- lib/chef/resource/openssl_x509_certificate.rb | 16 ++++++++-------- lib/chef/resource/openssl_x509_crl.rb | 2 +- lib/chef/resource/openssl_x509_request.rb | 10 +++++----- lib/chef/resource/windows_shortcut.rb | 8 ++++---- 9 files changed, 29 insertions(+), 29 deletions(-) (limited to 'lib/chef') diff --git a/lib/chef/resource/openssl_dhparam.rb b/lib/chef/resource/openssl_dhparam.rb index ae6bc9ad77..1ad49948e8 100644 --- a/lib/chef/resource/openssl_dhparam.rb +++ b/lib/chef/resource/openssl_dhparam.rb @@ -52,7 +52,7 @@ class Chef description: "The group of all files created by the resource." property :mode, [Integer, String], - description: "The permission mode of all files created by the resource.", + description: "The permission mode applied to all files created by the resource.", default: "0640" action :create do diff --git a/lib/chef/resource/openssl_ec_private_key.rb b/lib/chef/resource/openssl_ec_private_key.rb index 3da4e79fc2..b3abc34313 100644 --- a/lib/chef/resource/openssl_ec_private_key.rb +++ b/lib/chef/resource/openssl_ec_private_key.rb @@ -55,11 +55,11 @@ class Chef description: "The group of all files created by the resource." property :mode, [Integer, String], - description: "The permission mode of all files created by the resource.", + description: "The permission mode applied to all files created by the resource.", default: "0600" property :force, [TrueClass, FalseClass], - description: "Force creating the key even if the existing key exists.", + description: "Force creation of the key even if the same key already exists on the node.", default: false, desired_state: false action :create do diff --git a/lib/chef/resource/openssl_ec_public_key.rb b/lib/chef/resource/openssl_ec_public_key.rb index 50b1da337f..10f656e904 100644 --- a/lib/chef/resource/openssl_ec_public_key.rb +++ b/lib/chef/resource/openssl_ec_public_key.rb @@ -35,10 +35,10 @@ class Chef name_property: true property :private_key_path, String, - description: "The path to the private key." + description: "The path to the private key file." property :private_key_content, String, - description: "The content of the private key including new lines. Used instead of private_key_path to avoid having to first write a key to disk." + description: "The content of the private key including new lines. This property is used in place of private_key_path to avoid having to first write a key to disk." property :private_key_pass, String, description: "The passphrase of the provided private key." @@ -50,7 +50,7 @@ class Chef description: "The group of all files created by the resource." property :mode, [Integer, String], - description: "The permission mode of all files created by the resource.", + description: "The permission mode applied to all files created by the resource.", default: "0640" action :create do diff --git a/lib/chef/resource/openssl_rsa_private_key.rb b/lib/chef/resource/openssl_rsa_private_key.rb index add8587f3c..7155906fd9 100644 --- a/lib/chef/resource/openssl_rsa_private_key.rb +++ b/lib/chef/resource/openssl_rsa_private_key.rb @@ -56,11 +56,11 @@ class Chef description: "The group of all files created by the resource." property :mode, [Integer, String], - description: "The permission mode of all files created by the resource.", + description: "The permission mode applied to all files created by the resource.", default: "0600" property :force, [TrueClass, FalseClass], - description: "Force creating the key even if the existing key exists.", + description: "Force creation of the key even if the same key already exists on the node.", default: false, desired_state: false action :create do diff --git a/lib/chef/resource/openssl_rsa_public_key.rb b/lib/chef/resource/openssl_rsa_public_key.rb index 05c38d70df..e33e176e11 100644 --- a/lib/chef/resource/openssl_rsa_public_key.rb +++ b/lib/chef/resource/openssl_rsa_public_key.rb @@ -34,10 +34,10 @@ class Chef name_property: true property :private_key_path, String, - description: "The path to the private key." + description: "The path to the private key file." property :private_key_content, String, - description: "The content of the private key including new lines. Used instead of private_key_path to avoid having to first write a key to disk." + description: "The content of the private key including new lines. This property is used in place of private_key_path to avoid having to first write a key to disk." property :private_key_pass, String, description: "The passphrase of the provided private key." @@ -49,7 +49,7 @@ class Chef description: "The group of all files created by the resource." property :mode, [Integer, String], - description: "The permission mode of all files created by the resource.", + description: "The permission mode applied to all files created by the resource.", default: "0640" action :create do diff --git a/lib/chef/resource/openssl_x509_certificate.rb b/lib/chef/resource/openssl_x509_certificate.rb index da8867a2a2..c9dfeb9e68 100644 --- a/lib/chef/resource/openssl_x509_certificate.rb +++ b/lib/chef/resource/openssl_x509_certificate.rb @@ -46,10 +46,10 @@ class Chef default: 365 property :mode, [Integer, String], - description: "The permission mode of all files created by the resource." + description: "The permission mode applied to all files created by the resource." property :country, String, - description: "Value for the C ssl field." + description: "Value for the C certificate field." property :state, String, description: "Value for the ST certificate field." @@ -67,7 +67,7 @@ class Chef description: "Value for the CN certificate field." property :email, String, - description: "Value for the email ssl field." + description: "Value for the email certificate field." property :extensions, Hash, description: "Hash of X509 Extensions entries, in format { 'keyUsage' => { 'values' => %w( keyEncipherment digitalSignature), 'critical' => true } }.", @@ -78,7 +78,7 @@ class Chef default: lazy { [] } property :key_file, String, - description: "The path to a certificate key file on the filesystem. If the key_file attribute is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file attribute is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate." + description: "The path to a certificate key file on the filesystem. If the key_file property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate." property :key_pass, String, description: "The passphrase for an existing key's passphrase." @@ -90,7 +90,7 @@ class Chef property :key_length, Integer, equal_to: [1024, 2048, 4096, 8192], - description: "The desired Bit Length of the generated key (if key_type is equal to 'rsa').", + description: "The desired bit length of the generated key (if key_type is equal to 'rsa').", default: 2048 property :key_curve, String, @@ -99,13 +99,13 @@ class Chef default: "prime256v1" property :csr_file, String, - description: "The path to a X509 Certificate Request (CSR) on the filesystem. If the csr_file attribute is specified, the resource will attempt to source a CSR from this location. If no CSR file is found, the resource will generate a Self-Signed Certificate and the certificate fields must be specified (common_name at last)." + description: "The path to a X509 Certificate Request (CSR) on the filesystem. If the csr_file property is specified, the resource will attempt to source a CSR from this location. If no CSR file is found, the resource will generate a Self-Signed Certificate and the certificate fields must be specified (common_name at last)." property :ca_cert_file, String, - description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file attribute is specified, the ca_key_file attribute must also be specified, the certificate will be signed with them." + description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file property is specified, the ca_key_file property must also be specified, the certificate will be signed with them." property :ca_key_file, String, - description: "The path to the CA private key on the filesystem. If the ca_key_file attribute is specified, the `ca_cert_file' attribute must also be specified, the certificate will be signed with them." + description: "The path to the CA private key on the filesystem. If the ca_key_file property is specified, the 'ca_cert_file' property must also be specified, the certificate will be signed with them." property :ca_key_pass, String, description: "The passphrase for CA private key's passphrase." diff --git a/lib/chef/resource/openssl_x509_crl.rb b/lib/chef/resource/openssl_x509_crl.rb index 7ae5c0c5af..477d17b1b6 100644 --- a/lib/chef/resource/openssl_x509_crl.rb +++ b/lib/chef/resource/openssl_x509_crl.rb @@ -50,7 +50,7 @@ class Chef default: 1 property :ca_cert_file, String, - description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file attribute is specified, the ca_key_file attribute must also be specified, the CRL will be signed with them.", + description: "The path to the CA X509 Certificate on the filesystem. If the ca_cert_file property is specified, the ca_key_file property must also be specified, the CRL will be signed with them.", required: true property :ca_key_file, String, diff --git a/lib/chef/resource/openssl_x509_request.rb b/lib/chef/resource/openssl_x509_request.rb index ae1be2cfa5..00e8131f5c 100644 --- a/lib/chef/resource/openssl_x509_request.rb +++ b/lib/chef/resource/openssl_x509_request.rb @@ -40,10 +40,10 @@ class Chef description: "The group of all files created by the resource." property :mode, [Integer, String], - description: "The permission mode of all files created by the resource." + description: "The permission mode applied to all files created by the resource." property :country, String, - description: "Value for the C ssl field." + description: "Value for the C certificate field." property :state, String, description: "Value for the ST certificate field." @@ -62,10 +62,10 @@ class Chef description: "Value for the CN certificate field." property :email, String, - description: "Value for the email ssl field." + description: "Value for the email certificate field." property :key_file, String, - description: "The path to a certificate key file on the filesystem. If the key_file attribute is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file attribute is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate." + description: "The path to a certificate key file on the filesystem. If the key_file property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate." property :key_pass, String, description: "The passphrase for an existing key's passphrase." @@ -76,7 +76,7 @@ class Chef property :key_length, Integer, equal_to: [1024, 2048, 4096, 8192], default: 2048, - description: "The desired Bit Length of the generated key (if key_type is equal to 'rsa')." + description: "The desired bit length of the generated key (if key_type is equal to 'rsa')." property :key_curve, String, equal_to: %w{secp384r1 secp521r1 prime256v1}, default: "prime256v1", diff --git a/lib/chef/resource/windows_shortcut.rb b/lib/chef/resource/windows_shortcut.rb index 60eb9f9b24..7f7cfd3fe9 100644 --- a/lib/chef/resource/windows_shortcut.rb +++ b/lib/chef/resource/windows_shortcut.rb @@ -24,15 +24,15 @@ class Chef resource_name :windows_shortcut provides(:windows_shortcut) { true } - description "Use the windows_shortcut resource to create shortcut files on Windows" + description "Use the windows_shortcut resource to create shortcut files on Windows." introduced "14.0" property :shortcut_name, String, - description: "The name for the shortcut if it differs from the resource name.", + description: "The name for the shortcut, if it differs from the resource name.", name_property: true property :target, String, - description: "Where the shortcut links to." + description: "The destination that the shortcut links to." property :arguments, String, description: "Arguments to pass to the target when the shortcut is executed." @@ -44,7 +44,7 @@ class Chef description: "Working directory to use when the target is executed." property :iconlocation, String, - description: "Icon to use for the shortcut, in the format of 'path, index'. Index is the icon file to use. See https://msdn.microsoft.com/en-us/library/3s9bx7at.aspx for details" + description: "Icon to use for the shortcut. Accepts the format of 'path, index', where index is the icon file to use. See https://msdn.microsoft.com/en-us/library/3s9bx7at.aspx for details" load_current_value do |desired| require "win32ole" if RUBY_PLATFORM =~ /mswin|mingw32|windows/ -- cgit v1.2.1