diff --git a/Library/Homebrew/cmd/audit.rb b/Library/Homebrew/cmd/audit.rb index 464b9c020a..0845faeb3b 100644 --- a/Library/Homebrew/cmd/audit.rb +++ b/Library/Homebrew/cmd/audit.rb @@ -9,11 +9,11 @@ #: #: If `--online` is passed, additional slower checks that require a network #: connection are run. -# +#: #: If `--new-formula` is passed, various additional checks are run that check #: if a new formula is eligable for Homebrew. This should be used when creating #: new formulae and implies `--strict` and `--online`. -# +#: #: If `--display-cop-names` is passed, the RuboCop cop name for each violation #: is included in the output. #: diff --git a/Library/Homebrew/cmd/gist-logs.rb b/Library/Homebrew/cmd/gist-logs.rb index bcb15cd144..2c60129d13 100644 --- a/Library/Homebrew/cmd/gist-logs.rb +++ b/Library/Homebrew/cmd/gist-logs.rb @@ -1,13 +1,13 @@ #: * `gist-logs` [`--new-issue`|`-n`] : -#: Upload logs for a failed build of to a new Gist. +#: Upload logs for a failed build of to a new Gist. #: -#: is usually the name of the formula to install, but it can be specified -#: in several different ways. See [SPECIFYING FORMULAE][]. +#: is usually the name of the formula to install, but it can be specified +#: in several different ways. See [SPECIFYING FORMULAE][]. #: -#: If `--new-issue` is passed, automatically create a new issue in the appropriate -#: GitHub repository as well as creating the Gist. +#: If `--new-issue` is passed, automatically create a new issue in the appropriate +#: GitHub repository as well as creating the Gist. #: -#: If no logs are found, an error message is presented. +#: If no logs are found, an error message is presented. require "formula" require "system_config" diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb index eefad0ac95..80576033a3 100644 --- a/Library/Homebrew/cmd/list.rb +++ b/Library/Homebrew/cmd/list.rb @@ -1,8 +1,7 @@ #: * `list`, `ls` [`--full-name`]: -#: List all installed formulae. If `--full-name` is passed, print formulae with -#: fully-qualified names. -#: If `--full-name` is not passed any other options (e.g. `-t`) are passed to -#: `ls` which produces the actual output. +#: List all installed formulae. If `--full-name` is passed, print formulae +#: with fully-qualified names. If `--full-name` is not passed, any other +#: options (e.g. `-t`) are passed to `ls` which produces the actual output. #: #: * `list`, `ls` `--unbrewed`: #: List all files in the Homebrew prefix not installed by Homebrew. diff --git a/Library/Homebrew/cmd/log.rb b/Library/Homebrew/cmd/log.rb index e2dd08d7c4..a07107170a 100644 --- a/Library/Homebrew/cmd/log.rb +++ b/Library/Homebrew/cmd/log.rb @@ -1,4 +1,4 @@ -#: * `log` [`git-log-options`] ...: +#: * `log` [] ...: #: Show the git log for the given formulae. Options that `git-log`(1) #: recognizes can be passed before the formula list. diff --git a/Library/Homebrew/cmd/missing.rb b/Library/Homebrew/cmd/missing.rb index 41ad4f16d5..181530562d 100644 --- a/Library/Homebrew/cmd/missing.rb +++ b/Library/Homebrew/cmd/missing.rb @@ -1,7 +1,6 @@ #: * `missing` []: -#: Check the given for missing dependencies. -#: -#: If no are given, check all installed brews. +#: Check the given for missing dependencies. If no are +#: given, check all installed brews. require "formula" require "tab" diff --git a/Library/Homebrew/cmd/reinstall.rb b/Library/Homebrew/cmd/reinstall.rb index a7bbef32da..e98e906f6a 100644 --- a/Library/Homebrew/cmd/reinstall.rb +++ b/Library/Homebrew/cmd/reinstall.rb @@ -1,5 +1,5 @@ #: * `reinstall` : -#: Uninstall then install +#: Uninstall and then install . require "formula_installer" require "development_tools" diff --git a/Library/Homebrew/cmd/update.sh b/Library/Homebrew/cmd/update.sh index ba43fd6d14..dbd1a4de83 100644 --- a/Library/Homebrew/cmd/update.sh +++ b/Library/Homebrew/cmd/update.sh @@ -1,11 +1,12 @@ -#: * `update` [`--merge`]: +#: * `update` [`--merge`] [`--force`]: #: Fetch the newest version of Homebrew and all formulae from GitHub using -#: `git`(1). +#: `git`(1). #: #: If `--merge` is specified then `git merge` is used to include updates -#: (rather than `git rebase`). +#: (rather than `git rebase`). +#: #: If `--force` is specified then always do a slower, full update check even -#: if unnecessary. +#: if unnecessary. # Hide shellcheck complaint: # shellcheck source=/dev/null diff --git a/Library/Homebrew/dev-cmd/bump-formula-pr.rb b/Library/Homebrew/dev-cmd/bump-formula-pr.rb index bd27a569c2..d875e42ace 100644 --- a/Library/Homebrew/dev-cmd/bump-formula-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-formula-pr.rb @@ -1,6 +1,5 @@ #: * `bump-formula-pr` [`--devel`] [`--dry-run`] `--url=` `--sha256=` : #: * `bump-formula-pr` [`--devel`] [`--dry-run`] `--tag=` `--revision=` : -#: #: Creates a pull request to update the formula with a new url or a new tag. #: #: If a is specified, the checksum of the new download must diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html index 07fa7c5256..2f4de59063 100644 --- a/share/doc/homebrew/brew.1.html +++ b/share/doc/homebrew/brew.1.html @@ -48,11 +48,13 @@ run before submitting a new formula.

style checks.

If --online is passed, additional slower checks that require a network -connection are run. -If --new-formula is passed, various additional checks are run that check +connection are run.

+ +

If --new-formula is passed, various additional checks are run that check if a new formula is eligable for Homebrew. This should be used when creating -new formulae and implies --strict and --online. -If --display-cop-names is passed, the RuboCop cop name for each violation +new formulae and implies --strict and --online.

+ +

If --display-cop-names is passed, the RuboCop cop name for each violation is included in the output.

If --display-filename is passed, every line of output is prefixed with the @@ -168,15 +170,15 @@ bottle.

If --force-bottle is passed, download a bottle if it exists for the current version of OS X, even if it would not be used during installation.

-
gist-logs [--new-issue|-n] formula

Upload logs for a failed build of formula to a new Gist.

+
gist-logs [--new-issue|-n] formula

Upload logs for a failed build of formula to a new Gist.

-

formula is usually the name of the formula to install, but it can be specified - in several different ways. See SPECIFYING FORMULAE.

+

formula is usually the name of the formula to install, but it can be specified +in several different ways. See SPECIFYING FORMULAE.

-

If --new-issue is passed, automatically create a new issue in the appropriate - GitHub repository as well as creating the Gist.

+

If --new-issue is passed, automatically create a new issue in the appropriate +GitHub repository as well as creating the Gist.

-

If no logs are found, an error message is presented.

+

If no logs are found, an error message is presented.

home

Open Homebrew's own homepage in a browser.

home formula

Open formula's homepage in a browser.

info formula

Display information about formula.

@@ -263,10 +265,9 @@ into /Applications, allowing for easier access.

If provided, --local will symlink them into the user's ~/Applications directory instead of the system directory.

-
list, ls [--full-name]

List all installed formulae. If --full-name is passed, print formulae with -fully-qualified names. -If --full-name is not passed any other options (e.g. -t) are passed to -ls which produces the actual output.

+
list, ls [--full-name]

List all installed formulae. If --full-name is passed, print formulae +with fully-qualified names. If --full-name is not passed, any other +options (e.g. -t) are passed to ls which produces the actual output.

list, ls --unbrewed

List all files in the Homebrew prefix not installed by Homebrew.

list, ls [--versions [--multiple]] [--pinned] [formulae]

List the installed files for formulae. Combined with --verbose, recursively list the contents of all subdirectories in each formula's keg.

@@ -278,16 +279,15 @@ only show formulae with multiple versions installed.

If --pinned is passed, show the versions of pinned formulae, or only the specified (pinned) formulae if formulae are given. See also pin, unpin.

-
log [git-log-options] formula ...

Show the git log for the given formulae. Options that git-log(1) +

log [git-log-options] formula ...

Show the git log for the given formulae. Options that git-log(1) recognizes can be passed before the formula list.

migrate [--force] formulae

Migrate renamed packages to new name, where formulae are old names of packages.

If --force is passed, then treat installed formulae and passed formulae like if they are from same taps and migrate them anyway.

-
missing [formulae]

Check the given formulae for missing dependencies.

- -

If no formulae are given, check all installed brews.

+
missing [formulae]

Check the given formulae for missing dependencies. If no formulae are +given, check all installed brews.

options [--compact] (--all|--installed|formulae)

Display install options specific to formulae.

If --compact is passed, show all options on a single line separated by @@ -322,7 +322,7 @@ created by brew linkapps.

If --dry-run or -n is passed, show what would be removed, but do not actually remove anything.

-
reinstall formula

Uninstall then install formula

+
reinstall formula

Uninstall and then install formula.

search, -S

Display all locally available formulae for brewing (including tapped ones). No online search is performed if called without arguments.

search [--desc] text|/text/

Perform a substring search of formula names for text. If text is @@ -438,13 +438,14 @@ source. This is useful for creating patches for the software.

unpin formulae

Unpin formulae, allowing them to be upgraded by brew upgrade. See also pin.

untap tap

Remove a tapped repository.

-
update [--merge]

Fetch the newest version of Homebrew and all formulae from GitHub using - git(1).

+
update [--merge] [--force]

Fetch the newest version of Homebrew and all formulae from GitHub using +git(1).

If --merge is specified then git merge is used to include updates - (rather than git rebase). -If --force is specified then always do a slower, full update check even - if unnecessary.

+(rather than git rebase).

+ +

If --force is specified then always do a slower, full update check even +if unnecessary.

upgrade [install-options] [--cleanup] [--fetch-HEAD] [formulae]

Upgrade outdated, unpinned brews.

Options for the install command are also valid here.

diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1 index 15d3a9841b..66a4736fdd 100644 --- a/share/man/man1/brew.1 +++ b/share/man/man1/brew.1 @@ -66,7 +66,13 @@ If no \fIformulae\fR are provided, all of them are checked\. If \fB\-\-strict\fR is passed, additional checks are run, including RuboCop style checks\. . .IP -If \fB\-\-online\fR is passed, additional slower checks that require a network connection are run\. If \fB\-\-new\-formula\fR is passed, various additional checks are run that check if a new formula is eligable for Homebrew\. This should be used when creating new formulae and implies \fB\-\-strict\fR and \fB\-\-online\fR\. If \fB\-\-display\-cop\-names\fR is passed, the RuboCop cop name for each violation is included in the output\. +If \fB\-\-online\fR is passed, additional slower checks that require a network connection are run\. +. +.IP +If \fB\-\-new\-formula\fR is passed, various additional checks are run that check if a new formula is eligable for Homebrew\. This should be used when creating new formulae and implies \fB\-\-strict\fR and \fB\-\-online\fR\. +. +.IP +If \fB\-\-display\-cop\-names\fR is passed, the RuboCop cop name for each violation is included in the output\. . .IP If \fB\-\-display\-filename\fR is passed, every line of output is prefixed with the name of the file or formula being audited, to make the output easy to grep\. @@ -344,7 +350,7 @@ If provided, \fB\-\-local\fR will symlink them into the user\'s \fB~/Application . .TP \fBlist\fR, \fBls\fR [\fB\-\-full\-name\fR] -List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with fully\-qualified names\. If \fB\-\-full\-name\fR is not passed any other options (e\.g\. \fB\-t\fR) are passed to \fBls\fR which produces the actual output\. +List all installed formulae\. If \fB\-\-full\-name\fR is passed, print formulae with fully\-qualified names\. If \fB\-\-full\-name\fR is not passed, any other options (e\.g\. \fB\-t\fR) are passed to \fBls\fR which produces the actual output\. . .TP \fBlist\fR, \fBls\fR \fB\-\-unbrewed\fR @@ -361,7 +367,7 @@ If \fB\-\-versions\fR is passed, show the version number for installed formulae, If \fB\-\-pinned\fR is passed, show the versions of pinned formulae, or only the specified (pinned) formulae if \fIformulae\fR are given\. See also \fBpin\fR, \fBunpin\fR\. . .TP -\fBlog\fR [\fBgit\-log\-options\fR] \fIformula\fR \.\.\. +\fBlog\fR [\fIgit\-log\-options\fR] \fIformula\fR \.\.\. Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\. . .TP @@ -373,10 +379,7 @@ If \fB\-\-force\fR is passed, then treat installed \fIformulae\fR and passed \fI . .TP \fBmissing\fR [\fIformulae\fR] -Check the given \fIformulae\fR for missing dependencies\. -. -.IP -If no \fIformulae\fR are given, check all installed brews\. +Check the given \fIformulae\fR for missing dependencies\. If no \fIformulae\fR are given, check all installed brews\. . .TP \fBoptions\fR [\fB\-\-compact\fR] (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR) @@ -423,7 +426,7 @@ If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, show what would be removed, but do . .TP \fBreinstall\fR \fIformula\fR -Uninstall then install \fIformula\fR +Uninstall and then install \fIformula\fR\. . .TP \fBsearch\fR, \fB\-S\fR @@ -593,11 +596,14 @@ Unpin \fIformulae\fR, allowing them to be upgraded by \fBbrew upgrade\fR\. See a Remove a tapped repository\. . .TP -\fBupdate\fR [\fB\-\-merge\fR] +\fBupdate\fR [\fB\-\-merge\fR] [\fB\-\-force\fR] Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1)\. . .IP -If \fB\-\-merge\fR is specified then \fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\. If \fB\-\-force\fR is specified then always do a slower, full update check even if unnecessary\. +If \fB\-\-merge\fR is specified then \fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\. +. +.IP +If \fB\-\-force\fR is specified then always do a slower, full update check even if unnecessary\. . .TP \fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fB\-\-fetch\-HEAD\fR] [\fIformulae\fR]