aboutsummaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorMartin Afanasjew2015-12-12 18:47:42 +0100
committerMartin Afanasjew2015-12-13 02:20:02 +0100
commit18bf5a74a8365a990240e3931446b2a13dbbacde (patch)
treee719bba9beeec440f71807fc43b27673c2d4679b /share
parent3cc101ec5ea20f46e104aba26d3dc16b7d763fca (diff)
downloadbrew-18bf5a74a8365a990240e3931446b2a13dbbacde.tar.bz2
cleanup: consistently document --dry-run option
All other commands document both `--dry-run` and `-n` in the option description and mention only `--dry-run` in the command summary. Let's do the same for `cleanup`. Closes Homebrew/homebrew#46942. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
Diffstat (limited to 'share')
-rw-r--r--share/doc/homebrew/brew.1.html5
-rw-r--r--share/man/man1/brew.14
2 files changed, 5 insertions, 4 deletions
diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html
index 3094acd9c..6796787e6 100644
--- a/share/doc/homebrew/brew.1.html
+++ b/share/doc/homebrew/brew.1.html
@@ -49,7 +49,7 @@ connection are run. This should be used when creating for new formulae.</p>
<p><code>audit</code> exits with a non-zero status if any errors are found. This is useful,
for instance, for implementing pre-commit hooks.</p></dd>
<dt><code>cat</code> <var>formula</var></dt><dd><p>Display the source to <var>formula</var>.</p></dd>
-<dt><code>cleanup</code> [<code>--force</code>] [<code>--prune=</code><var>days</var>] [<code>-n</code>] [<code>-s</code>] [<var>formulae</var>]</dt><dd><p>For all installed or specific formulae, remove any older versions from the
+<dt><code>cleanup</code> [<code>--force</code>] [<code>--prune=</code><var>days</var>] [<code>--dry-run</code>] [<code>-s</code>] [<var>formulae</var>]</dt><dd><p>For all installed or specific formulae, remove any older versions from the
cellar. By default, does not remove out-of-date keg-only brews, as other
software may link directly to specific versions. In addition, old downloads from
the Homebrew download-cache are deleted.</p>
@@ -58,7 +58,8 @@ the Homebrew download-cache are deleted.</p>
<p>If <code>--prune=</code><var>days</var> is specified, remove all cache files older than <var>days</var>.</p>
-<p>If <code>-n</code> is passed, show what would be removed, but do not actually remove anything.</p>
+<p>If <code>--dry-run</code> or <code>-n</code> is passed, show what would be removed, but do not
+actually remove anything.</p>
<p>If <code>-s</code> is passed, scrubs the cache, removing downloads for even the latest
versions of formulae. Note downloads for any installed formulae will still not be
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index 8d5a5304c..2123f4392 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -64,7 +64,7 @@ If \fB\-\-online\fR is passed, additional slower checks that require a network c
Display the source to \fIformula\fR\.
.
.TP
-\fBcleanup\fR [\fB\-\-force\fR] [\fB\-\-prune=\fR\fIdays\fR] [\fB\-n\fR] [\fB\-s\fR] [\fIformulae\fR]
+\fBcleanup\fR [\fB\-\-force\fR] [\fB\-\-prune=\fR\fIdays\fR] [\fB\-\-dry\-run\fR] [\fB\-s\fR] [\fIformulae\fR]
For all installed or specific formulae, remove any older versions from the cellar\. By default, does not remove out\-of\-date keg\-only brews, as other software may link directly to specific versions\. In addition, old downloads from the Homebrew download\-cache are deleted\.
.
.IP
@@ -74,7 +74,7 @@ If \fB\-\-force\fR is passed, remove out\-of\-date keg\-only brews as well\.
If \fB\-\-prune=\fR\fIdays\fR is specified, remove all cache files older than \fIdays\fR\.
.
.IP
-If \fB\-n\fR is passed, show what would be removed, but do not actually remove anything\.
+If \fB\-\-dry\-run\fR or \fB\-n\fR is passed, show what would be removed, but do not actually remove anything\.
.
.IP
If \fB\-s\fR is passed, scrubs the cache, removing downloads for even the latest versions of formulae\. Note downloads for any installed formulae will still not be deleted\. If you want to delete those too: \fBrm \-rf $(brew \-\-cache)\fR