Merge pull request #10010 from chef/docs

Minor docs updates and MacOS -> macOS
chef · Jun 17, 2020 · c2b6e8f · c2b6e8f
2 parents 936597d + 9597b52
commit c2b6e8f
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -1,4 +1,4 @@
-# End-to-End Test of Chef in MacOS
+# End-to-End Test of Chef in macOS
 
 variables:
   FORCE_FFI_YAJL: 'ext'

diff --git a/lib/chef/provider/user/dscl.rb b/lib/chef/provider/user/dscl.rb
@@ -536,7 +536,7 @@ def read_user_info
 
           # We flush the cache here in order to make sure that we read fresh information
           # for the user.
-          shell_out("dscacheutil", "-flushcache") # FIXME: this is MacOS version dependent
+          shell_out("dscacheutil", "-flushcache") # FIXME: this is macOS version dependent
 
           begin
             user_plist_file = "#{USER_PLIST_DIRECTORY}/#{new_resource.username}.plist"

diff --git a/lib/chef/resource/homebrew_update.rb b/lib/chef/resource/homebrew_update.rb
@@ -19,6 +19,7 @@
 #
 
 require_relative "../resource"
+require_relative "../dist"
 
 class Chef
   class Resource
@@ -27,7 +28,7 @@ class HomebrewUpdate < Chef::Resource
 
       provides(:homebrew_update) { true }
 
-      description "Use the **homebrew_update** resource to manage Homebrew repository updates on MacOS."
+      description "Use the **homebrew_update** resource to manage Homebrew repository updates on macOS."
       introduced "16.2"
       examples <<~DOC
         **Update the homebrew repository data at a specified interval**:
@@ -37,7 +38,7 @@ class HomebrewUpdate < Chef::Resource
           action :periodic
         end
         ```
-        **Update the Homebrew repository at the start of a Chef Infra Client run**:
+        **Update the Homebrew repository at the start of a #{Chef::Dist::PRODUCT} run**:
         ```ruby
         homebrew_update 'update'
         ```

diff --git a/lib/chef/util/diff.rb b/lib/chef/util/diff.rb
@@ -136,7 +136,7 @@ def do_diff(old_file, new_file)
           return "(file sizes exceed #{diff_filesize_threshold} bytes, diff output suppressed)"
         end
 
-        # MacOSX(BSD?) diff will *sometimes* happily spit out nasty binary diffs
+        # macOS(BSD?) diff will *sometimes* happily spit out nasty binary diffs
         return "(current file is binary, diff output suppressed)" if is_binary?(old_file)
         return "(new content is binary, diff output suppressed)" if is_binary?(new_file)