Document --cc= in the manpage

cmar · Aug 30, 2013 · 6c53c87 · 6c53c87
1 parent 3020f71
commit 6c53c87
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 23 deletions.
diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md
@@ -147,7 +147,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] [--use-clang|--use-gcc|--use-llvm] [--build-from-source] [--devel|--HEAD]` <formula>:
+  * `install [--debug] [--env=<std|super>] [--ignore-dependencies] [--fresh] [--cc=<compiler>] [--use-clang|--use-gcc|--use-llvm] [--build-from-source] [--devel|--HEAD]` <formula>:
     Install <formula>.
 
     <formula> is usually the name of the formula to install, but it can be specified
@@ -169,6 +169,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.
+
     If `--use-clang` is passed, attempt to compile using clang.
 
     If `--use-gcc` is passed, attempt to compile using GCC. This is useful for
@@ -510,15 +514,6 @@ can take several different forms:
     This issue typically occurs when using FileVault or custom SSD
     configurations.
 
-  * HOMEBREW\_USE\_CLANG:
-    If set, forces Homebrew to compile using clang.
-
-  * HOMEBREW\_USE\_GCC:
-    If set, forces Homebrew to compile using gcc.
-
-  * HOMEBREW\_USE\_LLVM:
-    If set, forces Homebrew to compile using LLVM.
-
   * HOMEBREW\_VERBOSE:
     If set, Homebrew always assumes `--verbose` when running commands.
 

diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
@@ -170,7 +170,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] [\-\-use\-clang|\-\-use\-gcc|\-\-use\-llvm] [\-\-build\-from\-source] [\-\-devel|\-\-HEAD]\fR \fIformula\fR
+\fBinstall [\-\-debug] [\-\-env=<std|super>] [\-\-ignore\-dependencies] [\-\-fresh] [\-\-cc=<compiler>] [\-\-use\-clang|\-\-use\-gcc|\-\-use\-llvm] [\-\-build\-from\-source] [\-\-devel|\-\-HEAD]\fR \fIformula\fR
 Install \fIformula\fR\.
 .
 .IP
@@ -192,6 +192,9 @@ 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\.
+.
+.IP
 If \fB\-\-use\-clang\fR is passed, attempt to compile using clang\.
 .
 .IP
@@ -552,18 +555,6 @@ If set, instructs Homebrew to use \fBHOMEBREW_TEMP\fR as the temporary directory
 This issue typically occurs when using FileVault or custom SSD configurations\.
 .
 .TP
-HOMEBREW_USE_CLANG
-If set, forces Homebrew to compile using clang\.
-.
-.TP
-HOMEBREW_USE_GCC
-If set, forces Homebrew to compile using gcc\.
-.
-.TP
-HOMEBREW_USE_LLVM
-If set, forces Homebrew to compile using LLVM\.
-.
-.TP
 HOMEBREW_VERBOSE
 If set, Homebrew always assumes \fB\-\-verbose\fR when running commands\.
 .