diff options
| author | Lamont Granquist <lamont@scriptkiddie.org> | 2019-07-15 21:39:17 -0700 |
|---|---|---|
| committer | Lamont Granquist <lamont@scriptkiddie.org> | 2019-07-15 21:39:17 -0700 |
| commit | 991f66cb6ac9fcf2ef77b6d9ec2485f10601c406 (patch) | |
| tree | ed0d2edb0d4a8519d4447d51fac2fcc194146ad7 | |
| parent | 76352b126bf50987fda6080dec22b10527eeb705 (diff) | |
| download | chef-991f66cb6ac9fcf2ef77b6d9ec2485f10601c406.tar.gz | |
add some comments on deprecation of the solo class
Signed-off-by: Lamont Granquist <lamont@scriptkiddie.org>
| -rw-r--r-- | lib/chef/application/base.rb | 12 | ||||
| -rw-r--r-- | lib/chef/application/client.rb | 4 | ||||
| -rw-r--r-- | lib/chef/application/solo.rb | 6 |
3 files changed, 22 insertions, 0 deletions
diff --git a/lib/chef/application/base.rb b/lib/chef/application/base.rb index 957d19a127..057f747522 100644 --- a/lib/chef/application/base.rb +++ b/lib/chef/application/base.rb @@ -26,6 +26,18 @@ require "chef-config/mixin/dot_d" require "license_acceptance/cli_flags/mixlib_cli" require "mixlib/archive" unless defined?(Mixlib::Archive) +# This is a temporary class being used as a part of an effort to reduce duplication +# between Chef::Application::Client and Chef::Application::Solo. +# +# If you are looking to make edits to the Client/Solo behavior please make changes here, +# this Base class is the correct behavior. +# +# If you are looking to reference or subclass this class, use Chef::Application::Client +# instead. This base class will be removed once the work is complete and external code +# will break. +# +# @deprecated use Chef::Application::Client instead, this will be removed in Chef-16 +# class Chef::Application::Base < Chef::Application include Chef::Mixin::ShellOut include ChefConfig::Mixin::DotD diff --git a/lib/chef/application/client.rb b/lib/chef/application/client.rb index 4f320733a1..727fa27c7b 100644 --- a/lib/chef/application/client.rb +++ b/lib/chef/application/client.rb @@ -22,6 +22,10 @@ require_relative "../handler/error_report" require_relative "../workstation_config_loader" require "uri" unless defined?(URI) +# DO NOT MAKE EDITS, see Chef::Application::Base +# +# External code may call / subclass or make references to this class. +# class Chef::Application::Client < Chef::Application::Base option :config_file, diff --git a/lib/chef/application/solo.rb b/lib/chef/application/solo.rb index d4107eb5ed..383e3b436f 100644 --- a/lib/chef/application/solo.rb +++ b/lib/chef/application/solo.rb @@ -22,6 +22,12 @@ require_relative "client" require "fileutils" unless defined?(FileUtils) require "pathname" unless defined?(Pathname) +# DO NOT MAKE EDITS, see Chef::Application::Base +# +# Do not reference this class it will be removed in Chef-16 +# +# @deprecated use Chef::Application::Client instead, this will be removed in Chef-16 +# class Chef::Application::Solo < Chef::Application::Base option :config_file, |