summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2020-04-23 23:39:57 -0700
committerPete Higgins <pete@peterhiggins.org>2020-04-27 11:42:16 -0700
commit3429aa7a12b56e567a2cff4ae62bba0332ba8d69 (patch)
treee6ecd2dbc5dff3332817d74a897422facbad5bc9
parent013c4cc4d5c97c88bf62162b87bd3d9f8908dc58 (diff)
downloadchef-3429aa7a12b56e567a2cff4ae62bba0332ba8d69.tar.gz
Add some missing default descriptions
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/chef_client_cron.rb3
-rw-r--r--lib/chef/resource/chef_client_scheduled_task.rb5
-rw-r--r--lib/chef/resource/chef_client_systemd_timer.rb2
3 files changed, 6 insertions, 4 deletions
diff --git a/lib/chef/resource/chef_client_cron.rb b/lib/chef/resource/chef_client_cron.rb
index 99207a28be..7f4b036b88 100644
--- a/lib/chef/resource/chef_client_cron.rb
+++ b/lib/chef/resource/chef_client_cron.rb
@@ -103,7 +103,7 @@ class Chef
description: "The e-mail address to e-mail any cron task failures to."
property :accept_chef_license, [true, false],
- description: "Accept the Chef Online Master License and Services Agreement. See https://www.chef.io/online-master-agreement/",
+ description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
default: false
property :config_directory, String,
@@ -112,6 +112,7 @@ class Chef
property :log_directory, String,
default: lazy { platform?("mac_os_x") ? "/Library/Logs/#{Chef::Dist::DIR_SUFFIX.capitalize}" : "/var/log/#{Chef::Dist::DIR_SUFFIX}" },
+ default_description: "/Library/Logs/#{Chef::Dist::DIR_SUFFIX.capitalize} on macOS and /var/log/#{Chef::Dist::DIR_SUFFIX} otherwise",
description: "The path of the directory to create the log file in."
property :log_file_name, String,
diff --git a/lib/chef/resource/chef_client_scheduled_task.rb b/lib/chef/resource/chef_client_scheduled_task.rb
index 1e500b4aa7..2479e5bc5a 100644
--- a/lib/chef/resource/chef_client_scheduled_task.rb
+++ b/lib/chef/resource/chef_client_scheduled_task.rb
@@ -72,7 +72,7 @@ class Chef
default: 30
property :accept_chef_license, [true, false],
- description: "Accept the Chef Online Master License and Services Agreement. See https://www.chef.io/online-master-agreement/",
+ description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
default: false
property :start_date, String,
@@ -99,7 +99,8 @@ class Chef
property :log_directory, String,
description: "The path of the directory to create the log file in.",
- default: lazy { |r| "#{r.config_directory}/log" }
+ default: lazy { |r| "#{r.config_directory}/log" },
+ default_description: "CONFIG_DIRECTORY/log"
property :log_file_name, String,
description: "The name of the log file to use.",
diff --git a/lib/chef/resource/chef_client_systemd_timer.rb b/lib/chef/resource/chef_client_systemd_timer.rb
index 9b16057c89..a1d26758de 100644
--- a/lib/chef/resource/chef_client_systemd_timer.rb
+++ b/lib/chef/resource/chef_client_systemd_timer.rb
@@ -72,7 +72,7 @@ class Chef
default: "5min"
property :accept_chef_license, [true, false],
- description: "Accept the Chef Online Master License and Services Agreement. See https://www.chef.io/online-master-agreement/",
+ description: "Accept the Chef Online Master License and Services Agreement. See <https://www.chef.io/online-master-agreement/>",
default: false
property :run_on_battery, [true, false],