diff --git a/Library/Homebrew/cmd/cleanup.rb b/Library/Homebrew/cmd/cleanup.rb index 5b46e08724..126309579e 100644 --- a/Library/Homebrew/cmd/cleanup.rb +++ b/Library/Homebrew/cmd/cleanup.rb @@ -7,7 +7,7 @@ #: If `--dry-run` or `-n` is passed, show what would be removed, but do not #: actually remove anything. #: -#: If `-s` is passed, scrubs the cache, removing downloads for even the latest +#: If `-s` is passed, scrub the cache, removing downloads for even the latest #: versions of formulae. Note downloads for any installed formulae will still not be #: deleted. If you want to delete those too: `rm -rf $(brew --cache)` diff --git a/Library/Homebrew/cmd/desc.rb b/Library/Homebrew/cmd/desc.rb index 3ef02288bd..53291602e1 100644 --- a/Library/Homebrew/cmd/desc.rb +++ b/Library/Homebrew/cmd/desc.rb @@ -1,11 +1,10 @@ #: * `desc` : #: Display 's name and one-line description. #: -#: * `desc` [`-s`|`-n`|`-d`] : +#: * `desc` [`-s`|`-n`|`-d`] (|`/``/`): #: Search both name and description (`-s`), just the names (`-n`), or just the -#: descriptions (`-d`) for ``. `` is by default interpreted -#: as a literal string; if flanked by slashes, it is instead interpreted as a -#: regular expression. Formula descriptions are cached; the cache is created on +#: descriptions (`-d`) for . If is flanked by slashes, it is interpreted +#: as a regular expression. Formula descriptions are cached; the cache is created on #: the first search, making that search slower than subsequent ones. require "descriptions" diff --git a/Library/Homebrew/cmd/info.rb b/Library/Homebrew/cmd/info.rb index 1850ae003e..b06d994666 100644 --- a/Library/Homebrew/cmd/info.rb +++ b/Library/Homebrew/cmd/info.rb @@ -4,7 +4,7 @@ #: * `info` `--github` : #: Open a browser to the GitHub History page for formula . #: -#: To view formula history locally: `brew log -p `. +#: To view formula history locally: `brew log -p ` #: #: * `info` `--json=` (`--all`|`--installed`|): #: Print a JSON representation of . Currently the only accepted value @@ -13,7 +13,7 @@ #: Pass `--all` to get information on all formulae, or `--installed` to get #: information on all installed formulae. #: -#: See the docs for examples of using the JSON: +#: See the docs for examples of using the JSON output: #: require "blacklist" diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb index 9ed7a0f79a..a18f4e3998 100644 --- a/Library/Homebrew/cmd/outdated.rb +++ b/Library/Homebrew/cmd/outdated.rb @@ -1,4 +1,4 @@ -#: * `outdated` [`--quiet`|`--verbose`|`--json=v1`] [`--fetch-HEAD`]: +#: * `outdated` [`--quiet`|`--verbose`|`--json=`] [`--fetch-HEAD`]: #: Show formulae that have an updated version available. #: #: By default, version information is displayed in interactive shells, and diff --git a/Library/Homebrew/cmd/readall.rb b/Library/Homebrew/cmd/readall.rb index 7c1a085c9b..3591e0c09a 100644 --- a/Library/Homebrew/cmd/readall.rb +++ b/Library/Homebrew/cmd/readall.rb @@ -4,7 +4,7 @@ #: #: This can be useful for debugging issues across all formulae #: when making significant changes to `formula.rb`, -#: or to determine if any current formulae have Ruby issues +#: or to determine if any current formulae have Ruby issues. require "readall" diff --git a/Library/Homebrew/cmd/search.rb b/Library/Homebrew/cmd/search.rb index d69164eb95..e834a00b55 100644 --- a/Library/Homebrew/cmd/search.rb +++ b/Library/Homebrew/cmd/search.rb @@ -2,7 +2,7 @@ #: Display all locally available formulae for brewing (including tapped ones). #: No online search is performed if called without arguments. #: -#: * `search` [`--desc`] |`/``/`: +#: * `search` [`--desc`] (|`/``/`): #: Perform a substring search of formula names for . If is #: surrounded with slashes, then it is interpreted as a regular expression. #: The search for is extended online to some popular taps. diff --git a/Library/Homebrew/cmd/tap-info.rb b/Library/Homebrew/cmd/tap-info.rb index b46de30c12..225b70097b 100644 --- a/Library/Homebrew/cmd/tap-info.rb +++ b/Library/Homebrew/cmd/tap-info.rb @@ -12,7 +12,7 @@ #: #: Pass `--installed` to get information on installed taps. #: -#: See the docs for examples of using the JSON: +#: See the docs for examples of using the JSON output: #: require "tap" diff --git a/Library/Homebrew/cmd/unlink.rb b/Library/Homebrew/cmd/unlink.rb index a105f9c56e..3f858b2c45 100644 --- a/Library/Homebrew/cmd/unlink.rb +++ b/Library/Homebrew/cmd/unlink.rb @@ -1,7 +1,7 @@ #: * `unlink` [`--dry-run`] : #: Remove symlinks for from the Homebrew prefix. This can be useful #: for temporarily disabling a formula: -#: `brew unlink foo && commands && brew link foo`. +#: `brew unlink && && brew link ` #: #: If `--dry-run` or `-n` is passed, Homebrew will list all files which would #: be unlinked, but will not actually unlink or delete any files. diff --git a/Library/Homebrew/cmd/unpack.rb b/Library/Homebrew/cmd/unpack.rb index 4e6584e70b..60d796d9f3 100644 --- a/Library/Homebrew/cmd/unpack.rb +++ b/Library/Homebrew/cmd/unpack.rb @@ -1,7 +1,7 @@ #: * `unpack` [`--git`|`--patch`] [`--destdir=`] : #: Unpack the source files for into subdirectories of the current #: working directory. If `--destdir=` is given, the subdirectories will -#: be created in the directory named by `` instead. +#: be created in the directory named by instead. #: #: If `--patch` is passed, patches for will be applied to the #: unpacked source. diff --git a/Library/Homebrew/cmd/uses.rb b/Library/Homebrew/cmd/uses.rb index 5f6611dfc5..b1122c90a7 100644 --- a/Library/Homebrew/cmd/uses.rb +++ b/Library/Homebrew/cmd/uses.rb @@ -12,8 +12,8 @@ #: `--include-build`. Similarly, pass `--include-optional` to include `:optional` #: dependencies. To skip `:recommended` type dependencies, pass `--skip-recommended`. #: -#: By default, `uses` shows usages of `formula` by stable builds. To find -#: cases where `formula` is used by development or HEAD build, pass +#: By default, `uses` shows usages of by stable builds. To find +#: cases where is used by development or HEAD build, pass #: `--devel` or `--HEAD`. require "formula" diff --git a/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb b/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb index 3066d2ee6b..7531ef9cf5 100644 --- a/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb +++ b/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb @@ -1,5 +1,5 @@ #: @hide_from_man_page -#: * `boneyard-formula-pr` [`--dry-run`] [`--local`] [`--reason=`] : +#: * `boneyard-formula-pr` [`--dry-run`] [`--local`] [`--reason=`] : #: Creates a pull request to boneyard a formula. #: #: If `--dry-run` is passed, print what would be done rather than doing it. diff --git a/Library/Homebrew/dev-cmd/bottle.rb b/Library/Homebrew/dev-cmd/bottle.rb index 7367e5c372..91bdcba93d 100644 --- a/Library/Homebrew/dev-cmd/bottle.rb +++ b/Library/Homebrew/dev-cmd/bottle.rb @@ -1,6 +1,5 @@ -#: * `bottle` [`--verbose`] [`--no-rebuild`] [`--keep-old`] [`--skip-relocation`] [`--root-url=`] [`--force-core-tap`]: +#: * `bottle` [`--verbose`] [`--no-rebuild`] [`--keep-old`] [`--skip-relocation`] [`--root-url=`] [`--force-core-tap`]: #: * `bottle` `--merge` [`--no-commit`] [`--keep-old`] [`--write`]: -#: #: Generate a bottle (binary package) from a formula installed with #: `--build-bottle`. diff --git a/Library/Homebrew/dev-cmd/bump-formula-pr.rb b/Library/Homebrew/dev-cmd/bump-formula-pr.rb index bfe9c77767..6c7b7d5b5e 100644 --- a/Library/Homebrew/dev-cmd/bump-formula-pr.rb +++ b/Library/Homebrew/dev-cmd/bump-formula-pr.rb @@ -1,8 +1,7 @@ -#: * `bump-formula-pr` [`--devel`] [`--dry-run`] [`--audit`|`--strict`] [`--message=`] `--url=` `--sha256=` : -#: * `bump-formula-pr` [`--devel`] [`--dry-run`] [`--audit`|`--strict`] [`--message=`] `--tag=` `--revision=` : -#: Creates a pull request to update the formula with a new url or a new tag. +#: * `bump-formula-pr` [`--devel`] [`--dry-run` [`--write`]] [`--audit`|`--strict`] [`--mirror=`] [`--version=`] [`--message=`] (`--url=` `--sha256=`|`--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 +#: If a is specified, the checksum of the new download must #: also be specified. A best effort to determine the and #: name will be made if either or both values are not supplied by the user. #: @@ -21,17 +20,17 @@ #: #: If `--strict` is passed, run `brew audit --strict` before opening the PR. #: -#: If `--mirror=` is passed, use the value as a mirror url. +#: If `--mirror=` is passed, use the value as a mirror URL. #: #: If `--version=` is passed, use the value to override the value -#: parsed from the url or tag. Note that `--version=0` can be used to delete +#: parsed from the URL or tag. Note that `--version=0` can be used to delete #: an existing `version` override from a formula if it has become redundant. #: #: If `--message=` is passed, append to the default PR #: message. #: #: Note that this command cannot be used to transition a formula from a -#: url-and-sha256 style specification into a tag-and-revision style +#: URL-and-sha256 style specification into a tag-and-revision style #: specification, nor vice versa. It must use whichever style specification #: the preexisting formula already uses. diff --git a/Library/Homebrew/dev-cmd/create.rb b/Library/Homebrew/dev-cmd/create.rb index b4cda0fad5..9c58dc71a3 100644 --- a/Library/Homebrew/dev-cmd/create.rb +++ b/Library/Homebrew/dev-cmd/create.rb @@ -3,8 +3,7 @@ #: Homebrew will attempt to automatically derive the formula name #: and version, but if it fails, you'll have to make your own template. The `wget` #: formula serves as a simple example. For the complete API have a look at -#: -#: +#: . #: #: If `--autotools` is passed, create a basic template for an Autotools-style build. #: If `--cmake` is passed, create a basic template for a CMake-style build. diff --git a/Library/Homebrew/dev-cmd/formula.rb b/Library/Homebrew/dev-cmd/formula.rb index 71687dfa78..67d11edce2 100644 --- a/Library/Homebrew/dev-cmd/formula.rb +++ b/Library/Homebrew/dev-cmd/formula.rb @@ -1,5 +1,5 @@ #: * `formula` : -#: Display the path where is +#: Display the path where is located. require "formula" diff --git a/Library/Homebrew/dev-cmd/linkage.rb b/Library/Homebrew/dev-cmd/linkage.rb index 44e0f224ee..e4da827f24 100644 --- a/Library/Homebrew/dev-cmd/linkage.rb +++ b/Library/Homebrew/dev-cmd/linkage.rb @@ -1,4 +1,4 @@ -#: * `linkage` [`--test`] [`--reverse`] : +#: * `linkage` [`--test`] [`--reverse`] : #: Checks the library links of an installed formula. #: #: Only works on installed formulae. An error is raised if it is run on diff --git a/Library/Homebrew/dev-cmd/mirror.rb b/Library/Homebrew/dev-cmd/mirror.rb index bd5868726f..10811493c2 100644 --- a/Library/Homebrew/dev-cmd/mirror.rb +++ b/Library/Homebrew/dev-cmd/mirror.rb @@ -1,5 +1,5 @@ #: @hide_from_man_page -#: * `mirror` [`--test`] [ ...]: +#: * `mirror` [`--test`] : #: Reuploads the stable URL for a formula to Bintray to use it as a mirror. module Homebrew diff --git a/Library/Homebrew/dev-cmd/release-notes.rb b/Library/Homebrew/dev-cmd/release-notes.rb index 9192437648..eb398fcfb9 100644 --- a/Library/Homebrew/dev-cmd/release-notes.rb +++ b/Library/Homebrew/dev-cmd/release-notes.rb @@ -1,7 +1,7 @@ -#: * `release-notes` [] []: +#: * `release-notes` [`--markdown`] [] []: #: Output the merged pull requests on Homebrew/brew between two Git refs. -#: If no `previous_tag` is provided it defaults to the newest tag. -#: If no `end_ref` is provided it defaults to `origin/master`. +#: If no is provided it defaults to the newest tag. +#: If no is provided it defaults to `origin/master`. #: #: If `--markdown` is passed, output as a Markdown list. diff --git a/Library/Homebrew/dev-cmd/tests.rb b/Library/Homebrew/dev-cmd/tests.rb index 6276d1c1b7..0c8621a01d 100644 --- a/Library/Homebrew/dev-cmd/tests.rb +++ b/Library/Homebrew/dev-cmd/tests.rb @@ -1,4 +1,4 @@ -#: * `tests` [`-v`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=`] [`--seed` ] [`--trace`] [`--online`] [`--official-cmd-taps`]: +#: * `tests` [`-v`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=``:`] [`--seed` ] [`--trace`] [`--online`] [`--official-cmd-taps`]: #: Run Homebrew's unit and integration tests. require "fileutils" diff --git a/Library/Homebrew/dev-cmd/update-test.rb b/Library/Homebrew/dev-cmd/update-test.rb index 3b8dc11f9d..9704426ddd 100644 --- a/Library/Homebrew/dev-cmd/update-test.rb +++ b/Library/Homebrew/dev-cmd/update-test.rb @@ -1,14 +1,14 @@ -#: * `update-test` [`--commit=`] [`--before=`] [`--keep-tmp`]: +#: * `update-test` [`--commit=`] [`--before=`] [`--keep-tmp`]: #: Runs a test of `brew update` with a new repository clone. #: #: If no arguments are passed, use `origin/master` as the start commit. #: -#: If `--commit=` is passed, use `` as the start commit. +#: If `--commit=` is passed, use as the start commit. #: -#: If `--before=` is passed, use the commit at `` as the +#: If `--before=` is passed, use the commit at as the #: start commit. #: -#: If `--to-tag` is passed, set HOMEBREW_UPDATE_TO_TAG to test updating +#: If `--to-tag` is passed, set `HOMEBREW_UPDATE_TO_TAG` to test updating #: between tags. #: #: If `--keep-tmp` is passed, retain the temporary directory containing diff --git a/Library/Homebrew/manpages/brew.1.md.erb b/Library/Homebrew/manpages/brew.1.md.erb index a7f099e9da..05fc1cb237 100644 --- a/Library/Homebrew/manpages/brew.1.md.erb +++ b/Library/Homebrew/manpages/brew.1.md.erb @@ -40,7 +40,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note * `list`: List all installed formulae. - * `search` |`/``/`: + * `search` (|`/``/`): Perform a substring search of formula names for . If is surrounded with slashes, then it is interpreted as a regular expression. The search for is extended online to some popular taps. @@ -214,7 +214,7 @@ can take several different forms: to insecure HTTP. While ensuring your downloads are fully secure, this is likely - to cause from-source Sourceforge, some GNU & GNOME based + to cause from-source SourceForge, some GNU & GNOME based formulae to fail to download. * `HOMEBREW_NO_GITHUB_API`: diff --git a/README.md b/README.md index 195566f375..1175c65f0a 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,7 @@ This is our PGP key which is valid until May 24, 2017. ## Who Are You? Homebrew's lead maintainer is [Mike McQuaid](https://github.com/mikemcquaid). -Homebrew's current maintainers are [Alyssa Ross](https://github.com/alyssais), [Andrew Janke](https://github.com/apjanke), [Baptiste Fontaine](https://github.com/bfontaine), [Alex Dunn](https://github.com/dunn), -[FX Coudert](https://github.com/fxcoudert), [ilovezfs](https://github.com/ilovezfs), [Josh Hagins](https://github.com/jawshooah), [JCount](https://github.com/jcount), [Misty De Meo](https://github.com/mistydemeo), [Tomasz Pajor](https://github.com/nijikon), [Markus Reiter](https://github.com/reitermarkus), [Tim Smith](https://github.com/tdsmith), [Tom Schoonjans](https://github.com/tschoonj), [Uladzislau Shablinski](https://github.com/vladshablinsky) and [William Woodruff](https://github.com/woodruffw). +Homebrew's current maintainers are [Alyssa Ross](https://github.com/alyssais), [Andrew Janke](https://github.com/apjanke), [Baptiste Fontaine](https://github.com/bfontaine), [Alex Dunn](https://github.com/dunn), [FX Coudert](https://github.com/fxcoudert), [ilovezfs](https://github.com/ilovezfs), [Josh Hagins](https://github.com/jawshooah), [JCount](https://github.com/jcount), [Misty De Meo](https://github.com/mistydemeo), [Tomasz Pajor](https://github.com/nijikon), [Markus Reiter](https://github.com/reitermarkus), [Tim Smith](https://github.com/tdsmith), [Tom Schoonjans](https://github.com/tschoonj), [Uladzislau Shablinski](https://github.com/vladshablinsky) and [William Woodruff](https://github.com/woodruffw). Former maintainers with significant contributions include [Xu Cheng](https://github.com/xu-cheng), [Martin Afanasjew](https://github.com/UniqMartin), [Dominyk Tiller](https://github.com/DomT4), [Brett Koonce](https://github.com/asparagui), [Jack Nagel](https://github.com/jacknagel), [Adam Vandenberg](https://github.com/adamv) and Homebrew's creator: [Max Howell](https://github.com/mxcl). diff --git a/docs/brew.1.html b/docs/brew.1.html index 77a58de7b5..ff2d6105cf 100644 --- a/docs/brew.1.html +++ b/docs/brew.1.html @@ -25,7 +25,7 @@ didn't include with macOS.

uninstall formula

Uninstall formula.

update

Fetch the newest version of Homebrew from GitHub using git(1).

list

List all installed formulae.

-
search text|/text/

Perform a substring search of formula names for text. If text is +

search (text|/text/)

Perform a substring search of formula names for text. If text is surrounded with slashes, then it is interpreted as a regular expression. The search for text is extended online to some popular taps. If no search term is given, all locally available formulae are listed.

@@ -48,7 +48,7 @@ cellar. In addition, old downloads from the Homebrew download-cache are deleted.

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

-

If -s is passed, scrubs the cache, removing downloads for even the latest +

If -s is passed, scrub the cache, removing downloads for even the latest versions of formulae. Note downloads for any installed formulae will still not be deleted. If you want to delete those too: rm -rf $(brew --cache)

command cmd

Display the path to the file which is used when invoking brew cmd.

@@ -93,10 +93,9 @@ dependencies of that formula.

The filters placeholder is any combination of options --include-build, --include-optional, and --skip-recommended as documented above.

desc formula

Display formula's name and one-line description.

-
desc [-s|-n|-d] pattern

Search both name and description (-s), just the names (-n), or just the -descriptions (-d) for <pattern>. <pattern> is by default interpreted -as a literal string; if flanked by slashes, it is instead interpreted as a -regular expression. Formula descriptions are cached; the cache is created on +

desc [-s|-n|-d] (text|/text/)

Search both name and description (-s), just the names (-n), or just the +descriptions (-d) for text. If text is flanked by slashes, it is interpreted +as a regular expression. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones.

diy [--name=name] [--version=version]

Automatically determine the installation prefix for non-Homebrew software.

@@ -144,14 +143,14 @@ GitHub repository as well as creating the Gist.

info formula

Display information about formula.

info --github formula

Open a browser to the GitHub History page for formula formula.

-

To view formula history locally: brew log -p <formula>.

+

To view formula history locally: brew log -p <formula>

info --json=version (--all|--installed|formulae)

Print a JSON representation of formulae. Currently the only accepted value for version is v1.

Pass --all to get information on all formulae, or --installed to get information on all installed formulae.

-

See the docs for examples of using the JSON: +

See the docs for examples of using the JSON output: http://docs.brew.sh/Querying-Brew.html

install [--debug] [--env=std|super] [--ignore-dependencies] [--only-dependencies] [--cc=compiler] [--build-from-source] [--devel|--HEAD] [--keep-tmp] formula

Install formula.

@@ -265,7 +264,7 @@ spaces.

If --all is passed, show options for all formulae.

If --installed is passed, show options for all installed formulae.

-
outdated [--quiet|--verbose|--json=v1] [--fetch-HEAD]

Show formulae that have an updated version available.

+
outdated [--quiet|--verbose|--json=version] [--fetch-HEAD]

Show formulae that have an updated version available.

By default, version information is displayed in interactive shells, and suppressed otherwise.

@@ -295,7 +294,7 @@ actually remove anything.

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 +

search [--desc] (text|/text/)

Perform a substring search of formula names for text. If text is surrounded with slashes, then it is interpreted as a regular expression. The search for text is extended online to some popular taps.

@@ -353,7 +352,7 @@ for version is v1.

Pass --installed to get information on installed taps.

-

See the docs for examples of using the JSON: +

See the docs for examples of using the JSON output: http://docs.brew.sh/Querying-Brew.html

tap-pin tap

Pin tap, prioritizing its formulae over core when formula names are supplied by the user. See also tap-unpin.

@@ -367,7 +366,7 @@ installed, delete all installed versions.

formulae depending on formula would still be installed.

unlink [--dry-run] formula

Remove symlinks for formula from the Homebrew prefix. This can be useful for temporarily disabling a formula: -brew unlink foo && commands && brew link foo.

+brew unlink <formula> && <commands> && brew link <formula>

If --dry-run or -n is passed, Homebrew will list all files which would be unlinked, but will not actually unlink or delete any files.

@@ -387,7 +386,7 @@ directory instead of the system directory.

would be removed, but will not actually delete any files.

unpack [--git|--patch] [--destdir=path] formulae

Unpack the source files for formulae into subdirectories of the current working directory. If --destdir=path is given, the subdirectories will -be created in the directory named by <path> instead.

+be created in the directory named by path instead.

If --patch is passed, patches for formulae will be applied to the unpacked source.

@@ -431,8 +430,8 @@ or recommended dependency. To include the :build type dependencies, --include-build. Similarly, pass --include-optional to include :optional dependencies. To skip :recommended type dependencies, pass --skip-recommended.

-

By default, uses shows usages of formula by stable builds. To find -cases where formula is used by development or HEAD build, pass +

By default, uses shows usages of formulae by stable builds. To find +cases where formulae is used by development or HEAD build, pass --devel or --HEAD.

--cache

Display Homebrew's download cache. See also HOMEBREW_CACHE.

--cache formula

Display the file or directory used to cache formula.

@@ -479,15 +478,12 @@ name of the file or formula being audited, to make the output easy to grep.

audit exits with a non-zero status if any errors are found. This is useful, for instance, for implementing pre-commit hooks.

-
bottle [--verbose] [--no-rebuild] [--keep-old] [--skip-relocation] [--root-url=<root_url>] [--force-core-tap]:

-
bottle --merge [--no-commit] [--keep-old] [--write]:

- -

Generate a bottle (binary package) from a formula installed with +

bottle [--verbose] [--no-rebuild] [--keep-old] [--skip-relocation] [--root-url=URL] [--force-core-tap]:

+
bottle --merge [--no-commit] [--keep-old] [--write]

Generate a bottle (binary package) from a formula installed with --build-bottle.

-
bump-formula-pr [--devel] [--dry-run] [--audit|--strict] [--message=message] --url=url --sha256=sha-256 formula:

-
bump-formula-pr [--devel] [--dry-run] [--audit|--strict] [--message=message] --tag=tag --revision=revision formula

Creates a pull request to update the formula with a new url or a new tag.

+
bump-formula-pr [--devel] [--dry-run [--write]] [--audit|--strict] [--mirror=URL] [--version=version] [--message=message] (--url=URL --sha256=sha-256|--tag=tag --revision=revision) formula

Creates a pull request to update the formula with a new URL or a new tag.

-

If a url is specified, the sha-256 checksum of the new download must +

If a URL is specified, the sha-256 checksum of the new download must also be specified. A best effort to determine the sha-256 and formula name will be made if either or both values are not supplied by the user.

@@ -506,25 +502,24 @@ making the expected file modifications but not taking any git actions.

If --strict is passed, run brew audit --strict before opening the PR.

-

If --mirror=url is passed, use the value as a mirror url.

+

If --mirror=URL is passed, use the value as a mirror URL.

If --version=version is passed, use the value to override the value -parsed from the url or tag. Note that --version=0 can be used to delete +parsed from the URL or tag. Note that --version=0 can be used to delete an existing version override from a formula if it has become redundant.

If --message=message is passed, append message to the default PR message.

Note that this command cannot be used to transition a formula from a -url-and-sha256 style specification into a tag-and-revision style +URL-and-sha256 style specification into a tag-and-revision style specification, nor vice versa. It must use whichever style specification the preexisting formula already uses.

create URL [--autotools|--cmake|--meson] [--no-fetch] [--set-name name] [--set-version version] [--tap user/repo]

Generate a formula for the downloadable file at URL and open it in the editor. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you'll have to make your own template. The wget -formula serves as a simple example. For the complete API have a look at

- -

http://www.rubydoc.info/github/Homebrew/brew/master/Formula

+formula serves as a simple example. For the complete API have a look at +http://www.rubydoc.info/github/Homebrew/brew/master/Formula.

If --autotools is passed, create a basic template for an Autotools-style build. If --cmake is passed, create a basic template for a CMake-style build. @@ -540,8 +535,8 @@ you to explicitly set the name and version of the package you are creating.

the specified tap.

edit

Open all of Homebrew for editing.

edit formula

Open formula in the editor.

-
formula formula

Display the path where formula is

-
linkage [--test] [--reverse] formula-name

Checks the library links of an installed formula.

+
formula formula

Display the path where formula is located.

+
linkage [--test] [--reverse] formula

Checks the library links of an installed formula.

Only works on installed formulae. An error is raised if it is run on uninstalled formulae.

@@ -558,44 +553,47 @@ status code if changes are detected in the manpage outputs. This can be used for CI to be notified when the manpages are out of date. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date).

- +
pull [--bottle] [--bump] [--clean] [--ignore-whitespace] [--resolve] [--branch-okay] [--no-pbcopy] [--no-publish] patch-source [patch-source]

Gets a patch from a GitHub commit or pull request and applies it to Homebrew. +Optionally, installs the formulae changed by the patch.

+

Each patch-source may be one of:

-

pull [--bottle] [--bump] [--clean] [--ignore-whitespace] [--resolve] [--branch-okay] [--no-pbcopy] [--no-publish] patch-source [patch-source]

+

~ The ID number of a PR (pull request) in the homebrew/core GitHub + repository

-
Gets a patch from a GitHub commit or pull request and applies it to Homebrew.
-Optionally, installs the formulae changed by the patch.
-
-Each <patch-source> may be one of:
-  * The ID number of a PR (Pull Request) in the homebrew/core GitHub
-    repository
-  * The URL of a PR on GitHub, using either the web page or API URL
+
  ~ The URL of a PR on GitHub, using either the web page or API URL
     formats. In this form, the PR may be on Homebrew/brew,
-    Homebrew/homebrew-core or any tap.
-  * The URL of a commit on GitHub
-  * A "http://bot.brew.sh/job/..." string specifying a testing job ID
-
+ Homebrew/homebrew-core or any tap.

-

If --bottle was passed, handle bottles, pulling the bottle-update - commit and publishing files on Bintray. - If --bump was passed, for one-formula PRs, automatically reword - commit message to our preferred format. - If --clean was passed, do not rewrite or otherwise modify the - commits found in the pulled PR. - If --ignore-whitespace was passed, silently ignore whitespace - discrepancies when applying diffs. - If --resolve was passed, when a patch fails to apply, leave in - progress and allow user to - resolve, instead of aborting. - If --branch-okay was passed, do not warn if pulling to a branch - besides master (useful for testing). - If --no-pbcopy was passed, do not copy anything to the system - If --no-publish was passed, do not publish bottles to Bintray.

+

~ The URL of a commit on GitHub

-
-
release-notes [previous_tag] [end_ref]

Output the merged pull requests on Homebrew/brew between two Git refs. -If no previous_tag is provided it defaults to the newest tag. -If no end_ref is provided it defaults to origin/master.

+

~ A "http://bot.brew.sh/job/..." string specifying a testing job ID

+ +

If --bottle is passed, handle bottles, pulling the bottle-update +commit and publishing files on Bintray.

+ +

If --bump is passed, for one-formula PRs, automatically reword +commit message to our preferred format.

+ +

If --clean is passed, do not rewrite or otherwise modify the +commits found in the pulled PR.

+ +

If --ignore-whitespace is passed, silently ignore whitespace +discrepancies when applying diffs.

+ +

If --resolve is passed, when a patch fails to apply, leave in +progress and allow user to resolve, instead of aborting.

+ +

If --branch-okay is passed, do not warn if pulling to a branch +besides master (useful for testing).

+ +

If --no-pbcopy is passed, do not copy anything to the system +clipboard.

+ +

If --no-publish is passed, do not publish bottles to Bintray.

+
release-notes [--markdown] [previous_tag] [end_ref]

Output the merged pull requests on Homebrew/brew between two Git refs. +If no previous_tag is provided it defaults to the newest tag. +If no end_ref is provided it defaults to origin/master.

If --markdown is passed, output as a Markdown list.

tap-new user/repo

Generate the template files for a new tap.

@@ -614,17 +612,17 @@ launched with access to IRB or a shell inside the temporary test directory.

not deleted.

Example: brew install jruby && brew test jruby

-
tests [-v] [--coverage] [--generic] [--no-compat] [--only=<test_script:test_method>] [--seed seed] [--trace] [--online] [--official-cmd-taps]

Run Homebrew's unit and integration tests.

-
update-test [--commit=<commit>] [--before=<date>] [--keep-tmp]

Runs a test of brew update with a new repository clone.

+
tests [-v] [--coverage] [--generic] [--no-compat] [--only=test_script:test_method] [--seed seed] [--trace] [--online] [--official-cmd-taps]

Run Homebrew's unit and integration tests.

+
update-test [--commit=commit] [--before=date] [--keep-tmp]

Runs a test of brew update with a new repository clone.

If no arguments are passed, use origin/master as the start commit.

-

If --commit=<commit> is passed, use <commit> as the start commit.

+

If --commit=commit is passed, use commit as the start commit.

-

If --before=<date> is passed, use the commit at <date> as the +

If --before=date is passed, use the commit at date as the start commit.

-

If --to-tag is passed, set HOMEBREW_UPDATE_TO_TAG to test updating +

If --to-tag is passed, set HOMEBREW_UPDATE_TO_TAG to test updating between tags.

If --keep-tmp is passed, retain the temporary directory containing @@ -742,7 +740,7 @@ successful build.

to insecure HTTP.

While ensuring your downloads are fully secure, this is likely -to cause from-source Sourceforge, some GNU & GNOME based +to cause from-source SourceForge, some GNU & GNOME based formulae to fail to download.

HOMEBREW_NO_GITHUB_API

If set, Homebrew will not use the GitHub API for e.g searches or fetching relevant issues on a failed install.

@@ -791,7 +789,7 @@ your shell profile, or you can use it before a brew command:

Homebrew's lead maintainer is Mike McQuaid.

-

Homebrew's current maintainers are Alyssa Ross, Andrew Janke, Baptiste Fontaine, [Alex Dunn](https://github.

+

Homebrew's current maintainers are Alyssa Ross, Andrew Janke, Baptiste Fontaine, Alex Dunn, FX Coudert, ilovezfs, Josh Hagins, JCount, Misty De Meo, Tomasz Pajor, Markus Reiter, Tim Smith, Tom Schoonjans, Uladzislau Shablinski and William Woodruff.

Former maintainers with significant contributions include Xu Cheng, Martin Afanasjew, Dominyk Tiller, Brett Koonce, Jack Nagel, Adam Vandenberg and Homebrew's creator: Max Howell.

diff --git a/manpages/brew.1 b/manpages/brew.1 index 5decd142f4..0899007b58 100644 --- a/manpages/brew.1 +++ b/manpages/brew.1 @@ -38,7 +38,7 @@ Fetch the newest version of Homebrew from GitHub using \fBgit\fR(1)\. List all installed formulae\. . .TP -\fBsearch\fR \fItext\fR|\fB/\fR\fItext\fR\fB/\fR +\fBsearch\fR (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR) Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to some popular taps\. If no search term is given, all locally available formulae are listed\. . .SH "COMMANDS" @@ -70,7 +70,7 @@ If \fB\-\-prune=\fR\fIdays\fR is specified, remove all cache files older than \f If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, show what would be removed, but do not actually remove anything\. . .IP -If \fB\-s\fR is passed, scrubs the cache, removing downloads for even the latest versions of formulae\. Note downloads for any installed formulae will still not be deleted\. If you want to delete those too: \fBrm \-rf $(brew \-\-cache)\fR +If \fB\-s\fR is passed, scrub the cache, removing downloads for even the latest versions of formulae\. Note downloads for any installed formulae will still not be deleted\. If you want to delete those too: \fBrm \-rf $(brew \-\-cache)\fR . .TP \fBcommand\fR \fIcmd\fR @@ -131,8 +131,8 @@ The \fIfilters\fR placeholder is any combination of options \fB\-\-include\-buil Display \fIformula\fR\'s name and one\-line description\. . .TP -\fBdesc\fR [\fB\-s\fR|\fB\-n\fR|\fB\-d\fR] \fIpattern\fR -Search both name and description (\fB\-s\fR), just the names (\fB\-n\fR), or just the descriptions (\fB\-d\fR) for \fB\fR\. \fB\fR is by default interpreted as a literal string; if flanked by slashes, it is instead interpreted as a regular expression\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\. +\fBdesc\fR [\fB\-s\fR|\fB\-n\fR|\fB\-d\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR) +Search both name and description (\fB\-s\fR), just the names (\fB\-n\fR), or just the descriptions (\fB\-d\fR) for \fItext\fR\. If \fItext\fR is flanked by slashes, it is interpreted as a regular expression\. Formula descriptions are cached; the cache is created on the first search, making that search slower than subsequent ones\. . .TP \fBdiy\fR [\fB\-\-name=\fR\fIname\fR] [\fB\-\-version=\fR\fIversion\fR] @@ -203,7 +203,7 @@ Display information about \fIformula\fR\. Open a browser to the GitHub History page for formula \fIformula\fR\. . .IP -To view formula history locally: \fBbrew log \-p \fR\. +To view formula history locally: \fBbrew log \-p \fR . .TP \fBinfo\fR \fB\-\-json=\fR\fIversion\fR (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR) @@ -213,7 +213,7 @@ Print a JSON representation of \fIformulae\fR\. Currently the only accepted valu Pass \fB\-\-all\fR to get information on all formulae, or \fB\-\-installed\fR to get information on all installed formulae\. . .IP -See the docs for examples of using the JSON: \fIhttp://docs\.brew\.sh/Querying\-Brew\.html\fR +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\fIstd\fR|\fIsuper\fR] [\fB\-\-ignore\-dependencies\fR] [\fB\-\-only\-dependencies\fR] [\fB\-\-cc=\fR\fIcompiler\fR] [\fB\-\-build\-from\-source\fR] [\fB\-\-devel\fR|\fB\-\-HEAD\fR] [\fB\-\-keep\-tmp\fR] \fIformula\fR @@ -352,7 +352,7 @@ If \fB\-\-all\fR is passed, show options for all formulae\. If \fB\-\-installed\fR is passed, show options for all installed formulae\. . .TP -\fBoutdated\fR [\fB\-\-quiet\fR|\fB\-\-verbose\fR|\fB\-\-json=v1\fR] [\fB\-\-fetch\-HEAD\fR] +\fBoutdated\fR [\fB\-\-quiet\fR|\fB\-\-verbose\fR|\fB\-\-json=\fR\fIversion\fR] [\fB\-\-fetch\-HEAD\fR] Show formulae that have an updated version available\. . .IP @@ -394,7 +394,7 @@ Uninstall and then install \fIformula\fR\. Display all locally available formulae for brewing (including tapped ones)\. No online search is performed if called without arguments\. . .TP -\fBsearch\fR [\fB\-\-desc\fR] \fItext\fR|\fB/\fR\fItext\fR\fB/\fR +\fBsearch\fR [\fB\-\-desc\fR] (\fItext\fR|\fB/\fR\fItext\fR\fB/\fR) Perform a substring search of formula names for \fItext\fR\. If \fItext\fR is surrounded with slashes, then it is interpreted as a regular expression\. The search for \fItext\fR is extended online to some popular taps\. . .IP @@ -479,7 +479,7 @@ Print a JSON representation of \fItaps\fR\. Currently the only accepted value fo Pass \fB\-\-installed\fR to get information on installed taps\. . .IP -See the docs for examples of using the JSON: \fIhttp://docs\.brew\.sh/Querying\-Brew\.html\fR +See the docs for examples of using the JSON output: \fIhttp://docs\.brew\.sh/Querying\-Brew\.html\fR . .TP \fBtap\-pin\fR \fItap\fR @@ -501,7 +501,7 @@ If \fB\-\-ignore\-dependencies\fR is passed, uninstalling won\'t fail, even if f . .TP \fBunlink\fR [\fB\-\-dry\-run\fR] \fIformula\fR -Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink foo && commands && brew link foo\fR\. +Remove symlinks for \fIformula\fR from the Homebrew prefix\. This can be useful for temporarily disabling a formula: \fBbrew unlink && && brew link \fR . .IP If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, Homebrew will list all files which would be unlinked, but will not actually unlink or delete any files\. @@ -524,7 +524,7 @@ If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, Homebrew will list all symlinks wh . .TP \fBunpack\fR [\fB\-\-git\fR|\fB\-\-patch\fR] [\fB\-\-destdir=\fR\fIpath\fR] \fIformulae\fR -Unpack the source files for \fIformulae\fR into subdirectories of the current working directory\. If \fB\-\-destdir=\fR\fIpath\fR is given, the subdirectories will be created in the directory named by \fB\fR instead\. +Unpack the source files for \fIformulae\fR into subdirectories of the current working directory\. If \fB\-\-destdir=\fR\fIpath\fR is given, the subdirectories will be created in the directory named by \fIpath\fR instead\. . .IP If \fB\-\-patch\fR is passed, patches for \fIformulae\fR will be applied to the unpacked source\. @@ -580,7 +580,7 @@ If \fB\-\-installed\fR is passed, only list installed formulae\. By default, \fBuses\fR shows all formulae that specify \fIformulae\fR as a required or recommended dependency\. To include the \fB:build\fR type dependencies, pass \fB\-\-include\-build\fR\. Similarly, pass \fB\-\-include\-optional\fR to include \fB:optional\fR dependencies\. To skip \fB:recommended\fR type dependencies, pass \fB\-\-skip\-recommended\fR\. . .IP -By default, \fBuses\fR shows usages of \fBformula\fR by stable builds\. To find cases where \fBformula\fR is used by development or HEAD build, pass \fB\-\-devel\fR or \fB\-\-HEAD\fR\. +By default, \fBuses\fR shows usages of \fIformulae\fR by stable builds\. To find cases where \fIformulae\fR is used by development or HEAD build, pass \fB\-\-devel\fR or \fB\-\-HEAD\fR\. . .TP \fB\-\-cache\fR @@ -653,25 +653,19 @@ If \fB\-\-display\-filename\fR is passed, every line of output is prefixed with \fBaudit\fR exits with a non\-zero status if any errors are found\. This is useful, for instance, for implementing pre\-commit hooks\. . .TP -\fBbottle\fR [\fB\-\-verbose\fR] [\fB\-\-no\-rebuild\fR] [\fB\-\-keep\-old\fR] [\fB\-\-skip\-relocation\fR] [\fB\-\-root\-url=\fR] [\fB\-\-force\-core\-tap\fR]: +\fBbottle\fR [\fB\-\-verbose\fR] [\fB\-\-no\-rebuild\fR] [\fB\-\-keep\-old\fR] [\fB\-\-skip\-relocation\fR] [\fB\-\-root\-url=\fR\fIURL\fR] [\fB\-\-force\-core\-tap\fR]: . .TP -\fBbottle\fR \fB\-\-merge\fR [\fB\-\-no\-commit\fR] [\fB\-\-keep\-old\fR] [\fB\-\-write\fR]: -. -.IP +\fBbottle\fR \fB\-\-merge\fR [\fB\-\-no\-commit\fR] [\fB\-\-keep\-old\fR] [\fB\-\-write\fR] Generate a bottle (binary package) from a formula installed with \fB\-\-build\-bottle\fR\. . .TP -\fBbump\-formula\-pr\fR [\fB\-\-devel\fR] [\fB\-\-dry\-run\fR] [\fB\-\-audit\fR|\fB\-\-strict\fR] [\fB\-\-message=\fR\fImessage\fR] \fB\-\-url=\fR\fIurl\fR \fB\-\-sha256=\fR\fIsha\-256\fR \fIformula\fR: - -. -.TP -\fBbump\-formula\-pr\fR [\fB\-\-devel\fR] [\fB\-\-dry\-run\fR] [\fB\-\-audit\fR|\fB\-\-strict\fR] [\fB\-\-message=\fR\fImessage\fR] \fB\-\-tag=\fR\fItag\fR \fB\-\-revision=\fR\fIrevision\fR \fIformula\fR -Creates a pull request to update the formula with a new url or a new tag\. +\fBbump\-formula\-pr\fR [\fB\-\-devel\fR] [\fB\-\-dry\-run\fR [\fB\-\-write\fR]] [\fB\-\-audit\fR|\fB\-\-strict\fR] [\fB\-\-mirror=\fR\fIURL\fR] [\fB\-\-version=\fR\fIversion\fR] [\fB\-\-message=\fR\fImessage\fR] (\fB\-\-url=\fR\fIURL\fR \fB\-\-sha256=\fR\fIsha\-256\fR|\fB\-\-tag=\fR\fItag\fR \fB\-\-revision=\fR\fIrevision\fR) \fIformula\fR +Creates a pull request to update the formula with a new URL or a new tag\. . .IP -If a \fIurl\fR is specified, the \fIsha\-256\fR checksum of the new download must also be specified\. A best effort to determine the \fIsha\-256\fR and \fIformula\fR name will be made if either or both values are not supplied by the user\. +If a \fIURL\fR is specified, the \fIsha\-256\fR checksum of the new download must also be specified\. A best effort to determine the \fIsha\-256\fR and \fIformula\fR name will be made if either or both values are not supplied by the user\. . .IP If a \fItag\fR is specified, the git commit \fIrevision\fR corresponding to that tag must also be specified\. @@ -692,23 +686,20 @@ If \fB\-\-audit\fR is passed, run \fBbrew audit\fR before opening the PR\. If \fB\-\-strict\fR is passed, run \fBbrew audit \-\-strict\fR before opening the PR\. . .IP -If \fB\-\-mirror=\fR\fIurl\fR is passed, use the value as a mirror url\. +If \fB\-\-mirror=\fR\fIURL\fR is passed, use the value as a mirror URL\. . .IP -If \fB\-\-version=\fR\fIversion\fR is passed, use the value to override the value parsed from the url or tag\. Note that \fB\-\-version=0\fR can be used to delete an existing \fBversion\fR override from a formula if it has become redundant\. +If \fB\-\-version=\fR\fIversion\fR is passed, use the value to override the value parsed from the URL or tag\. Note that \fB\-\-version=0\fR can be used to delete an existing \fBversion\fR override from a formula if it has become redundant\. . .IP If \fB\-\-message=\fR\fImessage\fR is passed, append \fImessage\fR to the default PR message\. . .IP -Note that this command cannot be used to transition a formula from a url\-and\-sha256 style specification into a tag\-and\-revision style specification, nor vice versa\. It must use whichever style specification the preexisting formula already uses\. +Note that this command cannot be used to transition a formula from a URL\-and\-sha256 style specification into a tag\-and\-revision style specification, nor vice versa\. It must use whichever style specification the preexisting formula already uses\. . .TP \fBcreate\fR \fIURL\fR [\fB\-\-autotools\fR|\fB\-\-cmake\fR|\fB\-\-meson\fR] [\fB\-\-no\-fetch\fR] [\fB\-\-set\-name\fR \fIname\fR] [\fB\-\-set\-version\fR \fIversion\fR] [\fB\-\-tap\fR \fIuser\fR\fB/\fR\fIrepo\fR] -Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API have a look at -. -.IP -\fIhttp://www\.rubydoc\.info/github/Homebrew/brew/master/Formula\fR +Generate a formula for the downloadable file at \fIURL\fR and open it in the editor\. Homebrew will attempt to automatically derive the formula name and version, but if it fails, you\'ll have to make your own template\. The \fBwget\fR formula serves as a simple example\. For the complete API have a look at \fIhttp://www\.rubydoc\.info/github/Homebrew/brew/master/Formula\fR\. . .IP If \fB\-\-autotools\fR is passed, create a basic template for an Autotools\-style build\. If \fB\-\-cmake\fR is passed, create a basic template for a CMake\-style build\. If \fB\-\-meson\fR is passed, create a basic template for a Meson\-style build\. @@ -732,10 +723,10 @@ Open \fIformula\fR in the editor\. . .TP \fBformula\fR \fIformula\fR -Display the path where \fIformula\fR is +Display the path where \fIformula\fR is located\. . .TP -\fBlinkage\fR [\fB\-\-test\fR] [\fB\-\-reverse\fR] \fIformula\-name\fR +\fBlinkage\fR [\fB\-\-test\fR] [\fB\-\-reverse\fR] \fIformula\fR Checks the library links of an installed formula\. . .IP @@ -754,35 +745,52 @@ Generate Homebrew\'s manpages\. .IP If \fB\-\-fail\-if\-changed\fR is passed, the command will return a failing status code if changes are detected in the manpage outputs\. This can be used for CI to be notified when the manpages are out of date\. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date)\. . -.P +.TP \fBpull\fR [\fB\-\-bottle\fR] [\fB\-\-bump\fR] [\fB\-\-clean\fR] [\fB\-\-ignore\-whitespace\fR] [\fB\-\-resolve\fR] [\fB\-\-branch\-okay\fR] [\fB\-\-no\-pbcopy\fR] [\fB\-\-no\-publish\fR] \fIpatch\-source\fR [\fIpatch\-source\fR] +Gets a patch from a GitHub commit or pull request and applies it to Homebrew\. Optionally, installs the formulae changed by the patch\. . -.IP "" 4 +.IP +Each \fIpatch\-source\fR may be one of: . -.nf - -Gets a patch from a GitHub commit or pull request and applies it to Homebrew\. -Optionally, installs the formulae changed by the patch\. - -Each may be one of: - * The ID number of a PR (Pull Request) in the homebrew/core GitHub - repository - * The URL of a PR on GitHub, using either the web page or API URL - formats\. In this form, the PR may be on Homebrew/brew, - Homebrew/homebrew\-core or any tap\. - * The URL of a commit on GitHub - * A "http://bot\.brew\.sh/job/\.\.\." string specifying a testing job ID +.IP +~ The ID number of a PR (pull request) in the homebrew/core GitHub repository . -.fi +.IP +~ The URL of a PR on GitHub, using either the web page or API URL formats\. In this form, the PR may be on Homebrew/brew, Homebrew/homebrew\-core or any tap\. . -.IP "" 0 +.IP +~ The URL of a commit on GitHub . -.P -If \fB\-\-bottle\fR was passed, handle bottles, pulling the bottle\-update commit and publishing files on Bintray\. If \fB\-\-bump\fR was passed, for one\-formula PRs, automatically reword commit message to our preferred format\. If \fB\-\-clean\fR was passed, do not rewrite or otherwise modify the commits found in the pulled PR\. If \fB\-\-ignore\-whitespace\fR was passed, silently ignore whitespace discrepancies when applying diffs\. If \fB\-\-resolve\fR was passed, when a patch fails to apply, leave in progress and allow user to resolve, instead of aborting\. If \fB\-\-branch\-okay\fR was passed, do not warn if pulling to a branch besides master (useful for testing)\. If \fB\-\-no\-pbcopy\fR was passed, do not copy anything to the system If \fB\-\-no\-publish\fR was passed, do not publish bottles to Bintray\. +.IP +~ A "http://bot\.brew\.sh/job/\.\.\." string specifying a testing job ID +. +.IP +If \fB\-\-bottle\fR is passed, handle bottles, pulling the bottle\-update commit and publishing files on Bintray\. +. +.IP +If \fB\-\-bump\fR is passed, for one\-formula PRs, automatically reword commit message to our preferred format\. +. +.IP +If \fB\-\-clean\fR is passed, do not rewrite or otherwise modify the commits found in the pulled PR\. +. +.IP +If \fB\-\-ignore\-whitespace\fR is passed, silently ignore whitespace discrepancies when applying diffs\. +. +.IP +If \fB\-\-resolve\fR is passed, when a patch fails to apply, leave in progress and allow user to resolve, instead of aborting\. +. +.IP +If \fB\-\-branch\-okay\fR is passed, do not warn if pulling to a branch besides master (useful for testing)\. +. +.IP +If \fB\-\-no\-pbcopy\fR is passed, do not copy anything to the system clipboard\. +. +.IP +If \fB\-\-no\-publish\fR is passed, do not publish bottles to Bintray\. . .TP -\fBrelease\-notes\fR [\fIprevious_tag\fR] [\fIend_ref\fR] -Output the merged pull requests on Homebrew/brew between two Git refs\. If no \fBprevious_tag\fR is provided it defaults to the newest tag\. If no \fBend_ref\fR is provided it defaults to \fBorigin/master\fR\. +\fBrelease\-notes\fR [\fB\-\-markdown\fR] [\fIprevious_tag\fR] [\fIend_ref\fR] +Output the merged pull requests on Homebrew/brew between two Git refs\. If no \fIprevious_tag\fR is provided it defaults to the newest tag\. If no \fIend_ref\fR is provided it defaults to \fBorigin/master\fR\. . .IP If \fB\-\-markdown\fR is passed, output as a Markdown list\. @@ -808,24 +816,24 @@ If \fB\-\-keep\-tmp\fR is passed, the temporary files created for the test are n Example: \fBbrew install jruby && brew test jruby\fR . .TP -\fBtests\fR [\fB\-v\fR] [\fB\-\-coverage\fR] [\fB\-\-generic\fR] [\fB\-\-no\-compat\fR] [\fB\-\-only=\fR] [\fB\-\-seed\fR \fIseed\fR] [\fB\-\-trace\fR] [\fB\-\-online\fR] [\fB\-\-official\-cmd\-taps\fR] +\fBtests\fR [\fB\-v\fR] [\fB\-\-coverage\fR] [\fB\-\-generic\fR] [\fB\-\-no\-compat\fR] [\fB\-\-only=\fR\fItest_script\fR\fB:\fR\fItest_method\fR] [\fB\-\-seed\fR \fIseed\fR] [\fB\-\-trace\fR] [\fB\-\-online\fR] [\fB\-\-official\-cmd\-taps\fR] Run Homebrew\'s unit and integration tests\. . .TP -\fBupdate\-test\fR [\fB\-\-commit=\fR] [\fB\-\-before=\fR] [\fB\-\-keep\-tmp\fR] +\fBupdate\-test\fR [\fB\-\-commit=\fR\fIcommit\fR] [\fB\-\-before=\fR\fIdate\fR] [\fB\-\-keep\-tmp\fR] Runs a test of \fBbrew update\fR with a new repository clone\. . .IP If no arguments are passed, use \fBorigin/master\fR as the start commit\. . .IP -If \fB\-\-commit=\fR is passed, use \fB\fR as the start commit\. +If \fB\-\-commit=\fR\fIcommit\fR is passed, use \fIcommit\fR as the start commit\. . .IP -If \fB\-\-before=\fR is passed, use the commit at \fB\fR as the start commit\. +If \fB\-\-before=\fR\fIdate\fR is passed, use the commit at \fIdate\fR as the start commit\. . .IP -If \fB\-\-to\-tag\fR is passed, set HOMEBREW_UPDATE_TO_TAG to test updating between tags\. +If \fB\-\-to\-tag\fR is passed, set \fBHOMEBREW_UPDATE_TO_TAG\fR to test updating between tags\. . .IP If \fB\-\-keep\-tmp\fR is passed, retain the temporary directory containing the new repository clone\. @@ -985,7 +993,7 @@ If set, Homebrew will not print the \fBHOMEBREW_INSTALL_BADGE\fR on a successful If set, Homebrew will not permit redirects from secure HTTPS to insecure HTTP\. . .IP -While ensuring your downloads are fully secure, this is likely to cause from\-source Sourceforge, some GNU & GNOME based formulae to fail to download\. +While ensuring your downloads are fully secure, this is likely to cause from\-source SourceForge, some GNU & GNOME based formulae to fail to download\. . .TP \fBHOMEBREW_NO_GITHUB_API\fR @@ -1056,7 +1064,7 @@ Homebrew Documentation: \fIhttps://github\.com/Homebrew/brew/blob/master/docs/\f Homebrew\'s lead maintainer is Mike McQuaid\. . .P -Homebrew\'s current maintainers are Alyssa Ross, Andrew Janke, Baptiste Fontaine, [Alex Dunn](https://github\. +Homebrew\'s current maintainers are Alyssa Ross, Andrew Janke, Baptiste Fontaine, Alex Dunn, FX Coudert, ilovezfs, Josh Hagins, JCount, Misty De Meo, Tomasz Pajor, Markus Reiter, Tim Smith, Tom Schoonjans, Uladzislau Shablinski and William Woodruff\. . .P Former maintainers with significant contributions include Xu Cheng, Martin Afanasjew, Dominyk Tiller, Brett Koonce, Jack Nagel, Adam Vandenberg and Homebrew\'s creator: Max Howell\.