Merge pull request #8449 from reitermarkus/document-system-config

Refactor and document `SystemConfig`.
2020-08-23 04:39:05 +02:00 · 2020-08-23 04:39:05 +02:00 · fbf3d807d7
commit fbf3d807d7
parent 8e78990176 e2c9e6d3c2
3 changed files with 6 additions and 3 deletions
--- a/Library/Homebrew/extend/os/linux/system_config.rb
+++ b/Library/Homebrew/extend/os/linux/system_config.rb
@ -3,7 +3,7 @@
 require "formula"
 require "os/linux/glibc"

-class SystemConfig
+module SystemConfig
  class << self
    def host_glibc_version
      version = OS::Linux::Glibc.system_version
--- a/Library/Homebrew/extend/os/mac/system_config.rb
+++ b/Library/Homebrew/extend/os/mac/system_config.rb
@ -1,6 +1,6 @@
 # frozen_string_literal: true

-class SystemConfig
+module SystemConfig
  class << self
    undef describe_java, describe_homebrew_ruby

--- a/Library/Homebrew/system_config.rb
+++ b/Library/Homebrew/system_config.rb
@ -5,7 +5,10 @@ require "software_spec"
 require "development_tools"
 require "extend/ENV"

-class SystemConfig
+# Helper module for querying information about the system configuration.
+#
+# @api private
+module SystemConfig
  class << self
    def clang
      @clang ||= if DevelopmentTools.installed?