From 7fa9c0e9778d50f88ff7cf8ac18c7f198fd9c9fd Mon Sep 17 00:00:00 2001
From: Vlad Shablinsky
Date: Thu, 11 Aug 2016 09:28:29 +0200
Subject: [PATCH] Update --fetch-HEAD documentation
---
Library/Homebrew/cmd/outdated.rb | 7 ++++---
Library/Homebrew/cmd/upgrade.rb | 7 ++++---
share/doc/homebrew/brew.1.html | 14 ++++++++------
share/man/man1/brew.1 | 4 ++--
4 files changed, 18 insertions(+), 14 deletions(-)
diff --git a/Library/Homebrew/cmd/outdated.rb b/Library/Homebrew/cmd/outdated.rb
index b0092a862e..e421b24818 100644
--- a/Library/Homebrew/cmd/outdated.rb
+++ b/Library/Homebrew/cmd/outdated.rb
@@ -12,9 +12,10 @@
#: If `--json=` 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 2306e9061b..d0fa180ce2 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 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 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 b9b6bf3c00..e25222cd10 100644
--- a/share/doc/homebrew/brew.1.html
+++ b/share/doc/homebrew/brew.1.html
@@ -307,9 +307,10 @@ precedence over --verbose).
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.
pin formulaePin the specified formulae, preventing them from being upgraded when
issuing the brew upgrade command. See also unpin.
prune [--dry-run]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.
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/man/man1/brew.1 b/share/man/man1/brew.1
index f3c5f38995..2b6a16380b 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)\.