summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2019-05-02 20:21:07 -0700
committerTim Smith <tsmith@chef.io>2019-05-02 20:21:07 -0700
commitb9ad8858e5e147e8c18cc57ebc152923368af141 (patch)
tree6feda66091115a939d3ce4faf359a83a73c4d016
parentc94d875a734d4b4e55dbe0a64dcffc45e90c93d9 (diff)
downloadchef-b9ad8858e5e147e8c18cc57ebc152923368af141.tar.gz
Update more help descriptions
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/application/client.rb2
-rw-r--r--lib/chef/application/exit_code.rb2
-rw-r--r--lib/chef/application/knife.rb2
-rw-r--r--lib/chef/application/solo.rb2
-rw-r--r--lib/chef/application/windows_service.rb12
-rw-r--r--lib/chef/application/windows_service_manager.rb15
6 files changed, 18 insertions, 17 deletions
diff --git a/lib/chef/application/client.rb b/lib/chef/application/client.rb
index 959c746f4a..390acfba04 100644
--- a/lib/chef/application/client.rb
+++ b/lib/chef/application/client.rb
@@ -2,7 +2,7 @@
# Author:: AJ Christensen (<aj@chef.io)
# Author:: Christopher Brown (<cb@chef.io>)
# Author:: Mark Mzyk (mmzyk@chef.io)
-# Copyright:: Copyright 2008-2018, Chef Software Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/lib/chef/application/exit_code.rb b/lib/chef/application/exit_code.rb
index 15a5eaed70..5330db2456 100644
--- a/lib/chef/application/exit_code.rb
+++ b/lib/chef/application/exit_code.rb
@@ -1,6 +1,6 @@
#
# Author:: Steven Murawski (<smurawski@chef.io>)
-# Copyright:: Copyright 2016, Chef Software, Inc.
+# Copyright:: Copyright 2016-2019, Chef Software, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/lib/chef/application/knife.rb b/lib/chef/application/knife.rb
index accbb4e03a..52d447891f 100644
--- a/lib/chef/application/knife.rb
+++ b/lib/chef/application/knife.rb
@@ -1,6 +1,6 @@
#
# Author:: Adam Jacob (<adam@chef.io)
-# Copyright:: Copyright 2009-2016, Chef Software Inc.
+# Copyright:: Copyright 2009-2019, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/lib/chef/application/solo.rb b/lib/chef/application/solo.rb
index 62f08233de..c1042937cc 100644
--- a/lib/chef/application/solo.rb
+++ b/lib/chef/application/solo.rb
@@ -1,7 +1,7 @@
#
# Author:: AJ Christensen (<aj@chef.io>)
# Author:: Mark Mzyk (mmzyk@chef.io)
-# Copyright:: Copyright 2008-2018, Chef Software Inc.
+# Copyright:: Copyright 2008-2019, Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/lib/chef/application/windows_service.rb b/lib/chef/application/windows_service.rb
index 3eb4f63129..cba0dc9781 100644
--- a/lib/chef/application/windows_service.rb
+++ b/lib/chef/application/windows_service.rb
@@ -41,23 +41,23 @@ class Chef
short: "-c CONFIG",
long: "--config CONFIG",
default: "#{ENV['SYSTEMDRIVE']}/chef/client.rb",
- description: ""
+ description: "The configuration file to use for #{Chef::Dist::PRODUCT} runs."
option :log_location,
short: "-L LOGLOCATION",
long: "--logfile LOGLOCATION",
- description: "Set the log file location"
+ description: "Set the log file location."
option :splay,
short: "-s SECONDS",
long: "--splay SECONDS",
- description: "The splay time for running at intervals, in seconds",
+ description: "The splay time for running at intervals, in seconds.",
proc: lambda { |s| s.to_i }
option :interval,
short: "-i SECONDS",
long: "--interval SECONDS",
- description: "Set the number of seconds to wait between #{Chef::Dist::CLIENT} runs",
+ description: "Set the number of seconds to wait between #{Chef::Dist::PRODUCT} runs.",
proc: lambda { |s| s.to_i }
DEFAULT_LOG_LOCATION ||= "#{ENV['SYSTEMDRIVE']}/chef/client.log".freeze
@@ -136,7 +136,7 @@ class Chef
run_warning_displayed = true
end
- Chef::Log.trace("Waiting for #{Chef::Dist::CLIENT} run...")
+ Chef::Log.trace("Waiting for #{Chef::Dist::PRODUCT} run...")
sleep 1
end
end
@@ -150,7 +150,7 @@ class Chef
# since this is a PAUSE signal.
if @service_action_mutex.locked?
- Chef::Log.info("Currently a #{Chef::Dist::CLIENT} run is happening.")
+ Chef::Log.info("Currently a #{Chef::Dist::PRODUCT} run is happening.")
Chef::Log.info("Service will pause once it's completed.")
else
Chef::Log.info("Service is pausing....")
diff --git a/lib/chef/application/windows_service_manager.rb b/lib/chef/application/windows_service_manager.rb
index 2ba1861a5b..2646d98624 100644
--- a/lib/chef/application/windows_service_manager.rb
+++ b/lib/chef/application/windows_service_manager.rb
@@ -1,6 +1,6 @@
#
# Author:: Seth Chisamore (<schisamo@chef.io>)
-# Copyright:: Copyright 2011-2016, Chef Software, Inc.
+# Copyright:: Copyright 2011-2019, Chef Software, Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,6 +21,7 @@ if RUBY_PLATFORM =~ /mswin|mingw32|windows/
end
require "chef/config"
require "mixlib/cli"
+require "chef/dist"
class Chef
class Application
@@ -40,23 +41,23 @@ class Chef
short: "-a ACTION",
long: "--action ACTION",
default: "status",
- description: "Action to carry out on chef-service (install, uninstall, status, start, stop, pause, or resume)"
+ description: "Action to carry out on chef-service (install, uninstall, status, start, stop, pause, or resume)."
option :config_file,
short: "-c CONFIG",
long: "--config CONFIG",
default: "#{ENV['SYSTEMDRIVE']}/chef/client.rb",
- description: "The configuration file to use for chef runs"
+ description: "The configuration file to use for #{Chef::Dist::PRODUCT} runs."
option :log_location,
short: "-L LOGLOCATION",
long: "--logfile LOGLOCATION",
- description: "Set the log file location for chef-service"
+ description: "Set the log file location for chef-service."
option :help,
short: "-h",
long: "--help",
- description: "Show this message",
+ description: "Show this help message.",
on: :tail,
boolean: true,
show_options: true,
@@ -65,9 +66,9 @@ class Chef
option :version,
short: "-v",
long: "--version",
- description: "Show chef version",
+ description: "Show #{Chef::Dist::PRODUCT} version.",
boolean: true,
- proc: lambda { |v| puts "Chef: #{::Chef::VERSION}" },
+ proc: lambda { |v| puts "#{Chef::Dist::PRODUCT}: #{::Chef::VERSION}" },
exit: 0
def initialize(service_options)