Undocument --use-gcc and friends

These options are deprecated in favor of --cc=<compiler>, so there is no
need to continue advertising their existence.
This commit is contained in:
Jack Nagel 2013-11-03 11:45:26 -06:00
parent a2d9271bda
commit 4e2c45f5d1
2 changed files with 8 additions and 26 deletions

View File

@ -151,7 +151,7 @@ Note that these flags should only appear after a command.
* `info` <URL>:
Print the name and version that will be detected for <URL>.
* `install [--debug] [--env=<std|super>] [--ignore-dependencies] [--fresh] [--cc=<compiler>] [--use-clang|--use-gcc|--use-llvm] [--build-from-source] [--devel|--HEAD]` <formula>:
* `install [--debug] [--env=<std|super>] [--ignore-dependencies] [--fresh] [--cc=<compiler>] [--build-from-source] [--devel|--HEAD]` <formula>:
Install <formula>.
<formula> is usually the name of the formula to install, but it can be specified
@ -173,19 +173,10 @@ Note that these flags should only appear after a command.
If `--fresh` is passed, the installation process will not re-use any
options from previous installs.
If `--cc=<compiler>` is passed, attempt to compile using the specified
compiler. The specified argument should be the name of the compiler's
executable, for instance `gcc-4.2` for Apple's GCC 4.2.
This option is the only way to select a non-Apple compiler; for instance,
to build using a Homebrew-provided GCC 4.8, use `--cc=gcc-4.8`
If `--use-clang` is passed, attempt to compile using clang.
If `--use-gcc` is passed, attempt to compile using GCC. This is useful for
systems whose default compiler is LLVM-GCC.
If `--use-llvm` is passed, attempt to compile using the LLVM front-end to GCC.
*NOTE*: Not all formulae will build with LLVM.
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.8` for a Homebrew-provided GCC
4.8.
If `--build-from-source` is passed, compile from source even if a bottle
is provided for <formula>.

View File

@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "BREW" "1" "October 2013" "Homebrew" "brew"
.TH "BREW" "1" "November 2013" "Homebrew" "brew"
.
.SH "NAME"
\fBbrew\fR \- The missing package manager for OS X
@ -174,7 +174,7 @@ To view formula history locally: \fBbrew log \-p <formula>\fR\.
Print the name and version that will be detected for \fIURL\fR\.
.
.TP
\fBinstall [\-\-debug] [\-\-env=<std|super>] [\-\-ignore\-dependencies] [\-\-fresh] [\-\-cc=<compiler>] [\-\-use\-clang|\-\-use\-gcc|\-\-use\-llvm] [\-\-build\-from\-source] [\-\-devel|\-\-HEAD]\fR \fIformula\fR
\fBinstall [\-\-debug] [\-\-env=<std|super>] [\-\-ignore\-dependencies] [\-\-fresh] [\-\-cc=<compiler>] [\-\-build\-from\-source] [\-\-devel|\-\-HEAD]\fR \fIformula\fR
Install \fIformula\fR\.
.
.IP
@ -196,16 +196,7 @@ If \fB\-\-ignore\-dependencies\fR is passed, skip installing any dependencies of
If \fB\-\-fresh\fR is passed, the installation process will not re\-use any options from previous installs\.
.
.IP
If \fB\-\-cc=<compiler>\fR is passed, attempt to compile using the specified compiler\. The specified argument should be the name of the compiler\'s executable, for instance \fBgcc\-4\.2\fR for Apple\'s GCC 4\.2\. This option is the only way to select a non\-Apple compiler; for instance, to build using a Homebrew\-provided GCC 4\.8, use \fB\-\-cc=gcc\-4\.8\fR
.
.IP
If \fB\-\-use\-clang\fR is passed, attempt to compile using clang\.
.
.IP
If \fB\-\-use\-gcc\fR is passed, attempt to compile using GCC\. This is useful for systems whose default compiler is LLVM\-GCC\.
.
.IP
If \fB\-\-use\-llvm\fR is passed, attempt to compile using the LLVM front\-end to GCC\. \fINOTE\fR: Not all formulae will build with LLVM\.
If \fB\-\-cc=<compiler>\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\.8\fR for a Homebrew\-provided GCC 4\.8\.
.
.IP
If \fB\-\-build\-from\-source\fR is passed, compile from source even if a bottle is provided for \fIformula\fR\.