summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-07-15 08:58:06 -0700
committerTim Smith <tsmith@chef.io>2018-07-15 08:58:06 -0700
commita10a2a229642bb104ade0b0aa8504758a9c8b7bb (patch)
tree87a33e81d4f4e465480cf04d71aa470194238bbb
parent6f670e5b39319ff3e7c5fd06750c8dfc5221449c (diff)
downloadchef-knife_sentences.tar.gz
Make sure knife descriptions all have periodsknife_sentences
Some did. Some didn't. Looks weird that way. Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/knife/config_get.rb4
-rw-r--r--lib/chef/knife/config_list_profiles.rb2
-rw-r--r--lib/chef/knife/configure.rb12
-rw-r--r--lib/chef/knife/cookbook_bulk_delete.rb2
-rw-r--r--lib/chef/knife/cookbook_delete.rb8
-rw-r--r--lib/chef/knife/cookbook_upload.rb12
-rw-r--r--lib/chef/knife/core/status_presenter.rb7
-rw-r--r--lib/chef/knife/core/ui.rb2
-rw-r--r--lib/chef/knife/data_bag_from_file.rb2
-rw-r--r--lib/chef/knife/data_bag_list.rb2
-rw-r--r--lib/chef/knife/data_bag_secret_options.rb6
-rw-r--r--lib/chef/knife/delete.rb2
-rw-r--r--lib/chef/knife/download.rb8
-rw-r--r--lib/chef/knife/edit.rb2
-rw-r--r--lib/chef/knife/environment_compare.rb4
-rw-r--r--lib/chef/knife/environment_create.rb2
-rw-r--r--lib/chef/knife/environment_from_file.rb2
-rw-r--r--lib/chef/knife/environment_list.rb2
-rw-r--r--lib/chef/knife/node_show.rb4
-rw-r--r--lib/chef/knife/osc_user_create.rb6
-rw-r--r--lib/chef/knife/osc_user_list.rb2
-rw-r--r--lib/chef/knife/osc_user_reregister.rb2
-rw-r--r--lib/chef/knife/raw.rb6
-rw-r--r--lib/chef/knife/role_create.rb2
-rw-r--r--lib/chef/knife/role_env_run_list_add.rb2
-rw-r--r--lib/chef/knife/role_list.rb2
-rw-r--r--lib/chef/knife/role_run_list_add.rb2
-rw-r--r--lib/chef/knife/role_show.rb2
-rw-r--r--lib/chef/knife/search.rb12
-rw-r--r--lib/chef/knife/serve.rb4
-rw-r--r--lib/chef/knife/show.rb2
-rw-r--r--lib/chef/knife/ssh.rb28
-rw-r--r--lib/chef/knife/status.rb2
-rw-r--r--lib/chef/knife/supermarket_download.rb6
-rw-r--r--lib/chef/knife/supermarket_install.rb8
-rw-r--r--lib/chef/knife/supermarket_list.rb4
-rw-r--r--lib/chef/knife/supermarket_search.rb2
-rw-r--r--lib/chef/knife/supermarket_share.rb4
-rw-r--r--lib/chef/knife/supermarket_show.rb2
-rw-r--r--lib/chef/knife/supermarket_unshare.rb2
-rw-r--r--lib/chef/knife/upload.rb4
-rw-r--r--lib/chef/knife/user_list.rb2
-rw-r--r--lib/chef/knife/xargs.rb10
43 files changed, 103 insertions, 100 deletions
diff --git a/lib/chef/knife/config_get.rb b/lib/chef/knife/config_get.rb
index 23085d177c..c687e39a29 100644
--- a/lib/chef/knife/config_get.rb
+++ b/lib/chef/knife/config_get.rb
@@ -27,13 +27,13 @@ class Chef
option :all,
short: "-a",
long: "--all",
- description: "Include options that are not set in the configuration",
+ description: "Include options that are not set in the configuration.",
default: false
option :raw,
short: "-r",
long: "--raw",
- description: "Display a each value with no formatting",
+ description: "Display a each value with no formatting.",
default: false
def run
diff --git a/lib/chef/knife/config_list_profiles.rb b/lib/chef/knife/config_list_profiles.rb
index 16b0c5df27..8e46aef14b 100644
--- a/lib/chef/knife/config_list_profiles.rb
+++ b/lib/chef/knife/config_list_profiles.rb
@@ -26,7 +26,7 @@ class Chef
option :ignore_knife_rb,
short: "-i",
long: "--ignore-knife-rb",
- description: "Ignore the current knife.rb configuration",
+ description: "Ignore the current knife.rb configuration.",
default: false
def run
diff --git a/lib/chef/knife/configure.rb b/lib/chef/knife/configure.rb
index 4b33998eaa..18cec044a6 100644
--- a/lib/chef/knife/configure.rb
+++ b/lib/chef/knife/configure.rb
@@ -36,29 +36,29 @@ class Chef
option :repository,
short: "-r REPO",
long: "--repository REPO",
- description: "The path to the chef-repo"
+ description: "The path to the chef-repo."
option :initial,
short: "-i",
long: "--initial",
boolean: true,
- description: "Use to create a API client, typically an administrator client on a freshly-installed server"
+ description: "Use to create a API client, typically an administrator client on a freshly-installed server."
option :admin_client_name,
long: "--admin-client-name NAME",
- description: "The name of the client, typically the name of the admin client"
+ description: "The name of the client, typically the name of the admin client."
option :admin_client_key,
long: "--admin-client-key PATH",
- description: "The path to the private key used by the client, typically a file named admin.pem"
+ description: "The path to the private key used by the client, typically a file named admin.pem."
option :validation_client_name,
long: "--validation-client-name NAME",
- description: "The name of the validation client, typically a client named chef-validator"
+ description: "The name of the validation client, typically a client named chef-validator."
option :validation_key,
long: "--validation-key PATH",
- description: "The path to the validation key used by the client, typically a file named validation.pem"
+ description: "The path to the validation key used by the client, typically a file named validation.pem."
def configure_chef
# We are just faking out the system so that you can do this without a key specified
diff --git a/lib/chef/knife/cookbook_bulk_delete.rb b/lib/chef/knife/cookbook_bulk_delete.rb
index a68e8f00f4..d895797598 100644
--- a/lib/chef/knife/cookbook_bulk_delete.rb
+++ b/lib/chef/knife/cookbook_bulk_delete.rb
@@ -28,7 +28,7 @@ class Chef
require "chef/cookbook_version"
end
- option :purge, short: "-p", long: "--purge", boolean: true, description: "Permanently remove files from backing data store"
+ option :purge, short: "-p", long: "--purge", boolean: true, description: "Permanently remove files from backing data store."
banner "knife cookbook bulk delete REGEX (options)"
diff --git a/lib/chef/knife/cookbook_delete.rb b/lib/chef/knife/cookbook_delete.rb
index 4f2ada53cb..a4f64747c3 100644
--- a/lib/chef/knife/cookbook_delete.rb
+++ b/lib/chef/knife/cookbook_delete.rb
@@ -28,9 +28,9 @@ class Chef
require "chef/cookbook_version"
end
- option :all, short: "-a", long: "--all", boolean: true, description: "delete all versions"
+ option :all, short: "-a", long: "--all", boolean: true, description: "Delete all versions of the cookbook."
- option :purge, short: "-p", long: "--purge", boolean: true, description: "Permanently remove files from backing data store"
+ option :purge, short: "-p", long: "--purge", boolean: true, description: "Permanently remove files from backing data store."
banner "knife cookbook delete COOKBOOK VERSION (options)"
@@ -45,7 +45,7 @@ class Chef
delete_without_explicit_version
elsif @cookbook_name.nil?
show_usage
- ui.fatal("You must provide the name of the cookbook to delete")
+ ui.fatal("You must provide the name of the cookbook to delete.")
exit(1)
end
end
@@ -90,7 +90,7 @@ class Chef
end.flatten
rescue Net::HTTPServerException => e
if e.to_s =~ /^404/
- ui.error("Cannot find a cookbook named #{@cookbook_name} to delete")
+ ui.error("Cannot find a cookbook named #{@cookbook_name} to delete.")
nil
else
raise
diff --git a/lib/chef/knife/cookbook_upload.rb b/lib/chef/knife/cookbook_upload.rb
index 2b3c6ba948..ba63e7d0fd 100644
--- a/lib/chef/knife/cookbook_upload.rb
+++ b/lib/chef/knife/cookbook_upload.rb
@@ -39,27 +39,27 @@ class Chef
option :cookbook_path,
short: "-o PATH:PATH",
long: "--cookbook-path PATH:PATH",
- description: "A colon-separated path to look for cookbooks in",
+ description: "A colon-separated path to look for cookbooks in.",
proc: lambda { |o| o.split(":") }
option :freeze,
long: "--freeze",
- description: "Freeze this version of the cookbook so that it cannot be overwritten",
+ description: "Freeze this version of the cookbook so that it cannot be overwritten.",
boolean: true
option :all,
short: "-a",
long: "--all",
- description: "Upload all cookbooks, rather than just a single cookbook"
+ description: "Upload all cookbooks, rather than just a single cookbook."
option :force,
long: "--force",
boolean: true,
- description: "Update cookbook versions even if they have been frozen"
+ description: "Update cookbook versions even if they have been frozen."
option :concurrency,
long: "--concurrency NUMBER_OF_THREADS",
- description: "How many concurrent threads will be used",
+ description: "How many concurrent threads will be used.",
default: 10,
proc: lambda { |o| o.to_i }
@@ -72,7 +72,7 @@ class Chef
option :depends,
short: "-d",
long: "--include-dependencies",
- description: "Also upload cookbook dependencies"
+ description: "Also upload cookbook dependencies."
def run
# Sanity check before we load anything from the server
diff --git a/lib/chef/knife/core/status_presenter.rb b/lib/chef/knife/core/status_presenter.rb
index 5672124007..12cf7c9461 100644
--- a/lib/chef/knife/core/status_presenter.rb
+++ b/lib/chef/knife/core/status_presenter.rb
@@ -68,8 +68,9 @@ class Chef
result["name"] = node["name"] || node.name
result["chef_environment"] = node["chef_environment"]
- ip = (node["ec2"] && node["ec2"]["public_ipv4"]) || node["ipaddress"]
- fqdn = (node["ec2"] && node["ec2"]["public_hostname"]) || node["fqdn"]
+ # use the cloud public ipv4 & fqdn if available
+ ip = (node["cloud"] && node["cloud"]["public_ipv4"]) || node["ipaddress"]
+ fqdn = (node["cloud"] && node["cloud"]["public_hostname"]) || node["fqdn"]
result["ip"] = ip if ip
result["fqdn"] = fqdn if fqdn
result["run_list"] = node.run_list if config["run_list"]
@@ -96,7 +97,7 @@ class Chef
summarized = ""
list.each do |data|
node = data
- # special case ec2 with their split horizon whatsis.
+ # use the cloud public ipv4 & fqdn if available
ip = (node[:ec2] && node[:ec2][:public_ipv4]) || node[:ipaddress]
fqdn = (node[:ec2] && node[:ec2][:public_hostname]) || node[:fqdn]
name = node["name"] || node.name
diff --git a/lib/chef/knife/core/ui.rb b/lib/chef/knife/core/ui.rb
index b2efbd8b8f..e3dafc3028 100644
--- a/lib/chef/knife/core/ui.rb
+++ b/lib/chef/knife/core/ui.rb
@@ -208,7 +208,7 @@ class Chef
output_parsed_again = Chef::JSONCompat.parse(Chef::JSONCompat.to_json(output))
if object_parsed_again != output_parsed_again
output.save
- msg("Saved #{output}")
+ msg("Saved #{klass.name.split('::').last} #{output}")
else
msg("Object unchanged, not saving")
end
diff --git a/lib/chef/knife/data_bag_from_file.rb b/lib/chef/knife/data_bag_from_file.rb
index 3579631e41..1cf7a07a36 100644
--- a/lib/chef/knife/data_bag_from_file.rb
+++ b/lib/chef/knife/data_bag_from_file.rb
@@ -39,7 +39,7 @@ class Chef
option :all,
short: "-a",
long: "--all",
- description: "Upload all data bags or all items for specified data bags"
+ description: "Upload all data bags or all items for specified data bags."
def loader
@loader ||= Knife::Core::ObjectLoader.new(DataBagItem, ui)
diff --git a/lib/chef/knife/data_bag_list.rb b/lib/chef/knife/data_bag_list.rb
index 454b0a4908..d6f6142136 100644
--- a/lib/chef/knife/data_bag_list.rb
+++ b/lib/chef/knife/data_bag_list.rb
@@ -32,7 +32,7 @@ class Chef
option :with_uri,
short: "-w",
long: "--with-uri",
- description: "Show corresponding URIs"
+ description: "Show corresponding URIs."
def run
output(format_list_for_display(Chef::DataBag.list))
diff --git a/lib/chef/knife/data_bag_secret_options.rb b/lib/chef/knife/data_bag_secret_options.rb
index 6e800add89..5f49b5f137 100644
--- a/lib/chef/knife/data_bag_secret_options.rb
+++ b/lib/chef/knife/data_bag_secret_options.rb
@@ -37,19 +37,19 @@ class Chef
base.option :secret,
short: "-s SECRET",
long: "--secret ",
- description: "The secret key to use to encrypt data bag item values. Can also be defaulted in your config with the key 'secret'",
+ description: "The secret key to use to encrypt data bag item values. Can also be defaulted in your config with the key 'secret'.",
# Need to store value from command line in separate variable - knife#merge_configs populates same keys
# on config object from
proc: Proc.new { |s| set_cl_secret(s) }
base.option :secret_file,
long: "--secret-file SECRET_FILE",
- description: "A file containing the secret key to use to encrypt data bag item values. Can also be defaulted in your config with the key 'secret_file'",
+ description: "A file containing the secret key to use to encrypt data bag item values. Can also be defaulted in your config with the key 'secret_file'.",
proc: Proc.new { |sf| set_cl_secret_file(sf) }
base.option :encrypt,
long: "--encrypt",
- description: "If 'secret' or 'secret_file' is present in your config, then encrypt data bags using it",
+ description: "If 'secret' or 'secret_file' is present in your config, then encrypt data bags using it.",
boolean: true,
default: false
end
diff --git a/lib/chef/knife/delete.rb b/lib/chef/knife/delete.rb
index 1c05fba3cf..7d2f4c405f 100644
--- a/lib/chef/knife/delete.rb
+++ b/lib/chef/knife/delete.rb
@@ -33,11 +33,13 @@ class Chef
boolean: true,
default: false,
description: "Delete directories recursively."
+
option :both,
long: "--both",
boolean: true,
default: false,
description: "Delete both the local and remote copies."
+
option :local,
long: "--local",
boolean: true,
diff --git a/lib/chef/knife/download.rb b/lib/chef/knife/download.rb
index f1dfd13326..57e0aee3e9 100644
--- a/lib/chef/knife/download.rb
+++ b/lib/chef/knife/download.rb
@@ -43,24 +43,24 @@ class Chef
long: "--[no-]force",
boolean: true,
default: false,
- description: "Force upload of files even if they match (quicker and harmless, but doesn't print out what it changed)"
+ description: "Force upload of files even if they match (quicker and harmless, but doesn't print out what it changed)."
option :dry_run,
long: "--dry-run",
short: "-n",
boolean: true,
default: false,
- description: "Don't take action, only print what would happen"
+ description: "Don't take action, only print what would happen."
option :diff,
long: "--[no-]diff",
boolean: true,
default: true,
- description: "Turn off to avoid uploading existing files; only new (and possibly deleted) files with --no-diff"
+ description: "Turn off to avoid uploading existing files; only new (and possibly deleted) files with --no-diff."
option :cookbook_version,
long: "--cookbook-version VERSION",
- description: "Version of cookbook to download (if there are multiple versions and cookbook_versions is false)"
+ description: "Version of cookbook to download (if there are multiple versions and cookbook_versions is false)."
def run
if name_args.length == 0
diff --git a/lib/chef/knife/edit.rb b/lib/chef/knife/edit.rb
index e150babc31..fabc282cc2 100644
--- a/lib/chef/knife/edit.rb
+++ b/lib/chef/knife/edit.rb
@@ -31,7 +31,7 @@ class Chef
option :local,
long: "--local",
boolean: true,
- description: "Show local files instead of remote"
+ description: "Show local files instead of remote."
def run
# Get the matches (recursively)
diff --git a/lib/chef/knife/environment_compare.rb b/lib/chef/knife/environment_compare.rb
index 1395db3f34..b5f1c9be7e 100644
--- a/lib/chef/knife/environment_compare.rb
+++ b/lib/chef/knife/environment_compare.rb
@@ -31,13 +31,13 @@ class Chef
option :all,
short: "-a",
long: "--all",
- description: "Show all cookbooks",
+ description: "Show all cookbooks.",
boolean: true
option :mismatch,
short: "-m",
long: "--mismatch",
- description: "Only show mismatching versions",
+ description: "Only show mismatching versions.",
boolean: true
def run
diff --git a/lib/chef/knife/environment_create.rb b/lib/chef/knife/environment_create.rb
index ca51d2cf1a..6d8321b9b7 100644
--- a/lib/chef/knife/environment_create.rb
+++ b/lib/chef/knife/environment_create.rb
@@ -31,7 +31,7 @@ class Chef
option :description,
short: "-d DESCRIPTION",
long: "--description DESCRIPTION",
- description: "The environment description"
+ description: "The environment description."
def run
env_name = @name_args[0]
diff --git a/lib/chef/knife/environment_from_file.rb b/lib/chef/knife/environment_from_file.rb
index 6e22e8b0f6..c533a7351d 100644
--- a/lib/chef/knife/environment_from_file.rb
+++ b/lib/chef/knife/environment_from_file.rb
@@ -32,7 +32,7 @@ class Chef
option :all,
short: "-a",
long: "--all",
- description: "Upload all environments"
+ description: "Upload all environments."
def loader
@loader ||= Knife::Core::ObjectLoader.new(Chef::Environment, ui)
diff --git a/lib/chef/knife/environment_list.rb b/lib/chef/knife/environment_list.rb
index 71e4fffe80..6b4b8508fa 100644
--- a/lib/chef/knife/environment_list.rb
+++ b/lib/chef/knife/environment_list.rb
@@ -31,7 +31,7 @@ class Chef
option :with_uri,
short: "-w",
long: "--with-uri",
- description: "Show corresponding URIs"
+ description: "Show corresponding URIs."
def run
output(format_list_for_display(Chef::Environment.list))
diff --git a/lib/chef/knife/node_show.rb b/lib/chef/knife/node_show.rb
index 43e7e9dbee..90cdbdb641 100644
--- a/lib/chef/knife/node_show.rb
+++ b/lib/chef/knife/node_show.rb
@@ -36,12 +36,12 @@ class Chef
option :run_list,
short: "-r",
long: "--run-list",
- description: "Show only the run list"
+ description: "Show only the run list."
option :environment,
short: "-E",
long: "--environment",
- description: "Show only the Chef environment"
+ description: "Show only the Chef environment."
def run
ui.use_presenter Knife::Core::NodePresenter
diff --git a/lib/chef/knife/osc_user_create.rb b/lib/chef/knife/osc_user_create.rb
index 9ebf268110..97da785098 100644
--- a/lib/chef/knife/osc_user_create.rb
+++ b/lib/chef/knife/osc_user_create.rb
@@ -34,18 +34,18 @@ class Chef
option :file,
short: "-f FILE",
long: "--file FILE",
- description: "Write the private key to a file"
+ description: "Write the private key to a file."
option :admin,
short: "-a",
long: "--admin",
- description: "Create the user as an admin",
+ description: "Create the user as an admin.",
boolean: true
option :user_password,
short: "-p PASSWORD",
long: "--password PASSWORD",
- description: "Password for newly created user",
+ description: "Password for newly created user.",
default: ""
option :user_key,
diff --git a/lib/chef/knife/osc_user_list.rb b/lib/chef/knife/osc_user_list.rb
index 17a7a781d9..3e22bbb1c4 100644
--- a/lib/chef/knife/osc_user_list.rb
+++ b/lib/chef/knife/osc_user_list.rb
@@ -37,7 +37,7 @@ class Chef
option :with_uri,
short: "-w",
long: "--with-uri",
- description: "Show corresponding URIs"
+ description: "Show corresponding URIs."
def run
output(format_list_for_display(Chef::User.list))
diff --git a/lib/chef/knife/osc_user_reregister.rb b/lib/chef/knife/osc_user_reregister.rb
index 5f5d3fb246..4e4a575222 100644
--- a/lib/chef/knife/osc_user_reregister.rb
+++ b/lib/chef/knife/osc_user_reregister.rb
@@ -37,7 +37,7 @@ class Chef
option :file,
short: "-f FILE",
long: "--file FILE",
- description: "Write the private key to a file"
+ description: "Write the private key to a file."
def run
@user_name = @name_args[0]
diff --git a/lib/chef/knife/raw.rb b/lib/chef/knife/raw.rb
index 2d49c457fc..5658420c3e 100644
--- a/lib/chef/knife/raw.rb
+++ b/lib/chef/knife/raw.rb
@@ -36,18 +36,18 @@ class Chef
long: "--method METHOD",
short: "-m METHOD",
default: "GET",
- description: "Request method (GET, POST, PUT or DELETE). Default: GET"
+ description: "Request method (GET, POST, PUT or DELETE). Default: GET."
option :pretty,
long: "--[no-]pretty",
boolean: true,
default: true,
- description: "Pretty-print JSON output. Default: true"
+ description: "Pretty-print JSON output. Default: true."
option :input,
long: "--input FILE",
short: "-i FILE",
- description: "Name of file to use for PUT or POST"
+ description: "Name of file to use for PUT or POST."
option :proxy_auth,
long: "--proxy-auth",
diff --git a/lib/chef/knife/role_create.rb b/lib/chef/knife/role_create.rb
index 6b953f31c8..f271dddd98 100644
--- a/lib/chef/knife/role_create.rb
+++ b/lib/chef/knife/role_create.rb
@@ -32,7 +32,7 @@ class Chef
option :description,
short: "-d DESC",
long: "--description DESC",
- description: "The role description"
+ description: "The role description."
def run
@role_name = @name_args[0]
diff --git a/lib/chef/knife/role_env_run_list_add.rb b/lib/chef/knife/role_env_run_list_add.rb
index 0f4bee9dbf..884f104e65 100644
--- a/lib/chef/knife/role_env_run_list_add.rb
+++ b/lib/chef/knife/role_env_run_list_add.rb
@@ -33,7 +33,7 @@ class Chef
option :after,
short: "-a ITEM",
long: "--after ITEM",
- description: "Place the ENTRY in the run list after ITEM"
+ description: "Place the ENTRY in the run list after ITEM."
def add_to_env_run_list(role, environment, entries, after = nil)
if after
diff --git a/lib/chef/knife/role_list.rb b/lib/chef/knife/role_list.rb
index 3d6c3b4574..41261e09ee 100644
--- a/lib/chef/knife/role_list.rb
+++ b/lib/chef/knife/role_list.rb
@@ -32,7 +32,7 @@ class Chef
option :with_uri,
short: "-w",
long: "--with-uri",
- description: "Show corresponding URIs"
+ description: "Show corresponding URIs."
def run
output(format_list_for_display(Chef::Role.list))
diff --git a/lib/chef/knife/role_run_list_add.rb b/lib/chef/knife/role_run_list_add.rb
index c6564f9d04..ad79434c32 100644
--- a/lib/chef/knife/role_run_list_add.rb
+++ b/lib/chef/knife/role_run_list_add.rb
@@ -33,7 +33,7 @@ class Chef
option :after,
short: "-a ITEM",
long: "--after ITEM",
- description: "Place the ENTRY in the run list after ITEM"
+ description: "Place the ENTRY in the run list after ITEM."
def add_to_env_run_list(role, environment, entries, after = nil)
if after
diff --git a/lib/chef/knife/role_show.rb b/lib/chef/knife/role_show.rb
index c9ff6e584e..cad0344eca 100644
--- a/lib/chef/knife/role_show.rb
+++ b/lib/chef/knife/role_show.rb
@@ -35,7 +35,7 @@ class Chef
if @role_name.nil?
show_usage
- ui.fatal("You must specify a role name")
+ ui.fatal("You must specify a role name.")
exit 1
end
diff --git a/lib/chef/knife/search.rb b/lib/chef/knife/search.rb
index 1bc9ce9f7e..324c439ddc 100644
--- a/lib/chef/knife/search.rb
+++ b/lib/chef/knife/search.rb
@@ -40,36 +40,36 @@ class Chef
option :start,
short: "-b ROW",
long: "--start ROW",
- description: "The row to start returning results at",
+ description: "The row to start returning results at.",
default: 0,
proc: lambda { |i| i.to_i }
option :rows,
short: "-R INT",
long: "--rows INT",
- description: "The number of rows to return",
+ description: "The number of rows to return.",
default: nil,
proc: lambda { |i| i.to_i }
option :run_list,
short: "-r",
long: "--run-list",
- description: "Show only the run list"
+ description: "Show only the run list."
option :id_only,
short: "-i",
long: "--id-only",
- description: "Show only the ID of matching objects"
+ description: "Show only the ID of matching objects."
option :query,
short: "-q QUERY",
long: "--query QUERY",
- description: "The search query; useful to protect queries starting with -"
+ description: "The search query; useful to protect queries starting with -."
option :filter_result,
short: "-f FILTER",
long: "--filter-result FILTER",
- description: "Only return specific attributes of the matching objects; for example: \"ServerName=name, Kernel=kernel.version\""
+ description: "Only return specific attributes of the matching objects; for example: \"ServerName=name, Kernel=kernel.version\"."
def run
read_cli_args
diff --git a/lib/chef/knife/serve.rb b/lib/chef/knife/serve.rb
index eb5c98963c..0a731bfa38 100644
--- a/lib/chef/knife/serve.rb
+++ b/lib/chef/knife/serve.rb
@@ -25,11 +25,11 @@ class Chef
option :repo_mode,
long: "--repo-mode MODE",
- description: "Specifies the local repository layout. Values: static (only environments/roles/data_bags/cookbooks), everything (includes nodes/clients/users), hosted_everything (includes acls/groups/etc. for Enterprise/Hosted Chef). Default: everything/hosted_everything"
+ description: "Specifies the local repository layout. Values: static (only environments/roles/data_bags/cookbooks), everything (includes nodes/clients/users), hosted_everything (includes acls/groups/etc. for Enterprise/Hosted Chef). Default: everything/hosted_everything."
option :chef_repo_path,
long: "--chef-repo-path PATH",
- description: "Overrides the location of chef repo. Default is specified by chef_repo_path in the config"
+ description: "Overrides the location of chef repo. Default is specified by chef_repo_path in the config."
option :chef_zero_host,
long: "--chef-zero-host IP",
diff --git a/lib/chef/knife/show.rb b/lib/chef/knife/show.rb
index 4511a86004..e31a2c1b0c 100644
--- a/lib/chef/knife/show.rb
+++ b/lib/chef/knife/show.rb
@@ -31,7 +31,7 @@ class Chef
option :local,
long: "--local",
boolean: true,
- description: "Show local files instead of remote"
+ description: "Show local files instead of remote."
def run
# Get the matches (recursively)
diff --git a/lib/chef/knife/ssh.rb b/lib/chef/knife/ssh.rb
index cd29b62b75..ab7623a4d8 100644
--- a/lib/chef/knife/ssh.rb
+++ b/lib/chef/knife/ssh.rb
@@ -42,35 +42,35 @@ class Chef
option :concurrency,
short: "-C NUM",
long: "--concurrency NUM",
- description: "The number of concurrent connections",
+ description: "The number of concurrent connections.",
default: nil,
proc: lambda { |o| o.to_i }
option :ssh_attribute,
short: "-a ATTR",
long: "--attribute ATTR",
- description: "The attribute to use for opening the connection - default depends on the context"
+ description: "The attribute to use for opening the connection - default depends on the context."
option :manual,
short: "-m",
long: "--manual-list",
boolean: true,
- description: "QUERY is a space separated list of servers",
+ description: "QUERY is a space separated list of servers.",
default: false
option :prefix_attribute,
long: "--prefix-attribute ATTR",
- description: "The attribute to use for prefixing the ouput - default depends on the context"
+ description: "The attribute to use for prefixing the ouput - default depends on the context."
option :ssh_user,
short: "-x USERNAME",
long: "--ssh-user USERNAME",
- description: "The ssh username"
+ description: "The ssh username."
option :ssh_password_ng,
short: "-P [PASSWORD]",
long: "--ssh-password [PASSWORD]",
- description: "The ssh password - will prompt if flag is specified but no password is given",
+ description: "The ssh password - will prompt if flag is specified but no password is given.",
# default to a value that can not be a password (boolean)
# so we can effectively test if this parameter was specified
# without a value
@@ -79,36 +79,36 @@ class Chef
option :ssh_port,
short: "-p PORT",
long: "--ssh-port PORT",
- description: "The ssh port",
+ description: "The ssh port.",
proc: Proc.new { |key| Chef::Config[:knife][:ssh_port] = key.strip }
option :ssh_timeout,
short: "-t SECONDS",
long: "--ssh-timeout SECONDS",
- description: "The ssh connection timeout",
+ description: "The ssh connection timeout.",
proc: Proc.new { |key| Chef::Config[:knife][:ssh_timeout] = key.strip.to_i },
default: 120
option :ssh_gateway,
short: "-G GATEWAY",
long: "--ssh-gateway GATEWAY",
- description: "The ssh gateway",
+ description: "The ssh gateway.",
proc: Proc.new { |key| Chef::Config[:knife][:ssh_gateway] = key.strip }
option :ssh_gateway_identity,
long: "--ssh-gateway-identity SSH_GATEWAY_IDENTITY",
- description: "The SSH identity file used for gateway authentication"
+ description: "The SSH identity file used for gateway authentication."
option :forward_agent,
short: "-A",
long: "--forward-agent",
- description: "Enable SSH agent forwarding",
+ description: "Enable SSH agent forwarding.",
boolean: true
option :ssh_identity_file,
short: "-i IDENTITY_FILE",
long: "--ssh-identity-file IDENTITY_FILE",
- description: "The SSH identity file used for authentication"
+ description: "The SSH identity file used for authentication."
option :host_key_verify,
long: "--[no-]host-key-verify",
@@ -119,13 +119,13 @@ class Chef
option :on_error,
short: "-e",
long: "--exit-on-error",
- description: "Immediately exit if an error is encountered",
+ description: "Immediately exit if an error is encountered.",
boolean: true,
default: false
option :duplicated_fqdns,
long: "--duplicated-fqdns",
- description: "Behavior if FQDNs are duplicated, ignored by default",
+ description: "Behavior if FQDNs are duplicated, ignored by default.",
proc: Proc.new { |key| Chef::Config[:knife][:duplicated_fqdns] = key.strip.to_sym },
default: :ignore
diff --git a/lib/chef/knife/status.rb b/lib/chef/knife/status.rb
index 413bff4f66..18bf987aa3 100644
--- a/lib/chef/knife/status.rb
+++ b/lib/chef/knife/status.rb
@@ -72,7 +72,7 @@ class Chef
append_to_query("chef_environment:#{config[:environment]}") if config[:environment]
if config[:hide_healthy]
- ui.warn("-H / --hide-healthy is deprecated. Use --hide-by-mins MINS instead")
+ ui.warn("-H / --hide-healthy is deprecated and will be removed in Chef 15. Use --hide-by-mins MINS instead")
time = Time.now.to_i
# AND NOT is not valid lucene syntax, so don't use append_to_query
@query << " " unless @query.empty?
diff --git a/lib/chef/knife/supermarket_download.rb b/lib/chef/knife/supermarket_download.rb
index a912f18d85..dc0c50ab92 100644
--- a/lib/chef/knife/supermarket_download.rb
+++ b/lib/chef/knife/supermarket_download.rb
@@ -32,16 +32,16 @@ class Chef
option :file,
short: "-f FILE",
long: "--file FILE",
- description: "The filename to write to"
+ description: "The filename to write to."
option :force,
long: "--force",
- description: "Force download deprecated version"
+ description: "Force download deprecated version."
option :supermarket_site,
short: "-m SUPERMARKET_SITE",
long: "--supermarket-site SUPERMARKET_SITE",
- description: "Supermarket Site",
+ description: "The URL of the Supermarket site.",
default: "https://supermarket.chef.io",
proc: Proc.new { |supermarket| Chef::Config[:knife][:supermarket_site] = supermarket }
diff --git a/lib/chef/knife/supermarket_install.rb b/lib/chef/knife/supermarket_install.rb
index 97a761e69b..1a5ec2a1a1 100644
--- a/lib/chef/knife/supermarket_install.rb
+++ b/lib/chef/knife/supermarket_install.rb
@@ -44,26 +44,26 @@ class Chef
option :cookbook_path,
short: "-o PATH:PATH",
long: "--cookbook-path PATH:PATH",
- description: "A colon-separated path to look for cookbooks in",
+ description: "A colon-separated path to look for cookbooks in.",
proc: lambda { |o| o.split(":") }
option :default_branch,
short: "-B BRANCH",
long: "--branch BRANCH",
- description: "Default branch to work with",
+ description: "Default branch to work with.",
default: "master"
option :use_current_branch,
short: "-b",
long: "--use-current-branch",
- description: "Use the current branch",
+ description: "Use the current branch.",
boolean: true,
default: false
option :supermarket_site,
short: "-m SUPERMARKET_SITE",
long: "--supermarket-site SUPERMARKET_SITE",
- description: "Supermarket Site",
+ description: "The URL of the Supermarket site.",
default: "https://supermarket.chef.io",
proc: Proc.new { |supermarket| Chef::Config[:knife][:supermarket_site] = supermarket }
diff --git a/lib/chef/knife/supermarket_list.rb b/lib/chef/knife/supermarket_list.rb
index a7274714c6..837379845a 100644
--- a/lib/chef/knife/supermarket_list.rb
+++ b/lib/chef/knife/supermarket_list.rb
@@ -28,12 +28,12 @@ class Chef
option :with_uri,
short: "-w",
long: "--with-uri",
- description: "Show corresponding URIs"
+ description: "Show corresponding URIs."
option :supermarket_site,
short: "-m SUPERMARKET_SITE",
long: "--supermarket-site SUPERMARKET_SITE",
- description: "Supermarket Site",
+ description: "The URL of the Supermarket site.",
default: "https://supermarket.chef.io",
proc: Proc.new { |supermarket| Chef::Config[:knife][:supermarket_site] = supermarket }
diff --git a/lib/chef/knife/supermarket_search.rb b/lib/chef/knife/supermarket_search.rb
index 6613b1244b..3dd7f95f2e 100644
--- a/lib/chef/knife/supermarket_search.rb
+++ b/lib/chef/knife/supermarket_search.rb
@@ -27,7 +27,7 @@ class Chef
option :supermarket_site,
short: "-m SUPERMARKET_SITE",
long: "--supermarket-site SUPERMARKET_SITE",
- description: "Supermarket Site",
+ description: "The URL of the Supermarket site.",
default: "https://supermarket.chef.io",
proc: Proc.new { |supermarket| Chef::Config[:knife][:supermarket_site] = supermarket }
diff --git a/lib/chef/knife/supermarket_share.rb b/lib/chef/knife/supermarket_share.rb
index 27d2293679..a47e16bd8c 100644
--- a/lib/chef/knife/supermarket_share.rb
+++ b/lib/chef/knife/supermarket_share.rb
@@ -40,7 +40,7 @@ class Chef
option :cookbook_path,
short: "-o PATH:PATH",
long: "--cookbook-path PATH:PATH",
- description: "A colon-separated path to look for cookbooks in",
+ description: "A colon-separated path to look for cookbooks in.",
proc: lambda { |o| Chef::Config.cookbook_path = o.split(":") }
option :dry_run,
@@ -53,7 +53,7 @@ class Chef
option :supermarket_site,
short: "-m SUPERMARKET_SITE",
long: "--supermarket-site SUPERMARKET_SITE",
- description: "Supermarket Site",
+ description: "The URL of the Supermarket site.",
default: "https://supermarket.chef.io",
proc: Proc.new { |supermarket| Chef::Config[:knife][:supermarket_site] = supermarket }
diff --git a/lib/chef/knife/supermarket_show.rb b/lib/chef/knife/supermarket_show.rb
index f32639dfc3..4fe8ef25fb 100644
--- a/lib/chef/knife/supermarket_show.rb
+++ b/lib/chef/knife/supermarket_show.rb
@@ -28,7 +28,7 @@ class Chef
option :supermarket_site,
short: "-m SUPERMARKET_SITE",
long: "--supermarket-site SUPERMARKET_SITE",
- description: "Supermarket Site",
+ description: "The URL of the Supermarket site.",
default: "https://supermarket.chef.io",
proc: Proc.new { |supermarket| Chef::Config[:knife][:supermarket_site] = supermarket }
diff --git a/lib/chef/knife/supermarket_unshare.rb b/lib/chef/knife/supermarket_unshare.rb
index eb17fc6bd4..e2dfa33b86 100644
--- a/lib/chef/knife/supermarket_unshare.rb
+++ b/lib/chef/knife/supermarket_unshare.rb
@@ -32,7 +32,7 @@ class Chef
option :supermarket_site,
short: "-m SUPERMARKET_SITE",
long: "--supermarket-site SUPERMARKET_SITE",
- description: "Supermarket Site",
+ description: "The URL of the Supermarket site.",
default: "https://supermarket.chef.io",
proc: Proc.new { |supermarket| Chef::Config[:knife][:supermarket_site] = supermarket }
diff --git a/lib/chef/knife/upload.rb b/lib/chef/knife/upload.rb
index e4e0a74b28..9b651ae867 100644
--- a/lib/chef/knife/upload.rb
+++ b/lib/chef/knife/upload.rb
@@ -56,13 +56,13 @@ class Chef
short: "-n",
boolean: true,
default: false,
- description: "Don't take action, only print what would happen"
+ description: "Don't take action, only print what would happen."
option :diff,
long: "--[no-]diff",
boolean: true,
default: true,
- description: "Turn off to avoid uploading existing files; only new (and possibly deleted) files with --no-diff"
+ description: "Turn off to avoid uploading existing files; only new (and possibly deleted) files with --no-diff."
def run
if name_args.length == 0
diff --git a/lib/chef/knife/user_list.rb b/lib/chef/knife/user_list.rb
index 4e24a4c7d7..c1c0fa5109 100644
--- a/lib/chef/knife/user_list.rb
+++ b/lib/chef/knife/user_list.rb
@@ -33,7 +33,7 @@ class Chef
option :with_uri,
short: "-w",
long: "--with-uri",
- description: "Show corresponding URIs"
+ description: "Show corresponding URIs."
def run
output(format_list_for_display(Chef::UserV1.list))
diff --git a/lib/chef/knife/xargs.rb b/lib/chef/knife/xargs.rb
index bb3ce39717..a5ced3eea8 100644
--- a/lib/chef/knife/xargs.rb
+++ b/lib/chef/knife/xargs.rb
@@ -44,7 +44,7 @@ class Chef
long: "--[no-]diff",
default: true,
boolean: true,
- description: "Whether to show a diff when files change (default: true)"
+ description: "Whether to show a diff when files change (default: true)."
option :dry_run,
long: "--dry-run",
@@ -55,7 +55,7 @@ class Chef
long: "--[no-]force",
boolean: true,
default: false,
- description: "Force upload of files even if they are not changed (quicker and harmless, but doesn't print out what it changed)"
+ description: "Force upload of files even if they are not changed (quicker and harmless, but doesn't print out what it changed)."
option :replace_first,
long: "--replace-first REPLACESTR",
@@ -75,16 +75,16 @@ class Chef
option :max_command_line,
long: "--max-chars LENGTH",
short: "-s LENGTH",
- description: "Maximum size of command line, in characters"
+ description: "Maximum size of command line, in characters."
option :verbose_commands,
short: "-t",
- description: "Print command to be run on the command line"
+ description: "Print command to be run on the command line."
option :null_separator,
short: "-0",
boolean: true,
- description: "Use the NULL character (\0) as a separator, instead of whitespace"
+ description: "Use the NULL character (\0) as a separator, instead of whitespace."
def run
error = false