From a68f1ff619ec7f1233e1767fb67573bc3b8bd4b1 Mon Sep 17 00:00:00 2001 From: Afnan Enayet Date: Sat, 30 Jun 2018 15:54:17 -0400 Subject: [PATCH 1/7] Update manpage with info about compilers * Update the manpage source file with additional information * document the `HOMEBREW_CC` variable with usage information * update usage information for `--cc`, specifying how to use llvm's clang --- docs/Manpage.md | 53 +++++++++++++++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 21 deletions(-) diff --git a/docs/Manpage.md b/docs/Manpage.md index 853755f9ae..a88b434aca 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -240,7 +240,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--cc=``compiler` is passed, attempt to compile using `compiler`. `compiler` should be the name of the compiler's executable, for instance `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC - 4.9. + 4.9. In order to use the Homebrew-provided clang from the LLVM package, + use `llvm_clang`. Note that this will override the `HOMEBREW_CC` + environment variable. If `--build-from-source` (or `-s`) is passed, compile the specified `formula` from source even if a bottle is provided. Dependencies will still be installed @@ -928,37 +930,37 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note Bundler for non-Ruby dependencies from Homebrew. - + `bundle` [`install`] [`-v`|`--verbose`] [`--no-upgrade`] [`--file=``path`|`--global`]: Install or upgrade all dependencies in a Brewfile. - + `brew bundle dump` [`--force`] [`--describe`] [`--file=``path`|`--global`] Write all installed casks/formulae/taps into a Brewfile. - + `brew bundle cleanup` [`--force`] [`--zap`] [`--file=``path`|`--global`] Uninstall all dependencies not listed in a Brewfile. - + `brew bundle check` [`--no-upgrade`] [`--file`=`path`|`--global`] Check if all dependencies are installed in a Brewfile. - + `brew bundle exec` `command` Run an external command in an isolated build environment. - + `brew bundle list` [`--all`|`--brews`|`--casks`|`--taps`|`--mas`] [`--file=``path`|`--global`] @@ -966,37 +968,37 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note By default, only brew dependencies are output. - + If `-v` or `--verbose` are passed, print verbose output. - + If `--no-upgrade` is passed, don't run `brew upgrade` outdated dependencies. Note they may still be upgraded by `brew install` if needed. - + If `--force` is passed, uninstall dependencies or overwrite an existing Brewfile. - + If `--file=`path is passed, the Brewfile path is set accordingly Use `--file=-` to output to console. - + If `--global` is passed, set Brewfile path to `$HOME/.Brewfile`. - + If `--describe` is passed, output a description comment above each line. This comment will not be output if the dependency does not have a description. - + If `-h` or `--help` are passed, print this help message and exit. @@ -1012,43 +1014,43 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note Integrates Homebrew formulae with macOS' `launchctl` manager. - + [`sudo`] `brew services list` List all running services for the current user (or `root`) - + [`sudo`] `brew services run` `formula|--all` Run the service `formula` without starting at login (or boot). - + [`sudo`] `brew services` `start` `formula|--all` Start the service `formula` immediately and register it to launch at login (or `boot`). - + [`sudo`] `brew services` `stop` `formula|--all` Stop the service `formula` immediately and unregister it from launching at login (or `boot`). - + [`sudo`] `brew services` `restart` `formula|--all` Stop (if necessary) and start the service immediately and register it to launch at login (or `boot`). - + [`sudo`] `brew services` `cleanup` Remove all unused services. - + If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot). @@ -1122,6 +1124,15 @@ Note that environment variables must have a value set to be detected. For exampl *Default:* `~/Library/Caches/Homebrew`. + * `HOMEBREW_CC`: + If set, directs which compiler Homebrew will use to compile packages if it + builds them from source. If an installation command passes in a `--cc` + flag, it will override the value set by `HOMEBREW_CC`. The only valid + compilers are ones provided by Homebrew, or Apple's bundled clang. To use + gcc for compilation, pass in the executable name, i.e. `gcc-4.9`, `gcc-8`. + If you want to use Apple's provided clang, simply use `clang`. For + Homebrew's clang from the LLVM package, use `llvm_clang`. + * `HOMEBREW_CURLRC`: If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables the use of `curlrc`). From 01a3422232e421cea26501e993a27a4d25015ead Mon Sep 17 00:00:00 2001 From: Afnan Enayet Date: Sun, 1 Jul 2018 17:41:49 -0400 Subject: [PATCH 2/7] Update manpages using the `brew man` command Use brew man to generate manpages, and then copy them to the repo. --- manpages/brew-cask.1 | 2 +- manpages/brew.1 | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/manpages/brew-cask.1 b/manpages/brew-cask.1 index 7c62d9496c..38ed4ca759 100644 --- a/manpages/brew-cask.1 +++ b/manpages/brew-cask.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BREW\-CASK" "1" "June 2018" "Homebrew" "brew-cask" +.TH "BREW\-CASK" "1" "July 2018" "Homebrew" "brew-cask" . .SH "NAME" \fBbrew\-cask\fR \- a friendly binary installer for macOS diff --git a/manpages/brew.1 b/manpages/brew.1 index 2755bdd54f..d850bedde2 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "BREW" "1" "June 2018" "Homebrew" "brew" +.TH "BREW" "1" "July 2018" "Homebrew" "brew" . .SH "NAME" \fBbrew\fR \- The missing package manager for macOS From fa41a66907ce54be739650cfc23bbed7cea3de85 Mon Sep 17 00:00:00 2001 From: Afnan Enayet Date: Sun, 1 Jul 2018 18:47:13 -0400 Subject: [PATCH 3/7] Update manpages using man brew Properly update man pages using the local brew executable (from the repo), and copy the man pages to the repo. --- Library/Homebrew/cmd/install.rb | 5 +- Library/Homebrew/manpages/brew.1.md.erb | 9 ++++ docs/Custom-GCC-and-cross-compilers.md | 5 +- docs/Manpage.md | 61 +++++++++++++------------ manpages/brew.1 | 6 ++- 5 files changed, 52 insertions(+), 34 deletions(-) diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index fc1f56fc0a..841567fb4d 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -22,7 +22,10 @@ #: If `--cc=` is passed, attempt to compile using . #: should be the name of the compiler's executable, for instance #: `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC -#: 4.9. +#: 4.9. In order to use LLVM's clang, use `llvm_clang`. To specify the +#: Apple-provided clang, use `clang`. This parameter will only accept +#: compilers that are provided by Homebrew. Note that this will override +#: the value set by the `$HOMEBREW_CC` environment variable. #: #: If `--build-from-source` (or `-s`) is passed, compile the specified from #: source even if a bottle is provided. Dependencies will still be installed diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index 902d6bde5b..43a34d8040 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -138,6 +138,15 @@ Note that environment variables must have a value set to be detected. For exampl *Default:* `~/Library/Caches/Homebrew`. + * `HOMEBREW_CC`: + If set, instructs Homebrew to used the specified compiler to build a + package from source. In order to specify the Apple-provided clang, + set `clang`. For the clang provided from the LLVM package, use + `llvm_clang`. For versions of gcc, use the names of the executables from + the packages that Homebrew provides, e.g. for gcc 4.9, `gcc-4.9`, or for + gcc 8, `gcc-8`. Note that this variable can only be set to compilers that + are provided by Homebrew. + * `HOMEBREW_CURLRC`: If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables the use of `curlrc`). diff --git a/docs/Custom-GCC-and-cross-compilers.md b/docs/Custom-GCC-and-cross-compilers.md index edbcd10442..b92482baa2 100644 --- a/docs/Custom-GCC-and-cross-compilers.md +++ b/docs/Custom-GCC-and-cross-compilers.md @@ -15,7 +15,8 @@ listing them on this page. If you come up with a formula for a new version of GCC or cross-compiler suite, please link it in here. * Homebrew provides a `gcc` formula for use with Xcode 4.2+ or when needing -C++11 support on earlier versions. + C++11 support on earlier versions. * Homebrew provides older GCC formulae, e.g. `gcc@4.8` and `gcc@6`. +* Homebrew provides the LLVM clang, which is bundled with the `llvm` formula. * [RISC-V](https://github.com/riscv/homebrew-riscv) provides the RISC-V -toolchain including binutils and GCC. + toolchain including binutils and GCC. \ No newline at end of file diff --git a/docs/Manpage.md b/docs/Manpage.md index a88b434aca..15a736059d 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -240,9 +240,10 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--cc=``compiler` is passed, attempt to compile using `compiler`. `compiler` should be the name of the compiler's executable, for instance `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC - 4.9. In order to use the Homebrew-provided clang from the LLVM package, - use `llvm_clang`. Note that this will override the `HOMEBREW_CC` - environment variable. + 4.9. In order to use LLVM's clang, use `llvm_clang`. To specify the + Apple-provided clang, use `clang`. This parameter will only accept + compilers that are provided by Homebrew. Note that this will override + the value set by the `$HOMEBREW_CC` environment variable. If `--build-from-source` (or `-s`) is passed, compile the specified `formula` from source even if a bottle is provided. Dependencies will still be installed @@ -930,37 +931,37 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note Bundler for non-Ruby dependencies from Homebrew. - + `bundle` [`install`] [`-v`|`--verbose`] [`--no-upgrade`] [`--file=``path`|`--global`]: Install or upgrade all dependencies in a Brewfile. - + `brew bundle dump` [`--force`] [`--describe`] [`--file=``path`|`--global`] Write all installed casks/formulae/taps into a Brewfile. - + `brew bundle cleanup` [`--force`] [`--zap`] [`--file=``path`|`--global`] Uninstall all dependencies not listed in a Brewfile. - + `brew bundle check` [`--no-upgrade`] [`--file`=`path`|`--global`] Check if all dependencies are installed in a Brewfile. - + `brew bundle exec` `command` Run an external command in an isolated build environment. - + `brew bundle list` [`--all`|`--brews`|`--casks`|`--taps`|`--mas`] [`--file=``path`|`--global`] @@ -968,37 +969,37 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note By default, only brew dependencies are output. - + If `-v` or `--verbose` are passed, print verbose output. - + If `--no-upgrade` is passed, don't run `brew upgrade` outdated dependencies. Note they may still be upgraded by `brew install` if needed. - + If `--force` is passed, uninstall dependencies or overwrite an existing Brewfile. - + If `--file=`path is passed, the Brewfile path is set accordingly Use `--file=-` to output to console. - + If `--global` is passed, set Brewfile path to `$HOME/.Brewfile`. - + If `--describe` is passed, output a description comment above each line. This comment will not be output if the dependency does not have a description. - + If `-h` or `--help` are passed, print this help message and exit. @@ -1014,43 +1015,43 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note Integrates Homebrew formulae with macOS' `launchctl` manager. - + [`sudo`] `brew services list` List all running services for the current user (or `root`) - + [`sudo`] `brew services run` `formula|--all` Run the service `formula` without starting at login (or boot). - + [`sudo`] `brew services` `start` `formula|--all` Start the service `formula` immediately and register it to launch at login (or `boot`). - + [`sudo`] `brew services` `stop` `formula|--all` Stop the service `formula` immediately and unregister it from launching at login (or `boot`). - + [`sudo`] `brew services` `restart` `formula|--all` Stop (if necessary) and start the service immediately and register it to launch at login (or `boot`). - + [`sudo`] `brew services` `cleanup` Remove all unused services. - + If `sudo` is passed, operate on `/Library/LaunchDaemons` (started at boot). @@ -1125,13 +1126,13 @@ Note that environment variables must have a value set to be detected. For exampl *Default:* `~/Library/Caches/Homebrew`. * `HOMEBREW_CC`: - If set, directs which compiler Homebrew will use to compile packages if it - builds them from source. If an installation command passes in a `--cc` - flag, it will override the value set by `HOMEBREW_CC`. The only valid - compilers are ones provided by Homebrew, or Apple's bundled clang. To use - gcc for compilation, pass in the executable name, i.e. `gcc-4.9`, `gcc-8`. - If you want to use Apple's provided clang, simply use `clang`. For - Homebrew's clang from the LLVM package, use `llvm_clang`. + If set, instructs Homebrew to used the specified compiler to build a + package from source. In order to specify the Apple-provided clang, + set `clang`. For the clang provided from the LLVM package, use + `llvm_clang`. For versions of gcc, use the names of the executables from + the packages that Homebrew provides, e.g. for gcc 4.9, `gcc-4.9`, or for + gcc 8, `gcc-8`. Note that this variable can only be set to compilers that + are provided by Homebrew. * `HOMEBREW_CURLRC`: If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables diff --git a/manpages/brew.1 b/manpages/brew.1 index d850bedde2..0cbd60f257 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -227,7 +227,7 @@ If \fB\-\-ignore\-dependencies\fR is passed, skip installing any dependencies of If \fB\-\-only\-dependencies\fR is passed, install the dependencies with specified options but do not install the specified formula\. . .IP -If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\. +If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew\. Note that this will override the value set by the \fB$HOMEBREW_CC\fR environment variable\. . .IP If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\. @@ -1069,6 +1069,10 @@ If set, instructs Homebrew to use the given directory as the download cache\. \fIDefault:\fR \fB~/Library/Caches/Homebrew\fR\. . .TP +\fBHOMEBREW_CC\fR +If set, instructs Homebrew to used the specified compiler to build a package from source\. In order to specify the Apple\-provided clang, set \fBclang\fR\. For the clang provided from the LLVM package, use \fBllvm_clang\fR\. For versions of gcc, use the names of the executables from the packages that Homebrew provides, e\.g\. for gcc 4\.9, \fBgcc\-4\.9\fR, or for gcc 8, \fBgcc\-8\fR\. Note that this variable can only be set to compilers that are provided by Homebrew\. +. +.TP \fBHOMEBREW_CURLRC\fR If set, Homebrew will not pass \fB\-q\fR when invoking \fBcurl\fR(1) (which disables the use of \fBcurlrc\fR)\. . From 72735aef175bf7ddb74728e75ad3a0dc5961c5f3 Mon Sep 17 00:00:00 2001 From: Afnan Enayet Date: Thu, 5 Jul 2018 17:25:19 -0400 Subject: [PATCH 4/7] Update documentation and generate manpage * update references in `--cc` flag, using modern gcc examples * note that issues should not be filed if `--cc` flag is used * remove reference to `HOMEBREW_CC` as it should not be exposed to users * generate manpages using `brew man` with these changes --- Library/Homebrew/cmd/install.rb | 11 ++++++----- Library/Homebrew/manpages/brew.1.md.erb | 9 --------- docs/Custom-GCC-and-cross-compilers.md | 10 +++++----- docs/Manpage.md | 20 ++++++-------------- manpages/brew.1 | 6 +----- 5 files changed, 18 insertions(+), 38 deletions(-) diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index 841567fb4d..1ef8f929c3 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -21,11 +21,12 @@ #: #: If `--cc=` is passed, attempt to compile using . #: should be the name of the compiler's executable, for instance -#: `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC -#: 4.9. In order to use LLVM's clang, use `llvm_clang`. To specify the -#: Apple-provided clang, use `clang`. This parameter will only accept -#: compilers that are provided by Homebrew. Note that this will override -#: the value set by the `$HOMEBREW_CC` environment variable. +#: `gcc-8` for gcc 8, `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a +#: Homebrew-provided GCC 4.9. In order to use LLVM's clang, use +#: `llvm_clang`. To specify the Apple-provided clang, use `clang`. This +#: parameter will only accept compilers that are provided by Homebrew or +#: bundled with MacOS. Please do not file issues if you encounter errors +#: while using this flag. #: #: If `--build-from-source` (or `-s`) is passed, compile the specified from #: source even if a bottle is provided. Dependencies will still be installed diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index 43a34d8040..902d6bde5b 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -138,15 +138,6 @@ Note that environment variables must have a value set to be detected. For exampl *Default:* `~/Library/Caches/Homebrew`. - * `HOMEBREW_CC`: - If set, instructs Homebrew to used the specified compiler to build a - package from source. In order to specify the Apple-provided clang, - set `clang`. For the clang provided from the LLVM package, use - `llvm_clang`. For versions of gcc, use the names of the executables from - the packages that Homebrew provides, e.g. for gcc 4.9, `gcc-4.9`, or for - gcc 8, `gcc-8`. Note that this variable can only be set to compilers that - are provided by Homebrew. - * `HOMEBREW_CURLRC`: If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables the use of `curlrc`). diff --git a/docs/Custom-GCC-and-cross-compilers.md b/docs/Custom-GCC-and-cross-compilers.md index b92482baa2..9352460422 100644 --- a/docs/Custom-GCC-and-cross-compilers.md +++ b/docs/Custom-GCC-and-cross-compilers.md @@ -14,9 +14,9 @@ Rather than merging in brews for either of these cases at this time, we're listing them on this page. If you come up with a formula for a new version of GCC or cross-compiler suite, please link it in here. -* Homebrew provides a `gcc` formula for use with Xcode 4.2+ or when needing +- Homebrew provides a `gcc` formula for use with Xcode 4.2+ or when needing C++11 support on earlier versions. -* Homebrew provides older GCC formulae, e.g. `gcc@4.8` and `gcc@6`. -* Homebrew provides the LLVM clang, which is bundled with the `llvm` formula. -* [RISC-V](https://github.com/riscv/homebrew-riscv) provides the RISC-V - toolchain including binutils and GCC. \ No newline at end of file +- Homebrew provides older GCC formulae, e.g. `gcc@4.9` and `gcc@6`. +- Homebrew provides the LLVM clang, which is bundled with the `llvm` formula. +- [RISC-V](https://github.com/riscv/homebrew-riscv) provides the RISC-V + toolchain including binutils and GCC. diff --git a/docs/Manpage.md b/docs/Manpage.md index 15a736059d..fac6875943 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -239,11 +239,12 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--cc=``compiler` is passed, attempt to compile using `compiler`. `compiler` should be the name of the compiler's executable, for instance - `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a Homebrew-provided GCC - 4.9. In order to use LLVM's clang, use `llvm_clang`. To specify the - Apple-provided clang, use `clang`. This parameter will only accept - compilers that are provided by Homebrew. Note that this will override - the value set by the `$HOMEBREW_CC` environment variable. + `gcc-8` for gcc 8, `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a + Homebrew-provided GCC 4.9. In order to use LLVM's clang, use + `llvm_clang`. To specify the Apple-provided clang, use `clang`. This + parameter will only accept compilers that are provided by Homebrew or + bundled with MacOS. Please do not file issues if you encounter errors + while using this flag. If `--build-from-source` (or `-s`) is passed, compile the specified `formula` from source even if a bottle is provided. Dependencies will still be installed @@ -1125,15 +1126,6 @@ Note that environment variables must have a value set to be detected. For exampl *Default:* `~/Library/Caches/Homebrew`. - * `HOMEBREW_CC`: - If set, instructs Homebrew to used the specified compiler to build a - package from source. In order to specify the Apple-provided clang, - set `clang`. For the clang provided from the LLVM package, use - `llvm_clang`. For versions of gcc, use the names of the executables from - the packages that Homebrew provides, e.g. for gcc 4.9, `gcc-4.9`, or for - gcc 8, `gcc-8`. Note that this variable can only be set to compilers that - are provided by Homebrew. - * `HOMEBREW_CURLRC`: If set, Homebrew will not pass `-q` when invoking `curl`(1) (which disables the use of `curlrc`). diff --git a/manpages/brew.1 b/manpages/brew.1 index 0cbd60f257..8137c4ad15 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -227,7 +227,7 @@ If \fB\-\-ignore\-dependencies\fR is passed, skip installing any dependencies of If \fB\-\-only\-dependencies\fR is passed, install the dependencies with specified options but do not install the specified formula\. . .IP -If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew\. Note that this will override the value set by the \fB$HOMEBREW_CC\fR environment variable\. +If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-8\fR for gcc 8, \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew or bundled with MacOS\. Please do not file issues if you encounter errors while using this flag\. . .IP If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\. @@ -1069,10 +1069,6 @@ If set, instructs Homebrew to use the given directory as the download cache\. \fIDefault:\fR \fB~/Library/Caches/Homebrew\fR\. . .TP -\fBHOMEBREW_CC\fR -If set, instructs Homebrew to used the specified compiler to build a package from source\. In order to specify the Apple\-provided clang, set \fBclang\fR\. For the clang provided from the LLVM package, use \fBllvm_clang\fR\. For versions of gcc, use the names of the executables from the packages that Homebrew provides, e\.g\. for gcc 4\.9, \fBgcc\-4\.9\fR, or for gcc 8, \fBgcc\-8\fR\. Note that this variable can only be set to compilers that are provided by Homebrew\. -. -.TP \fBHOMEBREW_CURLRC\fR If set, Homebrew will not pass \fB\-q\fR when invoking \fBcurl\fR(1) (which disables the use of \fBcurlrc\fR)\. . From 9579fadad48c73aee0b3e81673600149877ddb15 Mon Sep 17 00:00:00 2001 From: Afnan Enayet Date: Thu, 5 Jul 2018 21:33:29 -0400 Subject: [PATCH 5/7] Strip trailing whitespaces This fixes the rubocop offences, which was blocking Travis --- Library/Homebrew/cmd/install.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index 1ef8f929c3..830a857648 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -21,9 +21,9 @@ #: #: If `--cc=` is passed, attempt to compile using . #: should be the name of the compiler's executable, for instance -#: `gcc-8` for gcc 8, `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a -#: Homebrew-provided GCC 4.9. In order to use LLVM's clang, use -#: `llvm_clang`. To specify the Apple-provided clang, use `clang`. This +#: `gcc-8` for gcc 8, `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a +#: Homebrew-provided GCC 4.9. In order to use LLVM's clang, use +#: `llvm_clang`. To specify the Apple-provided clang, use `clang`. This #: parameter will only accept compilers that are provided by Homebrew or #: bundled with MacOS. Please do not file issues if you encounter errors #: while using this flag. From 75d3ca8e6f89aa67dbd5b891295c4bf6d05b6beb Mon Sep 17 00:00:00 2001 From: Afnan Enayet Date: Thu, 5 Jul 2018 21:45:53 -0400 Subject: [PATCH 6/7] Update man pages to reflect prior change Generate new man pages so that the docs and manpages match up --- docs/Manpage.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Manpage.md b/docs/Manpage.md index fac6875943..65c8468904 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -239,9 +239,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--cc=``compiler` is passed, attempt to compile using `compiler`. `compiler` should be the name of the compiler's executable, for instance - `gcc-8` for gcc 8, `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a - Homebrew-provided GCC 4.9. In order to use LLVM's clang, use - `llvm_clang`. To specify the Apple-provided clang, use `clang`. This + `gcc-8` for gcc 8, `gcc-4.2` for Apple's GCC 4.2, or `gcc-4.9` for a + Homebrew-provided GCC 4.9. In order to use LLVM's clang, use + `llvm_clang`. To specify the Apple-provided clang, use `clang`. This parameter will only accept compilers that are provided by Homebrew or bundled with MacOS. Please do not file issues if you encounter errors while using this flag. From 133c3a3c0b8195b3d82b64ecddcf7a4a34a1c912 Mon Sep 17 00:00:00 2001 From: Afnan Enayet Date: Fri, 6 Jul 2018 23:06:41 -0400 Subject: [PATCH 7/7] Fix typo * change `MacOS` -> `macOS` * regenerate manpages --- Library/Homebrew/cmd/install.rb | 2 +- docs/Manpage.md | 2 +- manpages/brew.1 | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index 830a857648..2acf8cd5da 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -25,7 +25,7 @@ #: Homebrew-provided GCC 4.9. In order to use LLVM's clang, use #: `llvm_clang`. To specify the Apple-provided clang, use `clang`. This #: parameter will only accept compilers that are provided by Homebrew or -#: bundled with MacOS. Please do not file issues if you encounter errors +#: bundled with macOS. Please do not file issues if you encounter errors #: while using this flag. #: #: If `--build-from-source` (or `-s`) is passed, compile the specified from diff --git a/docs/Manpage.md b/docs/Manpage.md index 65c8468904..43979377c9 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -243,7 +243,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note Homebrew-provided GCC 4.9. In order to use LLVM's clang, use `llvm_clang`. To specify the Apple-provided clang, use `clang`. This parameter will only accept compilers that are provided by Homebrew or - bundled with MacOS. Please do not file issues if you encounter errors + bundled with macOS. Please do not file issues if you encounter errors while using this flag. If `--build-from-source` (or `-s`) is passed, compile the specified `formula` from diff --git a/manpages/brew.1 b/manpages/brew.1 index 8137c4ad15..917bb0ce1e 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -227,7 +227,7 @@ If \fB\-\-ignore\-dependencies\fR is passed, skip installing any dependencies of If \fB\-\-only\-dependencies\fR is passed, install the dependencies with specified options but do not install the specified formula\. . .IP -If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-8\fR for gcc 8, \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew or bundled with MacOS\. Please do not file issues if you encounter errors while using this flag\. +If \fB\-\-cc=\fR\fIcompiler\fR is passed, attempt to compile using \fIcompiler\fR\. \fIcompiler\fR should be the name of the compiler\'s executable, for instance \fBgcc\-8\fR for gcc 8, \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2, or \fBgcc\-4\.9\fR for a Homebrew\-provided GCC 4\.9\. In order to use LLVM\'s clang, use \fBllvm_clang\fR\. To specify the Apple\-provided clang, use \fBclang\fR\. This parameter will only accept compilers that are provided by Homebrew or bundled with macOS\. Please do not file issues if you encounter errors while using this flag\. . .IP If \fB\-\-build\-from\-source\fR (or \fB\-s\fR) is passed, compile the specified \fIformula\fR from source even if a bottle is provided\. Dependencies will still be installed from bottles if they are available\.