aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew
diff options
context:
space:
mode:
authorMartin Afanasjew2016-08-17 01:19:40 +0200
committerMartin Afanasjew2016-08-17 01:25:51 +0200
commit823505a0584f5b114ebb29b3d66c5a1ca5ed399b (patch)
tree30235263646fde6af3a26e2c09474c45b5031c5f /Library/Homebrew
parent984ed836bd803e872a14cd32be5b0690a635274f (diff)
downloadbrew-823505a0584f5b114ebb29b3d66c5a1ca5ed399b.tar.bz2
Fix minor issues in command help text formatting
- Inconsistent or unneeded indentation - Missing or superfluous empty lines - Missing or wrongly formatted arguments in command summary - Missing punctuation
Diffstat (limited to 'Library/Homebrew')
-rw-r--r--Library/Homebrew/cmd/audit.rb4
-rw-r--r--Library/Homebrew/cmd/gist-logs.rb12
-rw-r--r--Library/Homebrew/cmd/list.rb7
-rw-r--r--Library/Homebrew/cmd/log.rb2
-rw-r--r--Library/Homebrew/cmd/missing.rb5
-rw-r--r--Library/Homebrew/cmd/reinstall.rb2
-rw-r--r--Library/Homebrew/cmd/update.sh9
-rw-r--r--Library/Homebrew/dev-cmd/bump-formula-pr.rb1
8 files changed, 20 insertions, 22 deletions
diff --git a/Library/Homebrew/cmd/audit.rb b/Library/Homebrew/cmd/audit.rb
index 464b9c020..0845faeb3 100644
--- a/Library/Homebrew/cmd/audit.rb
+++ b/Library/Homebrew/cmd/audit.rb
@@ -9,11 +9,11 @@
#:
#: If `--online` is passed, additional slower checks that require a network
#: connection are run.
-#
+#:
#: If `--new-formula` is passed, various additional checks are run that check
#: if a new formula is eligable for Homebrew. This should be used when creating
#: new formulae and implies `--strict` and `--online`.
-#
+#:
#: If `--display-cop-names` is passed, the RuboCop cop name for each violation
#: is included in the output.
#:
diff --git a/Library/Homebrew/cmd/gist-logs.rb b/Library/Homebrew/cmd/gist-logs.rb
index bcb15cd14..2c60129d1 100644
--- a/Library/Homebrew/cmd/gist-logs.rb
+++ b/Library/Homebrew/cmd/gist-logs.rb
@@ -1,13 +1,13 @@
#: * `gist-logs` [`--new-issue`|`-n`] <formula>:
-#: Upload logs for a failed build of <formula> to a new Gist.
+#: Upload logs for a failed build of <formula> to a new Gist.
#:
-#: <formula> is usually the name of the formula to install, but it can be specified
-#: in several different ways. See [SPECIFYING FORMULAE][].
+#: <formula> is usually the name of the formula to install, but it can be specified
+#: in several different ways. See [SPECIFYING FORMULAE][].
#:
-#: If `--new-issue` is passed, automatically create a new issue in the appropriate
-#: GitHub repository as well as creating the Gist.
+#: If `--new-issue` is passed, automatically create a new issue in the appropriate
+#: GitHub repository as well as creating the Gist.
#:
-#: If no logs are found, an error message is presented.
+#: If no logs are found, an error message is presented.
require "formula"
require "system_config"
diff --git a/Library/Homebrew/cmd/list.rb b/Library/Homebrew/cmd/list.rb
index eefad0ac9..80576033a 100644
--- a/Library/Homebrew/cmd/list.rb
+++ b/Library/Homebrew/cmd/list.rb
@@ -1,8 +1,7 @@
#: * `list`, `ls` [`--full-name`]:
-#: List all installed formulae. If `--full-name` is passed, print formulae with
-#: fully-qualified names.
-#: If `--full-name` is not passed any other options (e.g. `-t`) are passed to
-#: `ls` which produces the actual output.
+#: List all installed formulae. If `--full-name` is passed, print formulae
+#: with fully-qualified names. If `--full-name` is not passed, any other
+#: options (e.g. `-t`) are passed to `ls` which produces the actual output.
#:
#: * `list`, `ls` `--unbrewed`:
#: List all files in the Homebrew prefix not installed by Homebrew.
diff --git a/Library/Homebrew/cmd/log.rb b/Library/Homebrew/cmd/log.rb
index e2dd08d7c..a07107170 100644
--- a/Library/Homebrew/cmd/log.rb
+++ b/Library/Homebrew/cmd/log.rb
@@ -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)
#: recognizes can be passed before the formula list.
diff --git a/Library/Homebrew/cmd/missing.rb b/Library/Homebrew/cmd/missing.rb
index 41ad4f16d..181530562 100644
--- a/Library/Homebrew/cmd/missing.rb
+++ b/Library/Homebrew/cmd/missing.rb
@@ -1,7 +1,6 @@
#: * `missing` [<formulae>]:
-#: Check the given <formulae> for missing dependencies.
-#:
-#: If no <formulae> are given, check all installed brews.
+#: Check the given <formulae> for missing dependencies. If no <formulae> are
+#: given, check all installed brews.
require "formula"
require "tab"
diff --git a/Library/Homebrew/cmd/reinstall.rb b/Library/Homebrew/cmd/reinstall.rb
index a7bbef32d..e98e906f6 100644
--- a/Library/Homebrew/cmd/reinstall.rb
+++ b/Library/Homebrew/cmd/reinstall.rb
@@ -1,5 +1,5 @@
#: * `reinstall` <formula>:
-#: Uninstall then install <formula>
+#: Uninstall and then install <formula>.
require "formula_installer"
require "development_tools"
diff --git a/Library/Homebrew/cmd/update.sh b/Library/Homebrew/cmd/update.sh
index ba43fd6d1..dbd1a4de8 100644
--- a/Library/Homebrew/cmd/update.sh
+++ b/Library/Homebrew/cmd/update.sh
@@ -1,11 +1,12 @@
-#: * `update` [`--merge`]:
+#: * `update` [`--merge`] [`--force`]:
#: Fetch the newest version of Homebrew and all formulae from GitHub using
-#: `git`(1).
+#: `git`(1).
#:
#: If `--merge` is specified then `git merge` is used to include updates
-#: (rather than `git rebase`).
+#: (rather than `git rebase`).
+#:
#: If `--force` is specified then always do a slower, full update check even
-#: if unnecessary.
+#: if unnecessary.
# Hide shellcheck complaint:
# shellcheck source=/dev/null
diff --git a/Library/Homebrew/dev-cmd/bump-formula-pr.rb b/Library/Homebrew/dev-cmd/bump-formula-pr.rb
index bd27a569c..d875e42ac 100644
--- a/Library/Homebrew/dev-cmd/bump-formula-pr.rb
+++ b/Library/Homebrew/dev-cmd/bump-formula-pr.rb
@@ -1,6 +1,5 @@
#: * `bump-formula-pr` [`--devel`] [`--dry-run`] `--url=`<url> `--sha256=`<sha-256> <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.
#:
#: If a <url> is specified, the <sha-256> checksum of the new download must