Merge pull request #2194 from EricFromCanada/master

Fix grammar, formatting in man pages

11 files changed, 51 insertions, 45 deletions

diff --git a/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb b/Library/Homebrew/dev-cmd/boneyard-formula-pr.rb
index 3066d2ee6..7531ef9cf 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=<reason>`] <formula-name> :
+#:  * `boneyard-formula-pr` [`--dry-run`] [`--local`] [`--reason=<reason>`] <formula> :
 #:    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 7367e5c37..91bdcba93 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=<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`]:
-#:
 #:    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 bfe9c7776..6c7b7d5b5 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=`<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.
 #:
@@ -21,17 +20,17 @@
 #:
 #:    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.
 
diff --git a/Library/Homebrew/dev-cmd/create.rb b/Library/Homebrew/dev-cmd/create.rb
index b4cda0fad..9c58dc71a 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
-#:
-#:    <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 `--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 71687dfa7..67d11edce 100644
--- a/Library/Homebrew/dev-cmd/formula.rb
+++ b/Library/Homebrew/dev-cmd/formula.rb
@@ -1,5 +1,5 @@
 #:  * `formula` <formula>:
-#:    Display the path where <formula> is
+#:    Display the path where <formula> is located.
 
 require "formula"
 
diff --git a/Library/Homebrew/dev-cmd/linkage.rb b/Library/Homebrew/dev-cmd/linkage.rb
index 44e0f224e..e4da827f2 100644
--- a/Library/Homebrew/dev-cmd/linkage.rb
+++ b/Library/Homebrew/dev-cmd/linkage.rb
@@ -1,4 +1,4 @@
-#:  * `linkage` [`--test`] [`--reverse`]  <formula-name>:
+#:  * `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
diff --git a/Library/Homebrew/dev-cmd/mirror.rb b/Library/Homebrew/dev-cmd/mirror.rb
index bd5868726..10811493c 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`] <formula-name> [<formula-name> ...]:
+#:  * `mirror` [`--test`] <formulae>:
 #:    Reuploads the stable URL for a formula to Bintray to use it as a mirror.
 
 module Homebrew
diff --git a/Library/Homebrew/dev-cmd/pull.rb b/Library/Homebrew/dev-cmd/pull.rb
index c2342d39c..98a62e578 100644
--- a/Library/Homebrew/dev-cmd/pull.rb
+++ b/Library/Homebrew/dev-cmd/pull.rb
@@ -1,33 +1,42 @@
-#: `pull` [`--bottle`] [`--bump`] [`--clean`] [`--ignore-whitespace`] [`--resolve`] [`--branch-okay`] [`--no-pbcopy`] [`--no-publish`] <patch-source> [<patch-source>]
-#:
+#:  * `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:
-#:      * The ID number of a PR (Pull Request) in the homebrew/core GitHub
+#:
+#:      ~ 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
 #:
-#:   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
-#    clipboard.
-#:   If `--no-publish` was passed, do not publish bottles to Bintray.
+#:      ~ The URL of a commit on GitHub
+#:
+#:      ~ 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.
 
 require "net/http"
 require "net/https"
diff --git a/Library/Homebrew/dev-cmd/release-notes.rb b/Library/Homebrew/dev-cmd/release-notes.rb
index 919243764..eb398fcfb 100644
--- a/Library/Homebrew/dev-cmd/release-notes.rb
+++ b/Library/Homebrew/dev-cmd/release-notes.rb
@@ -1,7 +1,7 @@
-#:  * `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.
-#:    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 <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.
 
diff --git a/Library/Homebrew/dev-cmd/tests.rb b/Library/Homebrew/dev-cmd/tests.rb
index 6276d1c1b..0c8621a01 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=`<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.
 
 require "fileutils"
diff --git a/Library/Homebrew/dev-cmd/update-test.rb b/Library/Homebrew/dev-cmd/update-test.rb
index 3b8dc11f9..9704426dd 100644
--- a/Library/Homebrew/dev-cmd/update-test.rb
+++ b/Library/Homebrew/dev-cmd/update-test.rb
@@ -1,14 +1,14 @@
-#:  * `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.
 #:
 #:    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