From e8ebd6756e45cbc2e6fae7f30f03f51ee320fe94 Mon Sep 17 00:00:00 2001 From: Adam Vandenberg Date: Thu, 16 Jun 2011 20:50:40 -0700 Subject: [PATCH] Add clang options to man page. --- Library/Contributions/manpages/brew.1.md | 17 ++++++++++------- share/man/man1/brew.1 | 15 +++++++++++---- 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/Library/Contributions/manpages/brew.1.md b/Library/Contributions/manpages/brew.1.md index 5272f62ef2..dd174085fc 100644 --- a/Library/Contributions/manpages/brew.1.md +++ b/Library/Contributions/manpages/brew.1.md @@ -116,7 +116,7 @@ For the full command list, see the COMMANDS section. * `info` : Print the name and version that will be detected for . - * `install [--force] [--debug] [--ignore-dependencies] [--use-llvm] [--use-gcc] [--HEAD]` : + * `install [--force] [--debug] [--ignore-dependencies] [--use-clang] [--use-gcc] [--use-llvm] [--HEAD]` : Install . is usually the name of the formula to install, but may also be @@ -133,12 +133,14 @@ For the full command list, see the COMMANDS section. any kind. If they are not already present, the formula will probably fail to install. - If `--use-llvm` is passed, attempt to compile using the LLVM front-end to GCC. - *NOTE*: Not all formulae will build with LLVM. + 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 `--HEAD` is passed, and defines it, install the HEAD version, aka master, trunk, unstable, dev. @@ -324,13 +326,14 @@ Some sample commands ship with Homebrew and are enabled by default. This issue typically occurs when using FileVault or custom SSD configurations. + * HOMEBREW\_USE\_CLANG: + If set, instructs Homebrew to compile using clang. + * HOMEBREW\_USE\_GCC: - If set, instructs Homebrew to use gcc, even if the system default - is currently set to LLVM. + If set, instructs Homebrew to compile using gcc. * HOMEBREW\_USE\_LLVM: - If set, instructs Homebrew to use the LLVM front-ends to the GCC - compilers. + If set, instructs Homebrew to compile using LLVM. *NOTE*: Not all formulae build correctly with LLVM. diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index 0975d3b8c4..305a630162 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -136,7 +136,7 @@ To view formula history locally: \fBbrew log \-p \fR\. Print the name and version that will be detected for \fIURL\fR\. . .TP -\fBinstall [\-\-force] [\-\-debug] [\-\-ignore\-dependencies] [\-\-use\-llvm] [\-\-use\-gcc] [\-\-HEAD]\fR \fIformula\fR +\fBinstall [\-\-force] [\-\-debug] [\-\-ignore\-dependencies] [\-\-use\-clang] [\-\-use\-gcc] [\-\-use\-llvm] [\-\-HEAD]\fR \fIformula\fR Install \fIformula\fR\. . .IP @@ -152,12 +152,15 @@ If \fB\-\-debug\fR is passed and brewing fails, open a shell inside the temporar If \fB\-\-ignore\-dependencies\fR is passed, skip installing any dependencies of any kind\. If they are not already present, the formula will probably fail to install\. . .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\-\-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\. +. +.IP If \fB\-\-HEAD\fR is passed, and \fIformula\fR defines it, install the HEAD version, aka master, trunk, unstable, dev\. . .IP @@ -355,12 +358,16 @@ If set, instructs Homebrew to use \fBHOMEBREW_TEMP\fR as the temporary folder fo This issue typically occurs when using FileVault or custom SSD configurations\. . .TP +HOMEBREW_USE_CLANG +If set, instructs Homebrew to compile using clang\. +. +.TP HOMEBREW_USE_GCC -If set, instructs Homebrew to use gcc, even if the system default is currently set to LLVM\. +If set, instructs Homebrew to compile using gcc\. . .TP HOMEBREW_USE_LLVM -If set, instructs Homebrew to use the LLVM front\-ends to the GCC compilers\. +If set, instructs Homebrew to compile using LLVM\. . .IP \fINOTE\fR: Not all formulae build correctly with LLVM\.