Merge pull request #685 from vladshablinsky/update-man-fetch-head

Update --fetch-HEAD documentation

4 files changed, 18 insertions, 14 deletions

diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb
index b0092a862..e421b2481 100644
--- a/Library/Homebrew/cmd/outdated.rb
+++ b/Library/Homebrew/cmd/outdated.rb
@@ -12,9 +12,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.
+#:    If `--fetch-HEAD` is passed, fetch the upstream repository to detect if
+#:    the HEAD installation of the formula is outdated. Otherwise, the
+#:    repository's HEAD will be checked for updates when a new stable or devel
+#:    version has been released.
 
 require "formula"
 require "keg"
diff --git a/Library/Homebrew/cmd/upgrade.rb b/Library/Homebrew/cmd/upgrade.rb
index 2306e9061..d0fa180ce 100644
--- a/Library/Homebrew/cmd/upgrade.rb
+++ b/Library/Homebrew/cmd/upgrade.rb
@@ -5,9 +5,10 @@
 #:
 #:    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 `--fetch-HEAD` is passed, fetch the upstream repository to detect if
+#:    the HEAD installation of the formula is outdated. Otherwise, the
+#:    repository's HEAD will be checked for updates when a new stable or devel
+#:    version has been released.
 #:
 #:    If <formulae> are given, upgrade only the specified brews (but do so even
 #:    if they are pinned; see `pin`, `unpin`).
diff --git a/share/doc/homebrew/brew.1.html b/share/doc/homebrew/brew.1.html
index b9b6bf3c0..e25222cd1 100644
--- a/share/doc/homebrew/brew.1.html
+++ b/share/doc/homebrew/brew.1.html
@@ -307,9 +307,10 @@ precedence over <code>--verbose</code>).</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>
 
-<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>
+<p>If <code>--fetch-HEAD</code> is passed, fetch the upstream repository to detect if
+the HEAD installation of the formula is outdated. Otherwise, the
+repository's HEAD will be checked for updates when a new stable or devel
+version has been released.</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
@@ -446,9 +447,10 @@ source. This is useful for creating patches for the software.</p></dd>
 
 <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 <code>--fetch-HEAD</code> is passed, fetch the upstream repository to detect if
+the HEAD installation of the formula is outdated. Otherwise, the
+repository's HEAD will be checked for updates when a new stable or devel
+version has been released.</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>
diff --git a/share/man/man1/brew.1 b/share/man/man1/brew.1
index f3c5f3899..2b6a16380 100644
--- a/share/man/man1/brew.1
+++ b/share/man/man1/brew.1
@@ -408,7 +408,7 @@ If \fB\-\-verbose\fR is passed, display detailed version information\.
 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\.
+If \fB\-\-fetch\-HEAD\fR is passed, fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will be checked for updates when a new stable or devel version has been released\.
 .
 .TP
 \fBpin\fR \fIformulae\fR
@@ -610,7 +610,7 @@ 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\.
+If \fB\-\-fetch\-HEAD\fR is passed, fetch the upstream repository to detect if the HEAD installation of the formula is outdated\. Otherwise, the repository\'s HEAD will be checked for updates when a new stable or devel version has been released\.
 .
 .IP
 If \fIformulae\fR are given, upgrade only the specified brews (but do so even if they are pinned; see \fBpin\fR, \fBunpin\fR)\.