From 16496a0b0fd7956922a55d9c816306feb1cd7b98 Mon Sep 17 00:00:00 2001 From: VonUniGE Date: Sat, 8 Jul 2017 00:12:00 +0200 Subject: Update documentation of brew install syntax to match its actual behavior. --- 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 e413bac6f..f4d5dcce7 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -1,4 +1,4 @@ -#: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] : +#: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] [`install-options`]: #: Install . #: #: is usually the name of the formula to install, but it can be specified diff --git a/docs/Manpage.md b/docs/Manpage.md index 583a858c1..02bd35898 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -198,7 +198,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note See the docs for examples of using the JSON output: - * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula`: + * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula` [`install-options`]: Install `formula`. `formula` is usually the name of the formula to install, but it can be specified diff --git a/manpages/brew.1 b/manpages/brew.1 index 3ea05848e..e010cfb4d 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -216,7 +216,7 @@ Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to See the docs for examples of using the JSON output: \fIhttp://docs\.brew\.sh/Querying\-Brew\.html\fR . .TP -\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\fR)] [\fB\-\-ignore\-dependencies\fR|\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] \fIformula\fR +\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\fR)] [\fB\-\-ignore\-dependencies\fR|\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] \fIformula\fR [\fIinstall\-options\fR] Install \fIformula\fR\. . .IP -- cgit v1.2.3 From 7957e1a7215464486bf559d66438e79df6e766ce Mon Sep 17 00:00:00 2001 From: VonUniGE Date: Tue, 11 Jul 2017 23:43:28 +0200 Subject: Add a suitable explanatory line --- Library/Homebrew/cmd/install.rb | 5 ++++- docs/Manpage.md | 5 ++++- manpages/brew.1 | 5 ++++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb index f4d5dcce7..da48582d2 100644 --- a/Library/Homebrew/cmd/install.rb +++ b/Library/Homebrew/cmd/install.rb @@ -1,4 +1,4 @@ -#: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] [`install-options`]: +#: * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] [ ...]: #: Install . #: #: is usually the name of the formula to install, but it can be specified @@ -47,6 +47,9 @@ #: If `--build-bottle` is passed, prepare the formula for eventual bottling #: during installation. #: +#: Installation options specific to may be appended to the command, +#: and can be listed with `brew options` . +#: #: * `install` `--interactive` [`--git`] : #: If `--interactive` (or `-i`) is passed, download and patch , then #: open a shell. This allows the user to run `./configure --help` and diff --git a/docs/Manpage.md b/docs/Manpage.md index 02bd35898..5feb74db6 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -198,7 +198,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note See the docs for examples of using the JSON output: - * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula` [`install-options`]: + * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula` : [<`options`> ...] Install `formula`. `formula` is usually the name of the formula to install, but it can be specified @@ -247,6 +247,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--build-bottle` is passed, prepare the formula for eventual bottling during installation. + Installation options specific to may be appended to the command, + and can be listed with `brew options` . + * `install` `--interactive` [`--git`] `formula`: If `--interactive` (or `-i`) is passed, download and patch `formula`, then open a shell. This allows the user to run `./configure --help` and diff --git a/manpages/brew.1 b/manpages/brew.1 index e010cfb4d..430faa92e 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -216,7 +216,7 @@ Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to See the docs for examples of using the JSON output: \fIhttp://docs\.brew\.sh/Querying\-Brew\.html\fR . .TP -\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\fR)] [\fB\-\-ignore\-dependencies\fR|\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] \fIformula\fR [\fIinstall\-options\fR] +\fBinstall\fR [\fB\-\-debug\fR] [\fB\-\-env=\fR(\fBstd\fR|\fBsuper\fR)] [\fB\-\-ignore\-dependencies\fR|\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR|\fB\-\-force\-bottle\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] [\fB\-\-build\-bottle\fR] \fIformula\fR [\fIoptions\fR \.\.\.] Install \fIformula\fR\. . .IP @@ -261,6 +261,9 @@ If \fB\-\-keep\-tmp\fR is passed, the temporary files created during installatio .IP If \fB\-\-build\-bottle\fR is passed, prepare the formula for eventual bottling during installation\. . +.IP +Installation \fIoptions\fR specific to \fIformula\fR may be appended to the command, and can be listed with \fBbrew options \fR. +. .TP \fBinstall\fR \fB\-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR If \fB\-\-interactive\fR (or \fB\-i\fR) is passed, download and patch \fIformula\fR, then open a shell\. This allows the user to run \fB\./configure \-\-help\fR and otherwise determine how to turn the software package into a Homebrew formula\. -- cgit v1.2.3 From e6974644e0e3e11081aad8fc2ec475040c636ba2 Mon Sep 17 00:00:00 2001 From: VonUniGE Date: Tue, 11 Jul 2017 23:53:49 +0200 Subject: Correct syntax error in Manpage.md --- docs/Manpage.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/Manpage.md b/docs/Manpage.md index 5feb74db6..07207694d 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -198,7 +198,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note See the docs for examples of using the JSON output: - * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula` : [<`options`> ...] + * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula` [<`options`> ...]: Install `formula`. `formula` is usually the name of the formula to install, but it can be specified @@ -247,8 +247,8 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note If `--build-bottle` is passed, prepare the formula for eventual bottling during installation. - Installation options specific to may be appended to the command, - and can be listed with `brew options` . + Installation options specific to `formula` may be appended to the command, + and can be listed with `brew options `. * `install` `--interactive` [`--git`] `formula`: If `--interactive` (or `-i`) is passed, download and patch `formula`, then -- cgit v1.2.3 From 73c7bc70d117016de8b2d07769eb672cd681ccbf Mon Sep 17 00:00:00 2001 From: Mathieu Vonlanthen Date: Thu, 13 Jul 2017 11:15:22 +0200 Subject: Run brew man --- docs/Manpage.md | 4 ++-- manpages/brew-cask.1 | 2 +- manpages/brew.1 | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Manpage.md b/docs/Manpage.md index 07207694d..1ef465fe0 100644 --- a/docs/Manpage.md +++ b/docs/Manpage.md @@ -198,7 +198,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note See the docs for examples of using the JSON output: - * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula` [<`options`> ...]: + * `install` [`--debug`] [`--env=`(`std`|`super`)] [`--ignore-dependencies`|`--only-dependencies`] [`--cc=``compiler`] [`--build-from-source`|`--force-bottle`] [`--devel`|`--HEAD`] [`--keep-tmp`] [`--build-bottle`] `formula` [`options` ...]: Install `formula`. `formula` is usually the name of the formula to install, but it can be specified @@ -248,7 +248,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note during installation. Installation options specific to `formula` may be appended to the command, - and can be listed with `brew options `. + and can be listed with `brew options` `formula`. * `install` `--interactive` [`--git`] `formula`: If `--interactive` (or `-i`) is passed, download and patch `formula`, then diff --git a/manpages/brew-cask.1 b/manpages/brew-cask.1 index 49be14c57..f11d48c09 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 2017" "Homebrew" "brew-cask" +.TH "BREW\-CASK" "1" "July 2017" "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 430faa92e..6713c6b7e 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 2017" "Homebrew" "brew" +.TH "BREW" "1" "July 2017" "Homebrew" "brew" . .SH "NAME" \fBbrew\fR \- The missing package manager for macOS @@ -262,7 +262,7 @@ If \fB\-\-keep\-tmp\fR is passed, the temporary files created during installatio If \fB\-\-build\-bottle\fR is passed, prepare the formula for eventual bottling during installation\. . .IP -Installation \fIoptions\fR specific to \fIformula\fR may be appended to the command, and can be listed with \fBbrew options \fR. +Installation options specific to \fIformula\fR may be appended to the command, and can be listed with \fBbrew options\fR \fIformula\fR\. . .TP \fBinstall\fR \fB\-\-interactive\fR [\fB\-\-git\fR] \fIformula\fR -- cgit v1.2.3