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

cleanup: consistently document --dry-run option

Browse Source 
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>
This commit is contained in:
Martin Afanasjew 2015-12-12 18:47:42 +01:00
parent 3cc101ec5e
commit 18bf5a74a8
3 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Library/Homebrew/manpages/brew.1.md
View File

@ -55,7 +55,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
* `cat` <formula>: * `cat` <formula>:
Display the source to <formula>. Display the source to <formula>.
* `cleanup` [`--force`] [`--prune=`<days>] [`-n`] [`-s`] [<formulae>]: * `cleanup` [`--force`] [`--prune=`<days>] [`--dry-run`] [`-s`] [<formulae>]:
For all installed or specific formulae, remove any older versions from the 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 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 software may link directly to specific versions. In addition, old downloads from
@ -65,7 +65,8 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
If `--prune=`<days> is specified, remove all cache files older than <days>. If `--prune=`<days> is specified, remove all cache files older than <days>.
If `-n` is passed, show what would be removed, but do not actually remove anything. If `--dry-run` or `-n` is passed, show what would be removed, but do not
actually remove anything.
If `-s` is passed, scrubs the cache, removing downloads for even the latest If `-s` is passed, scrubs the cache, removing downloads for even the latest
versions of formulae. Note downloads for any installed formulae will still not be versions of formulae. Note downloads for any installed formulae will still not be

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

@ -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, <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> 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>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 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 software may link directly to specific versions. In addition, old downloads from
the Homebrew download-cache are deleted.</p> 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>--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 <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 versions of formulae. Note downloads for any installed formulae will still not be

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

@ -64,7 +64,7 @@ If \fB\-\-online\fR is passed, additional slower checks that require a network c
Display the source to \fIformula\fR\. Display the source to \fIformula\fR\.
. .
.TP .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\. 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 .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\. If \fB\-\-prune=\fR\fIdays\fR is specified, remove all cache files older than \fIdays\fR\.
. .
.IP .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 .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 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