From f0491d4bd2ced637bdae3736633acf5aadacbce1 Mon Sep 17 00:00:00 2001 From: Tim Smith Date: Tue, 23 Jun 2020 13:21:11 -0700 Subject: Pull in misc docs / comment updates from master This just makes the diff easier Signed-off-by: Tim Smith --- lib/chef/chef_fs/path_utils.rb | 6 +++--- lib/chef/cookbook/file_system_file_vendor.rb | 2 +- lib/chef/data_collector/error_handlers.rb | 2 +- lib/chef/dsl/declare_resource.rb | 2 +- lib/chef/dsl/platform_introspection.rb | 2 ++ lib/chef/provider/package/chocolatey.rb | 2 +- 6 files changed, 9 insertions(+), 7 deletions(-) (limited to 'lib') diff --git a/lib/chef/chef_fs/path_utils.rb b/lib/chef/chef_fs/path_utils.rb index b8a83ab09f..31f1f6f12a 100644 --- a/lib/chef/chef_fs/path_utils.rb +++ b/lib/chef/chef_fs/path_utils.rb @@ -71,9 +71,9 @@ class Chef # part that actually exists. The paths operated on here are not Chef-FS paths. # These are OS paths that may contain symlinks but may not also fully exist. # - # If /x is a symlink to /blarghle, and has no subdirectories, then: - # PathUtils.realest_path('/x/y/z') == '/blarghle/y/z' - # PathUtils.realest_path('/x/*/z') == '/blarghle/*/z' + # If /x is a symlink to /foo_bar, and has no subdirectories, then: + # PathUtils.realest_path('/x/y/z') == '/foo_bar/y/z' + # PathUtils.realest_path('/x/*/z') == '/foo_bar/*/z' # PathUtils.realest_path('/*/y/z') == '/*/y/z' # # TODO: Move this to wherever util/path_helper is these days. diff --git a/lib/chef/cookbook/file_system_file_vendor.rb b/lib/chef/cookbook/file_system_file_vendor.rb index 9cf3593838..a4a6711270 100644 --- a/lib/chef/cookbook/file_system_file_vendor.rb +++ b/lib/chef/cookbook/file_system_file_vendor.rb @@ -27,7 +27,7 @@ class Chef # and throws the rest away then re-builds the list of files on the # disk. This is due to the manifest not having the on-disk file # locations, since in the chef-client case, that information is - # non-sensical. + # nonsensical. class FileSystemFileVendor < FileVendor attr_reader :cookbook_name diff --git a/lib/chef/data_collector/error_handlers.rb b/lib/chef/data_collector/error_handlers.rb index 36252149a2..5cda3bde10 100644 --- a/lib/chef/data_collector/error_handlers.rb +++ b/lib/chef/data_collector/error_handlers.rb @@ -18,7 +18,7 @@ class Chef class DataCollector - # This module isolates the handling of collecting error descriptions to insert into the data_colletor + # This module isolates the handling of collecting error descriptions to insert into the data_collector # report output. For very early errors it is responsible for collecting the node_name for the report # to use. For all failure conditions that have an ErrorMapper it collects the output. # diff --git a/lib/chef/dsl/declare_resource.rb b/lib/chef/dsl/declare_resource.rb index f032a76bc7..1fdd35cc3e 100644 --- a/lib/chef/dsl/declare_resource.rb +++ b/lib/chef/dsl/declare_resource.rb @@ -151,7 +151,7 @@ class Chef # source "y.txt.erb" # variables {} # end - # resource.variables.merge!({ home: "/home/klowns" }) + # resource.variables.merge!({ home: "/home/clowns" }) # def edit_resource(type, name, created_at: nil, run_context: self.run_context, &resource_attrs_block) edit_resource!(type, name, created_at: created_at, run_context: run_context, &resource_attrs_block) diff --git a/lib/chef/dsl/platform_introspection.rb b/lib/chef/dsl/platform_introspection.rb index 50f30bda52..e3e7e2f96b 100644 --- a/lib/chef/dsl/platform_introspection.rb +++ b/lib/chef/dsl/platform_introspection.rb @@ -248,6 +248,8 @@ class Chef end # a simple helper to determine if we're on a windows release pre-2012 / 8 + # + # @deprecated Windows releases before Windows 2012 and 8 are no longer supported # @return [Boolean] Is the system older than Windows 8 / 2012 def older_than_win_2012_or_8?(node = run_context.nil? ? nil : run_context.node) node["platform_version"].to_f < 6.2 diff --git a/lib/chef/provider/package/chocolatey.rb b/lib/chef/provider/package/chocolatey.rb index 0719eed12d..564d743c1a 100644 --- a/lib/chef/provider/package/chocolatey.rb +++ b/lib/chef/provider/package/chocolatey.rb @@ -251,7 +251,7 @@ class Chef end # Helper to convert choco.exe list output to a Hash - # (names are downcased for case-insenstive matching) + # (names are downcased for case-insensitive matching) # # @param cmd [String] command to run # @return [Hash] list output converted to ruby Hash -- cgit v1.2.1