aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMike McQuaid2016-09-30 08:22:37 +0100
committerGitHub2016-09-30 08:22:37 +0100
commit41b2df8e338c3fe345afc89b1bb394e824213561 (patch)
treee0df425837c6d2d9d0234cdb6f0e602fa4de9f4a /docs
parent4e7e4ca4718e2516de05cc414ad5afb46aef488b (diff)
parent779833a0c3c89076a683e82391894825693e25f6 (diff)
downloadbrew-41b2df8e338c3fe345afc89b1bb394e824213561.tar.bz2
Merge pull request #1177 from scpeters/man_exit_code
Man exit code
Diffstat (limited to 'docs')
-rw-r--r--docs/brew.1.html18
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/brew.1.html b/docs/brew.1.html
index 1aee073c1..c5cb7f642 100644
--- a/docs/brew.1.html
+++ b/docs/brew.1.html
@@ -467,7 +467,8 @@ for instance, for implementing pre-commit hooks.</p></dd>
<dt><code>bump-formula-pr</code> [<code>--devel</code>] [<code>--dry-run</code>] [<code>--audit</code>|<code>--strict</code>] <code>--tag=</code><var>tag</var> <code>--revision=</code><var>revision</var> <var>formula</var></dt><dd><p>Creates a pull request to update the formula with a new url or a new tag.</p>
<p>If a <var>url</var> is specified, the <var>sha-256</var> checksum of the new download must
-also be specified.</p>
+also be specified. A best effort to determine the <var>sha-256</var> and <var>formula</var>
+name will be made if either or both values are not supplied by the user.</p>
<p>If a <var>tag</var> is specified, the git commit <var>revision</var> corresponding to that
tag must also be specified.</p>
@@ -477,10 +478,19 @@ The development spec must already exist.</p>
<p>If <code>--dry-run</code> is passed, print what would be done rather than doing it.</p>
+<p>If <code>--write</code> is passed along with <code>--dry-run</code>, perform a not-so-dry run
+making the expected file modifications but not taking any git actions.</p>
+
<p>If <code>--audit</code> is passed, run <code>brew audit</code> before opening the PR.</p>
<p>If <code>--strict</code> is passed, run <code>brew audit --strict</code> before opening the PR.</p>
+<p>If <code>--mirror=</code><var>url</var> is passed, use the value as a mirror url.</p>
+
+<p>If <code>--version=</code><var>version</var> is passed, use the value to override the value
+parsed from the url or tag. Note that <code>--version=0</code> can be used to delete
+an existing <code>version</code> override from a formula if it has become redundant.</p>
+
<p>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
@@ -515,7 +525,11 @@ non-zero exit code if any missing libraries were found.</p>
<p>If <code>--reverse</code> is passed, print the dylib followed by the binaries
which link to it for each library the keg references.</p></dd>
-<dt class="flush"><code>man</code></dt><dd><p>Generate Homebrew's manpages.</p></dd>
+<dt><code>man</code> [<code>--fail-if-changed</code>]</dt><dd><p>Generate Homebrew's manpages.</p>
+
+<p>If <code>--fail-if-changed</code> 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.</p></dd>
</dl>