Skip to content
Snippets Groups Projects
Commit afc539f8 authored by EricFromCanada's avatar EricFromCanada
Browse files

Update brew's man page formatting and grammar

Also update command specifications to match descriptions.
parent 6cb56297
No related branches found
No related tags found
No related merge requests found
Showing
with 34 additions and 38 deletions
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
#: If `--dry-run` or `-n` is passed, show what would be removed, but do not #: If `--dry-run` or `-n` is passed, show what would be removed, but do not
#: actually remove anything. #: 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 #: 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)` #: deleted. If you want to delete those too: `rm -rf $(brew --cache)`
......
#: * `desc` <formula>: #: * `desc` <formula>:
#: Display <formula>'s name and one-line description. #: Display <formula>'s name and one-line description.
#: #:
#: * `desc` [`-s`|`-n`|`-d`] <pattern>: #: * `desc` [`-s`|`-n`|`-d`] (<text>|`/`<text>`/`):
#: Search both name and description (`-s`), just the names (`-n`), or just the #: Search both name and description (`-s`), just the names (`-n`), or just the
#: descriptions (`-d`) for `<pattern>`. `<pattern>` is by default interpreted #: descriptions (`-d`) for <text>. If <text> is flanked by slashes, it is interpreted
#: as a literal string; if flanked by slashes, it is instead interpreted as a #: as a regular expression. Formula descriptions are cached; the cache is created on
#: regular expression. Formula descriptions are cached; the cache is created on
#: the first search, making that search slower than subsequent ones. #: the first search, making that search slower than subsequent ones.
require "descriptions" require "descriptions"
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
#: * `info` `--github` <formula>: #: * `info` `--github` <formula>:
#: Open a browser to the GitHub History page for formula <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>): #: * `info` `--json=`<version> (`--all`|`--installed`|<formulae>):
#: Print a JSON representation of <formulae>. Currently the only accepted value #: Print a JSON representation of <formulae>. Currently the only accepted value
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
#: Pass `--all` to get information on all formulae, or `--installed` to get #: Pass `--all` to get information on all formulae, or `--installed` to get
#: information on all installed formulae. #: 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> #: <http://docs.brew.sh/Querying-Brew.html>
require "blacklist" require "blacklist"
......
#: * `outdated` [`--quiet`|`--verbose`|`--json=v1`] [`--fetch-HEAD`]: #: * `outdated` [`--quiet`|`--verbose`|`--json=`<version>] [`--fetch-HEAD`]:
#: Show formulae that have an updated version available. #: Show formulae that have an updated version available.
#: #:
#: By default, version information is displayed in interactive shells, and #: By default, version information is displayed in interactive shells, and
......
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
#: #:
#: This can be useful for debugging issues across all formulae #: This can be useful for debugging issues across all formulae
#: when making significant changes to `formula.rb`, #: 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" require "readall"
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
#: Display all locally available formulae for brewing (including tapped ones). #: Display all locally available formulae for brewing (including tapped ones).
#: No online search is performed if called without arguments. #: No online search is performed if called without arguments.
#: #:
#: * `search` [`--desc`] <text>|`/`<text>`/`: #: * `search` [`--desc`] (<text>|`/`<text>`/`):
#: Perform a substring search of formula names for <text>. If <text> is #: Perform a substring search of formula names for <text>. If <text> is
#: surrounded with slashes, then it is interpreted as a regular expression. #: surrounded with slashes, then it is interpreted as a regular expression.
#: The search for <text> is extended online to some popular taps. #: The search for <text> is extended online to some popular taps.
......
...@@ -12,7 +12,7 @@ ...@@ -12,7 +12,7 @@
#: #:
#: Pass `--installed` to get information on installed taps. #: 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> #: <http://docs.brew.sh/Querying-Brew.html>
require "tap" require "tap"
......
#: * `unlink` [`--dry-run`] <formula>: #: * `unlink` [`--dry-run`] <formula>:
#: Remove symlinks for <formula> from the Homebrew prefix. This can be useful #: Remove symlinks for <formula> from the Homebrew prefix. This can be useful
#: for temporarily disabling a formula: #: 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 #: 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. #: be unlinked, but will not actually unlink or delete any files.
......
#: * `unpack` [`--git`|`--patch`] [`--destdir=`<path>] <formulae>: #: * `unpack` [`--git`|`--patch`] [`--destdir=`<path>] <formulae>:
#: Unpack the source files for <formulae> into subdirectories of the current #: Unpack the source files for <formulae> into subdirectories of the current
#: working directory. If `--destdir=`<path> is given, the subdirectories will #: 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 #: If `--patch` is passed, patches for <formulae> will be applied to the
#: unpacked source. #: unpacked source.
......
...@@ -12,8 +12,8 @@ ...@@ -12,8 +12,8 @@
#: `--include-build`. Similarly, pass `--include-optional` to include `:optional` #: `--include-build`. Similarly, pass `--include-optional` to include `:optional`
#: dependencies. To skip `:recommended` type dependencies, pass `--skip-recommended`. #: dependencies. To skip `:recommended` type dependencies, pass `--skip-recommended`.
#: #:
#: By default, `uses` shows usages of `formula` by stable builds. To find #: By default, `uses` shows usages of <formulae> by stable builds. To find
#: cases where `formula` is used by development or HEAD build, pass #: cases where <formulae> is used by development or HEAD build, pass
#: `--devel` or `--HEAD`. #: `--devel` or `--HEAD`.
require "formula" require "formula"
......
#: @hide_from_man_page #: @hide_from_man_page
#: * `boneyard-formula-pr` [`--dry-run`] [`--local`] [`--reason=<reason>`] <formula-name> : #: * `boneyard-formula-pr` [`--dry-run`] [`--local`] [`--reason=<reason>`] <formula> :
#: Creates a pull request to boneyard a formula. #: Creates a pull request to boneyard a formula.
#: #:
#: If `--dry-run` is passed, print what would be done rather than doing it. #: If `--dry-run` is passed, print what would be done rather than doing it.
......
#: * `bottle` [`--verbose`] [`--no-rebuild`] [`--keep-old`] [`--skip-relocation`] [`--root-url=<root_url>`] [`--force-core-tap`]: #: * `bottle` [`--verbose`] [`--no-rebuild`] [`--keep-old`] [`--skip-relocation`] [`--root-url=`<URL>] [`--force-core-tap`]:
#: * `bottle` `--merge` [`--no-commit`] [`--keep-old`] [`--write`]: #: * `bottle` `--merge` [`--no-commit`] [`--keep-old`] [`--write`]:
#:
#: Generate a bottle (binary package) from a formula installed with #: Generate a bottle (binary package) from a formula installed with
#: `--build-bottle`. #: `--build-bottle`.
......
#: * `bump-formula-pr` [`--devel`] [`--dry-run`] [`--audit`|`--strict`] [`--message=`<message>] `--url=`<url> `--sha256=`<sha-256> <formula>: #: * `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>:
#: * `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.
#: 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> #: 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. #: name will be made if either or both values are not supplied by the user.
#: #:
...@@ -21,17 +20,17 @@ ...@@ -21,17 +20,17 @@
#: #:
#: If `--strict` is passed, run `brew audit --strict` before opening the PR. #: 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 #: 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. #: an existing `version` override from a formula if it has become redundant.
#: #:
#: If `--message=`<message> is passed, append <message> to the default PR #: If `--message=`<message> is passed, append <message> to the default PR
#: message. #: message.
#: #:
#: Note that this command cannot be used to transition a formula from a #: 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 #: specification, nor vice versa. It must use whichever style specification
#: the preexisting formula already uses. #: the preexisting formula already uses.
......
...@@ -3,8 +3,7 @@ ...@@ -3,8 +3,7 @@
#: Homebrew will attempt to automatically derive the formula name #: 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` #: 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 #: formula serves as a simple example. For the complete API have a look at
#: #: <http://www.rubydoc.info/github/Homebrew/brew/master/Formula>.
#: <http://www.rubydoc.info/github/Homebrew/brew/master/Formula>
#: #:
#: If `--autotools` is passed, create a basic template for an Autotools-style build. #: 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. #: If `--cmake` is passed, create a basic template for a CMake-style build.
......
#: * `formula` <formula>: #: * `formula` <formula>:
#: Display the path where <formula> is #: Display the path where <formula> is located.
require "formula" require "formula"
......
#: * `linkage` [`--test`] [`--reverse`] <formula-name>: #: * `linkage` [`--test`] [`--reverse`] <formula>:
#: Checks the library links of an installed formula. #: Checks the library links of an installed formula.
#: #:
#: Only works on installed formulae. An error is raised if it is run on #: Only works on installed formulae. An error is raised if it is run on
......
#: @hide_from_man_page #: @hide_from_man_page
#: * `mirror` [`--test`] <formula-name> [<formula-name> ...]: #: * `mirror` [`--test`] <formulae>:
#: Reuploads the stable URL for a formula to Bintray to use it as a mirror. #: Reuploads the stable URL for a formula to Bintray to use it as a mirror.
module Homebrew module Homebrew
......
#: * `release-notes` [<previous_tag>] [<end_ref>]: #: * `release-notes` [`--markdown`] [<previous_tag>] [<end_ref>]:
#: Output the merged pull requests on Homebrew/brew between two Git refs. #: 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 <previous_tag> is provided it defaults to the newest tag.
#: If no `end_ref` is provided it defaults to `origin/master`. #: If no <end_ref> is provided it defaults to `origin/master`.
#: #:
#: If `--markdown` is passed, output as a Markdown list. #: If `--markdown` is passed, output as a Markdown list.
......
#: * `tests` [`-v`] [`--coverage`] [`--generic`] [`--no-compat`] [`--only=`<test_script:test_method>] [`--seed` <seed>] [`--trace`] [`--online`] [`--official-cmd-taps`]: #: * `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. #: Run Homebrew's unit and integration tests.
require "fileutils" require "fileutils"
......
#: * `update-test` [`--commit=<commit>`] [`--before=<date>`] [`--keep-tmp`]: #: * `update-test` [`--commit=`<commit>] [`--before=`<date>] [`--keep-tmp`]:
#: Runs a test of `brew update` with a new repository clone. #: Runs a test of `brew update` with a new repository clone.
#: #:
#: If no arguments are passed, use `origin/master` as the start commit. #: 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. #: 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. #: between tags.
#: #:
#: If `--keep-tmp` is passed, retain the temporary directory containing #: If `--keep-tmp` is passed, retain the temporary directory containing
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment