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

Update upgrade/outdated documentation (#650)

Browse Source
This commit is contained in:
Uladzislau Shablinski 2016-08-06 17:08:35 +03:00 committed by Xu Cheng
parent 072e5df4ed
commit b8ce1fe1b2
4 changed files with 29 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Library/Homebrew/cmd/outdated.rb
View File

@ -1,4 +1,4 @@
#: * `outdated` [`--quiet`|`--verbose`|`--json=v1`]:
#: * `outdated` [`--quiet`|`--verbose`|`--json=v1`] [`--fetch-HEAD`]:
#: Show formulae that have an updated version available.
#:
#: By default, version information is displayed in interactive shells, and
@ -11,6 +11,10 @@
#:
#: If `--json=`<version> is passed, the output will be in JSON format. The only
#: valid version is `v1`.
#:
#: If `--fetch-HEAD` is passed, fetch upstream repository to detect that HEAD
#: formula is outdated. Otherwise HEAD-installation is considered outdated if
#: new stable or devel version is bumped after that installation.
require "formula"
require "keg"

6
Library/Homebrew/cmd/upgrade.rb
View File

@ -1,10 +1,14 @@
#: * `upgrade` [<install-options>] [`--cleanup`] [<formulae>]:
#: * `upgrade` [<install-options>] [`--cleanup`] [`--fetch-HEAD`] [<formulae>]:
#: Upgrade outdated, unpinned brews.
#:
#: Options for the `install` command are also valid here.
#:
#: If `--cleanup` is specified then remove previously installed <formula> version(s).
#:
#: If `--fetch-HEAD` is passed, fetch upstream repository to detect that HEAD
#: formula is outdated. Otherwise HEAD-installation is considered outdated if
#: new stable or devel version is bumped after that installation.
#:
#: If <formulae> are given, upgrade only the specified brews (but do so even
#: if they are pinned; see `pin`, `unpin`).

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

@ -294,7 +294,7 @@ spaces.</p>
<p>If <code>--all</code> is passed, show options for all formulae.</p>
<p>If <code>--installed</code> is passed, show options for all installed formulae.</p></dd>
<dt><code>outdated</code> [<code>--quiet</code>|<code>--verbose</code>|<code>--json=v1</code>]</dt><dd><p>Show formulae that have an updated version available.</p>
<dt><code>outdated</code> [<code>--quiet</code>|<code>--verbose</code>|<code>--json=v1</code>] [<code>--fetch-HEAD</code>]</dt><dd><p>Show formulae that have an updated version available.</p>
<p>By default, version information is displayed in interactive shells, and
suppressed otherwise.</p>
@ -305,7 +305,11 @@ precedence over <code>--verbose</code>).</p>
<p>If <code>--verbose</code> is passed, display detailed version information.</p>
<p>If <code>--json=</code><var>version</var> is passed, the output will be in JSON format. The only
valid version is <code>v1</code>.</p></dd>
valid version is <code>v1</code>.</p>
<p>If <code>--fetch-HEAD</code> is passed, fetch upstream repository to detect that HEAD
formula is outdated. Otherwise HEAD-installation is considered outdated if
new stable or devel version is bumped after that installation.</p></dd>
<dt><code>pin</code> <var>formulae</var></dt><dd><p>Pin the specified <var>formulae</var>, preventing them from being upgraded when
issuing the <code>brew upgrade</code> command. See also <code>unpin</code>.</p></dd>
<dt><code>prune</code> [<code>--dry-run</code>]</dt><dd><p>Remove dead symlinks from the Homebrew prefix. This is generally not
@ -436,12 +440,16 @@ source. This is useful for creating patches for the software.</p></dd>
<p>If <code>--merge</code> is specified then <code>git merge</code> is used to include updates
(rather than <code>git rebase</code>).</p></dd>
<dt><code>upgrade</code> [<var>install-options</var>] [<code>--cleanup</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>
<p>Options for the <code>install</code> command are also valid here.</p>
<p>If <code>--cleanup</code> is specified then remove previously installed <var>formula</var> version(s).</p>
<p>If <code>--fetch-HEAD</code> is passed, fetch upstream repository to detect that HEAD
formula is outdated. Otherwise HEAD-installation is considered outdated if
new stable or devel version is bumped after that installation.</p>
<p>If <var>formulae</var> are given, upgrade only the specified brews (but do so even
if they are pinned; see <code>pin</code>, <code>unpin</code>).</p></dd>
<dt><code>uses</code> [<code>--installed</code>] [<code>--recursive</code>] [<code>--include-build</code>] [<code>--include-optional</code>] [<code>--skip-recommended</code>] [<code>--devel</code>|<code>--HEAD</code>] <var>formulae</var></dt><dd><p>Show the formulae that specify <var>formulae</var> as a dependency. When given

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

@ -392,7 +392,7 @@ If \fB\-\-all\fR is passed, show options for all formulae\.
If \fB\-\-installed\fR is passed, show options for all installed formulae\.
.
.TP
\fBoutdated\fR [\fB\-\-quiet\fR|\fB\-\-verbose\fR|\fB\-\-json=v1\fR]
\fBoutdated\fR [\fB\-\-quiet\fR|\fB\-\-verbose\fR|\fB\-\-json=v1\fR] [\fB\-\-fetch\-HEAD\fR]
Show formulae that have an updated version available\.
.
.IP
@ -407,6 +407,9 @@ If \fB\-\-verbose\fR is passed, display detailed version information\.
.IP
If \fB\-\-json=\fR\fIversion\fR is passed, the output will be in JSON format\. The only valid version is \fBv1\fR\.
.
.IP
If \fB\-\-fetch\-HEAD\fR is passed, fetch upstream repository to detect that HEAD formula is outdated\. Otherwise HEAD\-installation is considered outdated if new stable or devel version is bumped after that installation\.
.
.TP
\fBpin\fR \fIformulae\fR
Pin the specified \fIformulae\fR, preventing them from being upgraded when issuing the \fBbrew upgrade\fR command\. See also \fBunpin\fR\.
@ -597,7 +600,7 @@ Fetch the newest version of Homebrew and all formulae from GitHub using \fBgit\f
If \fB\-\-merge\fR is specified then \fBgit merge\fR is used to include updates (rather than \fBgit rebase\fR)\.
.
.TP
\fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fIformulae\fR]
\fBupgrade\fR [\fIinstall\-options\fR] [\fB\-\-cleanup\fR] [\fB\-\-fetch\-HEAD\fR] [\fIformulae\fR]
Upgrade outdated, unpinned brews\.
.
.IP
@ -607,6 +610,9 @@ Options for the \fBinstall\fR command are also valid here\.
If \fB\-\-cleanup\fR is specified then remove previously installed \fIformula\fR version(s)\.
.
.IP
If \fB\-\-fetch\-HEAD\fR is passed, fetch upstream repository to detect that HEAD formula is outdated\. Otherwise HEAD\-installation is considered outdated if new stable or devel version is bumped after that installation\.
.
.IP
If \fIformulae\fR are given, upgrade only the specified brews (but do so even if they are pinned; see \fBpin\fR, \fBunpin\fR)\.
.
.TP