diff options
| -rw-r--r-- | lib/chef/resource/apt_preference.rb | 4 | ||||
| -rw-r--r-- | lib/chef/resource/apt_repository.rb | 8 | ||||
| -rw-r--r-- | lib/chef/resource/apt_update.rb | 3 | ||||
| -rw-r--r-- | lib/chef/resource/bash.rb | 7 | ||||
| -rw-r--r-- | lib/chef/resource/batch.rb | 8 | ||||
| -rw-r--r-- | lib/chef/resource/bff_package.rb | 5 | ||||
| -rw-r--r-- | lib/chef/resource/breakpoint.rb | 8 | ||||
| -rw-r--r-- | lib/chef/resource/build_essential.rb | 2 | ||||
| -rw-r--r-- | lib/chef/resource/cookbook_file.rb | 2 |
9 files changed, 13 insertions, 34 deletions
diff --git a/lib/chef/resource/apt_preference.rb b/lib/chef/resource/apt_preference.rb index e546a54225..0169fb73c2 100644 --- a/lib/chef/resource/apt_preference.rb +++ b/lib/chef/resource/apt_preference.rb @@ -25,9 +25,7 @@ class Chef resource_name :apt_preference provides(:apt_preference) { true } - description "The apt_preference resource allows for the creation of APT preference"\ - " files. Preference files are used to control which package versions and"\ - " sources are prioritized during installation." + description "The apt_preference resource allows for the creation of APT preference files. Preference files are used to control which package versions and sources are prioritized during installation." introduced "13.3" property :package_name, String, diff --git a/lib/chef/resource/apt_repository.rb b/lib/chef/resource/apt_repository.rb index 26223aa4a1..0ed38e61d3 100644 --- a/lib/chef/resource/apt_repository.rb +++ b/lib/chef/resource/apt_repository.rb @@ -24,7 +24,7 @@ class Chef resource_name :apt_repository provides(:apt_repository) { true } - description "Use the apt_repository resource to specify additional APT repositories. Adding a new repository will update APT package cache immediately." + description "Use the apt_repository resource to specify additional APT repositories. Adding a new repository will update the APT package cache immediately." introduced "12.9" # There's a pile of [ String, nil, FalseClass ] types in these properties. @@ -50,14 +50,14 @@ class Chef default: lazy { [] } property :arch, [String, nil, FalseClass], - description: "Constrain packages to a particular CPU architecture such as 'i386' or 'amd64'" + description: "Constrain packages to a particular CPU architecture such as 'i386' or 'amd64'." property :trusted, [TrueClass, FalseClass], - description: "Determines whether you should treat all packages from this repository as authenticated regardless of signature", + description: "Determines whether you should treat all packages from this repository as authenticated regardless of signature.", default: false property :deb_src, [TrueClass, FalseClass], - description: "Determines whether or not to add the repository as a source repo as well", + description: "Determines whether or not to add the repository as a source repo as well.", default: false property :keyserver, [String, nil, FalseClass], diff --git a/lib/chef/resource/apt_update.rb b/lib/chef/resource/apt_update.rb index d54ffff1de..04a9407813 100644 --- a/lib/chef/resource/apt_update.rb +++ b/lib/chef/resource/apt_update.rb @@ -30,7 +30,8 @@ class Chef # allow bare apt_update with no name property :name, String, default: "" property :frequency, Integer, - description: "Determines how frequently (in seconds) APT repository updates are made. Use this property when the :periodic action is specified.", default: 86_400 + description: "Determines how frequently (in seconds) APT repository updates are made. Use this property when the :periodic action is specified.", + default: 86_400 default_action :periodic allowed_actions :update, :periodic diff --git a/lib/chef/resource/bash.rb b/lib/chef/resource/bash.rb index 03fdd0e396..22a84f4134 100644 --- a/lib/chef/resource/bash.rb +++ b/lib/chef/resource/bash.rb @@ -22,12 +22,7 @@ require "chef/provider/script" class Chef class Resource class Bash < Chef::Resource::Script - description "Use the bash resource to execute scripts using the Bash interpreter."\ - " This resource may also use any of the actions and properties that are"\ - " available to the execute resource. 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." + description "Use the bash resource to execute scripts using the Bash interpreter. This resource may also use any of the actions and properties that are available to the execute resource. 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 diff --git a/lib/chef/resource/batch.rb b/lib/chef/resource/batch.rb index 4e6d67aa2d..e3bff8145c 100644 --- a/lib/chef/resource/batch.rb +++ b/lib/chef/resource/batch.rb @@ -23,13 +23,7 @@ class Chef class Batch < Chef::Resource::WindowsScript provides :batch - description "Use the batch resource to execute a batch script using the cmd.exe"\ - " interpreter on Windows. The batch 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." + description "Use the batch resource to execute a batch script using the cmd.exe interpreter on Windows. The batch 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, nil, "cmd.exe") diff --git a/lib/chef/resource/bff_package.rb b/lib/chef/resource/bff_package.rb index 62838cfd60..8750cb0b2b 100644 --- a/lib/chef/resource/bff_package.rb +++ b/lib/chef/resource/bff_package.rb @@ -24,10 +24,7 @@ class Chef resource_name :bff_package provides :bff_package - description "Use the bff_package resource to manage packages for the AIX platform"\ - " using the installp utility. When a package is installed from a local"\ - " file, it must be added to the node using the remote_file or cookbook_file"\ - " resources." + description "Use the bff_package resource to manage packages for the AIX platform using the installp utility. When a package is installed from a local file, it must be added to the node using the remote_file or cookbook_file resources." introduced "12.0" end end diff --git a/lib/chef/resource/breakpoint.rb b/lib/chef/resource/breakpoint.rb index 1ccc4311b3..8af3edbe22 100644 --- a/lib/chef/resource/breakpoint.rb +++ b/lib/chef/resource/breakpoint.rb @@ -24,13 +24,7 @@ class Chef provides :breakpoint resource_name :breakpoint - description "Use the breakpoint resource to add breakpoints to recipes. Run the"\ - " chef-shell in chef-client mode, and then use those breakpoints to debug"\ - " recipes. Breakpoints are ignored by the chef-client during an actual"\ - " chef-client run. That said, breakpoints are typically used to debug"\ - " recipes only when running them in a non-production environment, after"\ - " which they are removed from those recipes before the parent cookbook is"\ - " uploaded to the Chef server." + description "Use the breakpoint resource to add breakpoints to recipes. Run the chef-shell in chef-client mode, and then use those breakpoints to debug recipes. Breakpoints are ignored by the chef-client during an actual chef-client run. That said, breakpoints are typically used to debug recipes only when running them in a non-production environment, after which they are removed from those recipes before the parent cookbook is uploaded to the Chef server." introduced "12.0" default_action :break diff --git a/lib/chef/resource/build_essential.rb b/lib/chef/resource/build_essential.rb index 8d32af9684..716f9e91b7 100644 --- a/lib/chef/resource/build_essential.rb +++ b/lib/chef/resource/build_essential.rb @@ -22,7 +22,7 @@ class Chef resource_name :build_essential provides(:build_essential) { true } - description "Use the build_essential resource to install packages required for compiling C software from source" + description "Use the build_essential resource to install packages required for compiling C software from source." introduced "14.0" property :compile_time, [TrueClass, FalseClass], diff --git a/lib/chef/resource/cookbook_file.rb b/lib/chef/resource/cookbook_file.rb index f398165064..0caa9d0553 100644 --- a/lib/chef/resource/cookbook_file.rb +++ b/lib/chef/resource/cookbook_file.rb @@ -32,7 +32,7 @@ class Chef description "Use the cookbook_file resource to transfer files from a sub-directory of COOKBOOK_NAME/files/ to a specified path located on a host that is running the chef-client. The file is selected according to file specificity, which allows different source files to be used based on the hostname, host platform (operating system, distro, or as appropriate), or platform version. Files that are located in the COOKBOOK_NAME/files/default sub-directory may be used on any platform.\n\nDuring a chef-client run, the checksum for each local file is calculated and then compared against the checksum for the same file as it currently exists in the cookbook on the Chef server. A file is not transferred when the checksums match. Only files that require an update are transferred from the Chef server to a node." property :source, [ String, Array ], - description: "The name of the file in COOKBOOK_NAME/files/default or the path to a file located in COOKBOOK_NAME/files. The path must include the file name and its extension. This can be used to distribute specific files depending upon the platform used", + description: "The name of the file in COOKBOOK_NAME/files/default or the path to a file located in COOKBOOK_NAME/files. The path must include the file name and its extension. This can be used to distribute specific files depending upon the platform used.", default: lazy { ::File.basename(name) } property :cookbook, String, |