summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2020-04-29 16:20:23 -0700
committerTim Smith <tsmith84@gmail.com>2020-04-29 16:20:31 -0700
commit345f533a83ea3c40cb1f0517403abce19b35eae3 (patch)
tree947f1b3dd2d3734418bda118186d9462ff0554c5
parent935ff283e56a59d72c3e4f23224dbbf4af252da9 (diff)
downloadchef-345f533a83ea3c40cb1f0517403abce19b35eae3.tar.gz
More resource formatting fixes
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/cron.rb12
-rw-r--r--lib/chef/resource/cron_d.rb18
-rw-r--r--lib/chef/resource/dmg_package.rb22
3 files changed, 26 insertions, 26 deletions
diff --git a/lib/chef/resource/cron.rb b/lib/chef/resource/cron.rb
index d010cfc9bf..a274bbeefe 100644
--- a/lib/chef/resource/cron.rb
+++ b/lib/chef/resource/cron.rb
@@ -93,16 +93,16 @@ class Chef
equal_to: Chef::Provider::Cron::SPECIAL_TIME_VALUES
property :mailto, String,
- description: "Set the MAILTO environment variable."
+ description: "Set the `MAILTO` environment variable."
property :path, String,
- description: "Set the PATH environment variable."
+ description: "Set the `PATH` environment variable."
property :home, String,
- description: "Set the HOME environment variable."
+ description: "Set the `HOME` environment variable."
property :shell, String,
- description: "Set the SHELL environment variable."
+ description: "Set the `SHELL` environment variable."
property :command, String,
description: "The command to be run, or the path to a file that contains the command to be run.",
@@ -113,14 +113,14 @@ class Chef
default: "root"
property :environment, Hash,
- description: "A Hash of environment variables in the form of ({'ENV_VARIABLE' => 'VALUE'}).",
+ description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.",
default: lazy { {} }
TIMEOUT_OPTS = %w{duration preserve-status foreground kill-after signal}.freeze
TIMEOUT_REGEX = /\A\S+/.freeze
property :time_out, Hash,
- description: "A Hash of timeouts in the form of ({'OPTION' => 'VALUE'}).
+ description: "A Hash of timeouts in the form of `({'OPTION' => 'VALUE'})`.
Accepted valid options are:
preserve-status (BOOL, default: 'false'),
foreground (BOOL, default: 'false'),
diff --git a/lib/chef/resource/cron_d.rb b/lib/chef/resource/cron_d.rb
index 03ce19708f..94e855e51f 100644
--- a/lib/chef/resource/cron_d.rb
+++ b/lib/chef/resource/cron_d.rb
@@ -27,7 +27,7 @@ class Chef
provides :cron_d
introduced "14.4"
- description "Use the cron_d resource to manage cron definitions in /etc/cron.d. This is similar to the 'cron' resource, but it does not use the monolithic /etc/crontab file."
+ description "Use the cron_d resource to manage cron job files in the /etc/cron.d directory. This is similar to the 'cron' resource, but it does not use the monolithic /etc/crontab file."
examples <<~DOC
To run a program on the fifth hour of the day
```ruby
@@ -78,7 +78,7 @@ class Chef
description: "An optional property to set the cron name if it differs from the resource block's name.",
name_property: true
- property :cookbook, String, desired_state: false
+ property :cookbook, String, desired_state: false, skip_docs: true
property :predefined_value, String,
description: "Schedule your cron job with one of the special predefined value instead of ** * pattern.",
@@ -123,29 +123,29 @@ class Chef
default: "root"
property :mailto, String,
- description: "Set the MAILTO environment variable in the cron.d file."
+ description: "Set the `MAILTO` environment variable in the cron.d file."
property :path, String,
- description: "Set the PATH environment variable in the cron.d file."
+ description: "Set the `PATH` environment variable in the cron.d file."
property :home, String,
- description: "Set the HOME environment variable in the cron.d file."
+ description: "Set the `HOME` environment variable in the cron.d file."
property :shell, String,
- description: "Set the SHELL environment variable in the cron.d file."
+ description: "Set the `SHELL` environment variable in the cron.d file."
property :comment, String,
description: "A comment to place in the cron.d file."
property :environment, Hash,
- description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of ``({'ENV_VARIABLE' => 'VALUE'})``.",
+ description: "A Hash containing additional arbitrary environment variables under which the cron job will be run in the form of `({'ENV_VARIABLE' => 'VALUE'})`.",
default: lazy { {} }
TIMEOUT_OPTS = %w{duration preserve-status foreground kill-after signal}.freeze
TIMEOUT_REGEX = /\A\S+/.freeze
property :time_out, Hash,
- description: "A Hash of timeouts in the form of ({'OPTION' => 'VALUE'}).
+ description: "A Hash of timeouts in the form of `({'OPTION' => 'VALUE'})`.
Accepted valid options are:
preserve-status (BOOL, default: 'false'),
foreground (BOOL, default: 'false'),
@@ -175,7 +175,7 @@ class Chef
default: "0600"
property :random_delay, Integer,
- description: "Set the RANDOM_DELAY environment variable in the cron.d file."
+ description: "Set the `RANDOM_DELAY` environment variable in the cron.d file."
# warn if someone passes the deprecated cookbook property
def after_created
diff --git a/lib/chef/resource/dmg_package.rb b/lib/chef/resource/dmg_package.rb
index a5d331c24c..14b16a9284 100644
--- a/lib/chef/resource/dmg_package.rb
+++ b/lib/chef/resource/dmg_package.rb
@@ -56,31 +56,31 @@ class Chef
DOC
property :app, String,
- description: "The name of the application as it appears in the /Volumes directory if it differs from the resource block's name.",
+ description: "The name of the application as it appears in the `/Volumes` directory if it differs from the resource block's name.",
name_property: true
property :source, String,
- description: "The remote URL that is used to download the .dmg file, if specified."
+ description: "The remote URL that is used to download the `.dmg` file, if specified."
property :file, String,
- description: "The full path to the .dmg file on the local system."
+ description: "The full path to the `.dmg` file on the local system."
property :owner, [String, Integer],
description: "The user that should own the package installation."
property :destination, String,
- description: "The directory to copy the .app into.",
+ description: "The directory to copy the `.app` into.",
default: "/Applications"
property :checksum, String,
- description: "The sha256 checksum of the .dmg file to download."
+ description: "The sha256 checksum of the `.dmg` file to download."
property :volumes_dir, String,
- description: "The directory under /Volumes where the dmg is mounted if it differs from the name of the .dmg file.",
+ description: "The directory under `/Volumes` where the `dmg` is mounted if it differs from the name of the `.dmg` file.",
default: lazy { app }, default_description: "The value passed for the application name."
property :dmg_name, String,
- description: "The name of the .dmg file if it differs from that of the app, or if the name has spaces.",
+ description: "The name of the `.dmg` file if it differs from that of the app, or if the name has spaces.",
desired_state: false,
default: lazy { app }, default_description: "The value passed for the application name."
@@ -90,18 +90,18 @@ class Chef
default: "app", desired_state: false
property :package_id, String,
- description: "The package ID that is registered with pkgutil when a pkg or mpkg is installed."
+ description: "The package ID that is registered with `pkgutil` when a `pkg` or `mpkg` is installed."
property :dmg_passphrase, String,
- description: "Specify a passphrase to be used to decrypt the .dmg file during the mount process.",
+ description: "Specify a passphrase to be used to decrypt the `.dmg` file during the mount process.",
desired_state: false
property :accept_eula, [TrueClass, FalseClass],
- description: "Specify whether to accept the EULA. Certain dmgs require acceptance of EULA before mounting.",
+ description: "Specify whether to accept the EULA. Certain dmg files require acceptance of EULA before mounting.",
default: false, desired_state: false
property :headers, Hash,
- description: "Allows custom HTTP headers (like cookies) to be set on the remote_file resource.",
+ description: "Allows custom HTTP headers (like cookies) to be set on the `remote_file` resource.",
desired_state: false
property :allow_untrusted, [TrueClass, FalseClass],