admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Fix minor issues in command help text formatting

Browse Source 
- Inconsistent or unneeded indentation
- Missing or superfluous empty lines
- Missing or wrongly formatted arguments in command summary
- Missing punctuation
This commit is contained in:
Martin Afanasjew 2016-08-17 01:19:40 +02:00
parent 984ed836bd
commit 823505a058
10 changed files with 61 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Library/Homebrew/cmd/audit.rb
View File

@ -9,11 +9,11 @@
#: #:
#: If `--online` is passed, additional slower checks that require a network #: If `--online` is passed, additional slower checks that require a network
#: connection are run. #: connection are run.
# #:
#: If `--new-formula` is passed, various additional checks are run that check #: 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 #: if a new formula is eligable for Homebrew. This should be used when creating
#: new formulae and implies `--strict` and `--online`. #: new formulae and implies `--strict` and `--online`.
# #:
#: If `--display-cop-names` is passed, the RuboCop cop name for each violation #: If `--display-cop-names` is passed, the RuboCop cop name for each violation
#: is included in the output. #: is included in the output.
#: #:

7
Library/Homebrew/cmd/list.rb
View File

@ -1,8 +1,7 @@
#: * `list`, `ls` [`--full-name`]: #: * `list`, `ls` [`--full-name`]:
#: List all installed formulae. If `--full-name` is passed, print formulae with #: List all installed formulae. If `--full-name` is passed, print formulae
#: fully-qualified names. #: with fully-qualified names. If `--full-name` is not passed, any other
#: If `--full-name` is not passed any other options (e.g. `-t`) are passed to #: options (e.g. `-t`) are passed to `ls` which produces the actual output.
#: `ls` which produces the actual output.
#: #:
#: * `list`, `ls` `--unbrewed`: #: * `list`, `ls` `--unbrewed`:
#: List all files in the Homebrew prefix not installed by Homebrew. #: List all files in the Homebrew prefix not installed by Homebrew.

2
Library/Homebrew/cmd/log.rb
View File

@ -1,4 +1,4 @@
#: * `log` [`git-log-options`] <formula> ...: #: * `log` [<git-log-options>] <formula> ...:
#: Show the git log for the given formulae. Options that `git-log`(1) #: Show the git log for the given formulae. Options that `git-log`(1)
#: recognizes can be passed before the formula list. #: recognizes can be passed before the formula list.

5
Library/Homebrew/cmd/missing.rb
View File

@ -1,7 +1,6 @@
#: * `missing` [<formulae>]: #: * `missing` [<formulae>]:
#: Check the given <formulae> for missing dependencies. #: Check the given <formulae> for missing dependencies. If no <formulae> are
#: #: given, check all installed brews.
#: If no <formulae> are given, check all installed brews.
require "formula" require "formula"
require "tab" require "tab"

2
Library/Homebrew/cmd/reinstall.rb
View File

@ -1,5 +1,5 @@
#: * `reinstall` <formula>: #: * `reinstall` <formula>:
#: Uninstall then install <formula> #: Uninstall and then install <formula>.
require "formula_installer" require "formula_installer"
require "development_tools" require "development_tools"

3
Library/Homebrew/cmd/update.sh
View File

@ -1,9 +1,10 @@
#: * `update` [`--merge`]: #: * `update` [`--merge`] [`--force`]:
#: Fetch the newest version of Homebrew and all formulae from GitHub using #: 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 #: 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 `--force` is specified then always do a slower, full update check even
#: if unnecessary. #: if unnecessary.

1
Library/Homebrew/dev-cmd/bump-formula-pr.rb
View File

@ -1,6 +1,5 @@
#: * `bump-formula-pr` [`--devel`] [`--dry-run`] `--url=`<url> `--sha256=`<sha-256> <formula>: #: * `bump-formula-pr` [`--devel`] [`--dry-run`] `--url=`<url> `--sha256=`<sha-256> <formula>:
#: * `bump-formula-pr` [`--devel`] [`--dry-run`] `--tag=`<tag> `--revision=`<revision> <formula>: #: * `bump-formula-pr` [`--devel`] [`--dry-run`] `--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

33
share/doc/homebrew/brew.1.html
View File

@ -48,11 +48,13 @@ run before submitting a new formula.</p>
style checks.</p> style checks.</p>
<p>If <code>--online</code> is passed, additional slower checks that require a network <p>If <code>--online</code> is passed, additional slower checks that require a network
connection are run. connection are run.</p>
If <code>--new-formula</code> is passed, various additional checks are run that check
<p>If <code>--new-formula</code> is passed, various additional checks are run that check
if a new formula is eligable for Homebrew. This should be used when creating if a new formula is eligable for Homebrew. This should be used when creating
new formulae and implies <code>--strict</code> and <code>--online</code>. new formulae and implies <code>--strict</code> and <code>--online</code>.</p>
If <code>--display-cop-names</code> is passed, the RuboCop cop name for each violation
<p>If <code>--display-cop-names</code> is passed, the RuboCop cop name for each violation
is included in the output.</p> is included in the output.</p>
<p>If <code>--display-filename</code> is passed, every line of output is prefixed with the <p>If <code>--display-filename</code> is passed, every line of output is prefixed with the
@ -263,10 +265,9 @@ into <code>/Applications</code>, allowing for easier access.</p>
<p>If provided, <code>--local</code> will symlink them into the user's <code>~/Applications</code> <p>If provided, <code>--local</code> will symlink them into the user's <code>~/Applications</code>
directory instead of the system directory.</p></dd> directory instead of the system directory.</p></dd>
<dt><code>list</code>, <code>ls</code> [<code>--full-name</code>]</dt><dd><p>List all installed formulae. If <code>--full-name</code> is passed, print formulae with <dt><code>list</code>, <code>ls</code> [<code>--full-name</code>]</dt><dd><p>List all installed formulae. If <code>--full-name</code> is passed, print formulae
fully-qualified names. with fully-qualified names. If <code>--full-name</code> is not passed, any other
If <code>--full-name</code> is not passed any other options (e.g. <code>-t</code>) are passed to options (e.g. <code>-t</code>) are passed to <code>ls</code> which produces the actual output.</p></dd>
<code>ls</code> which produces the actual output.</p></dd>
<dt><code>list</code>, <code>ls</code> <code>--unbrewed</code></dt><dd><p>List all files in the Homebrew prefix not installed by Homebrew.</p></dd> <dt><code>list</code>, <code>ls</code> <code>--unbrewed</code></dt><dd><p>List all files in the Homebrew prefix not installed by Homebrew.</p></dd>
<dt><code>list</code>, <code>ls</code> [<code>--versions</code> [<code>--multiple</code>]] [<code>--pinned</code>] [<var>formulae</var>]</dt><dd><p>List the installed files for <var>formulae</var>. Combined with <code>--verbose</code>, recursively <dt><code>list</code>, <code>ls</code> [<code>--versions</code> [<code>--multiple</code>]] [<code>--pinned</code>] [<var>formulae</var>]</dt><dd><p>List the installed files for <var>formulae</var>. Combined with <code>--verbose</code>, recursively
list the contents of all subdirectories in each <var>formula</var>'s keg.</p> list the contents of all subdirectories in each <var>formula</var>'s keg.</p>
@ -278,16 +279,15 @@ only show formulae with multiple versions installed.</p>
<p>If <code>--pinned</code> is passed, show the versions of pinned formulae, or only the <p>If <code>--pinned</code> is passed, show the versions of pinned formulae, or only the
specified (pinned) formulae if <var>formulae</var> are given. specified (pinned) formulae if <var>formulae</var> are given.
See also <code>pin</code>, <code>unpin</code>.</p></dd> See also <code>pin</code>, <code>unpin</code>.</p></dd>
<dt><code>log</code> [<code>git-log-options</code>] <var>formula</var> ...</dt><dd><p>Show the git log for the given formulae. Options that <code>git-log</code>(1) <dt><code>log</code> [<var>git-log-options</var>] <var>formula</var> ...</dt><dd><p>Show the git log for the given formulae. Options that <code>git-log</code>(1)
recognizes can be passed before the formula list.</p></dd> recognizes can be passed before the formula list.</p></dd>
<dt><code>migrate</code> [<code>--force</code>] <var>formulae</var></dt><dd><p>Migrate renamed packages to new name, where <var>formulae</var> are old names of <dt><code>migrate</code> [<code>--force</code>] <var>formulae</var></dt><dd><p>Migrate renamed packages to new name, where <var>formulae</var> are old names of
packages.</p> packages.</p>
<p>If <code>--force</code> is passed, then treat installed <var>formulae</var> and passed <var>formulae</var> <p>If <code>--force</code> is passed, then treat installed <var>formulae</var> and passed <var>formulae</var>
like if they are from same taps and migrate them anyway.</p></dd> like if they are from same taps and migrate them anyway.</p></dd>
<dt><code>missing</code> [<var>formulae</var>]</dt><dd><p>Check the given <var>formulae</var> for missing dependencies.</p> <dt><code>missing</code> [<var>formulae</var>]</dt><dd><p>Check the given <var>formulae</var> for missing dependencies. If no <var>formulae</var> are
given, check all installed brews.</p></dd>
<p>If no <var>formulae</var> are given, check all installed brews.</p></dd>
<dt><code>options</code> [<code>--compact</code>] (<code>--all</code>|<code>--installed</code>|<var>formulae</var>)</dt><dd><p>Display install options specific to <var>formulae</var>.</p> <dt><code>options</code> [<code>--compact</code>] (<code>--all</code>|<code>--installed</code>|<var>formulae</var>)</dt><dd><p>Display install options specific to <var>formulae</var>.</p>
<p>If <code>--compact</code> is passed, show all options on a single line separated by <p>If <code>--compact</code> is passed, show all options on a single line separated by
@ -322,7 +322,7 @@ created by <code>brew linkapps</code>.</p>
<p>If <code>--dry-run</code> or <code>-n</code> is passed, show what would be removed, but do not <p>If <code>--dry-run</code> or <code>-n</code> is passed, show what would be removed, but do not
actually remove anything.</p></dd> actually remove anything.</p></dd>
<dt><code>reinstall</code> <var>formula</var></dt><dd><p>Uninstall then install <var>formula</var></p></dd> <dt><code>reinstall</code> <var>formula</var></dt><dd><p>Uninstall and then install <var>formula</var>.</p></dd>
<dt><code>search</code>, <code>-S</code></dt><dd><p>Display all locally available formulae for brewing (including tapped ones). <dt><code>search</code>, <code>-S</code></dt><dd><p>Display all locally available formulae for brewing (including tapped ones).
No online search is performed if called without arguments.</p></dd> No online search is performed if called without arguments.</p></dd>
<dt><code>search</code> [<code>--desc</code>] <var>text</var>|<code>/</code><var>text</var><code>/</code></dt><dd><p>Perform a substring search of formula names for <var>text</var>. If <var>text</var> is <dt><code>search</code> [<code>--desc</code>] <var>text</var>|<code>/</code><var>text</var><code>/</code></dt><dd><p>Perform a substring search of formula names for <var>text</var>. If <var>text</var> is
@ -438,12 +438,13 @@ source. This is useful for creating patches for the software.</p></dd>
<dt><code>unpin</code> <var>formulae</var></dt><dd><p>Unpin <var>formulae</var>, allowing them to be upgraded by <code>brew upgrade</code>. See also <dt><code>unpin</code> <var>formulae</var></dt><dd><p>Unpin <var>formulae</var>, allowing them to be upgraded by <code>brew upgrade</code>. See also
<code>pin</code>.</p></dd> <code>pin</code>.</p></dd>
<dt><code>untap</code> <var>tap</var></dt><dd><p>Remove a tapped repository.</p></dd> <dt><code>untap</code> <var>tap</var></dt><dd><p>Remove a tapped repository.</p></dd>
<dt><code>update</code> [<code>--merge</code>]</dt><dd><p>Fetch the newest version of Homebrew and all formulae from GitHub using <dt><code>update</code> [<code>--merge</code>] [<code>--force</code>]</dt><dd><p>Fetch the newest version of Homebrew and all formulae from GitHub using
<code>git</code>(1).</p> <code>git</code>(1).</p>
<p>If <code>--merge</code> is specified then <code>git merge</code> is used to include updates <p>If <code>--merge</code> is specified then <code>git merge</code> is used to include updates
(rather than <code>git rebase</code>). (rather than <code>git rebase</code>).</p>
If <code>--force</code> is specified then always do a slower, full update check even
<p>If <code>--force</code> is specified then always do a slower, full update check even
if unnecessary.</p></dd> if unnecessary.</p></dd>
<dt><code>upgrade</code> [<var>install-options</var>] [<code>--cleanup</code>] [<code>--fetch-HEAD</code>] [<var>formulae</var>]</dt><dd><p>Upgrade outdated, unpinned brews.</p> <dt><code>upgrade</code> [<var>install-options</var>] [<code>--cleanup</code>] [<code>--fetch-HEAD</code>] [<var>formulae</var>]</dt><dd><p>Upgrade outdated, unpinned brews.</p>

26
share/man/man1/brew.1
View File

@ -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\. If \fB\-\-strict\fR is passed, additional checks are run, including RuboCop style checks\.
. .
.IP .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 .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\. 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 .TP
\fBlist\fR, \fBls\fR [\fB\-\-full\-name\fR] \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 .TP
\fBlist\fR, \fBls\fR \fB\-\-unbrewed\fR \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\. 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 .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\. Show the git log for the given formulae\. Options that \fBgit\-log\fR(1) recognizes can be passed before the formula list\.
. .
.TP .TP
@ -373,10 +379,7 @@ If \fB\-\-force\fR is passed, then treat installed \fIformulae\fR and passed \fI
. .
.TP .TP
\fBmissing\fR [\fIformulae\fR] \fBmissing\fR [\fIformulae\fR]
Check the given \fIformulae\fR for missing dependencies\. Check the given \fIformulae\fR for missing dependencies\. If no \fIformulae\fR are given, check all installed brews\.
.
.IP
If no \fIformulae\fR are given, check all installed brews\.
. .
.TP .TP
\fBoptions\fR [\fB\-\-compact\fR] (\fB\-\-all\fR|\fB\-\-installed\fR|\fIformulae\fR) \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 .TP
\fBreinstall\fR \fIformula\fR \fBreinstall\fR \fIformula\fR
Uninstall then install \fIformula\fR Uninstall and then install \fIformula\fR\.
. .
.TP .TP
\fBsearch\fR, \fB\-S\fR \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\. Remove a tapped repository\.
. .
.TP .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)\. Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\fR(1)\.
. .
.IP .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 .TP
\fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fB\-\-fetch\-HEAD\fR] [\fIformulae\fR] \fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fB\-\-fetch\-HEAD\fR] [\fIformulae\fR]