aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMike McQuaid2016-10-01 12:19:51 +0100
committerMike McQuaid2016-10-01 12:19:51 +0100
commit099f69e612e2b0399b5bf18199a82afbc7a3f71f (patch)
tree8c13d31a54a265d9012a8fe28029d039819d0fea
parentc64ce3ef07dbbba79f311c1dd928c743fc897667 (diff)
downloadbrew-099f69e612e2b0399b5bf18199a82afbc7a3f71f.tar.bz2
man: note --fail-if-changed date behaviour change.
As requested in #1199 this updates the documentation accordingly for that change.
-rw-r--r--Library/Homebrew/dev-cmd/man.rb2
-rw-r--r--docs/brew.1.html4
-rw-r--r--manpages/brew-cask.12
-rw-r--r--manpages/brew.14
4 files changed, 8 insertions, 4 deletions
diff --git a/Library/Homebrew/dev-cmd/man.rb b/Library/Homebrew/dev-cmd/man.rb
index 6c0c00747..d34d559f7 100644
--- a/Library/Homebrew/dev-cmd/man.rb
+++ b/Library/Homebrew/dev-cmd/man.rb
@@ -4,6 +4,8 @@
#: If `--fail-if-changed` is passed, the command will return a failing
#: status code if changes are detected in the manpage outputs.
#: This can be used for CI to be notified when the manpages are out of date.
+#: Additionally, the date used in new manpages will match those in the existing
+#: manpages (to allow comparison without factoring in the date).
require "formula"
require "erb"
diff --git a/docs/brew.1.html b/docs/brew.1.html
index c5cb7f642..bfdd885f0 100644
--- a/docs/brew.1.html
+++ b/docs/brew.1.html
@@ -529,7 +529,9 @@ which link to it for each library the keg references.</p></dd>
<p>If <code>--fail-if-changed</code> is passed, the command will return a failing
status code if changes are detected in the manpage outputs.
-This can be used for CI to be notified when the manpages are out of date.</p></dd>
+This can be used for CI to be notified when the manpages are out of date.
+Additionally, the date used in new manpages will match those in the existing
+manpages (to allow comparison without factoring in the date).</p></dd>
</dl>
diff --git a/manpages/brew-cask.1 b/manpages/brew-cask.1
index 850d69489..8b969221d 100644
--- a/manpages/brew-cask.1
+++ b/manpages/brew-cask.1
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "BREW\-CASK" "1" "September 2016" "Homebrew" "brew-cask"
+.TH "BREW\-CASK" "1" "October 2016" "Homebrew" "brew-cask"
.
.SH "NAME"
\fBbrew\-cask\fR \- a friendly binary installer for macOS
diff --git a/manpages/brew.1 b/manpages/brew.1
index f32a6282b..2642a0e28 100644
--- a/manpages/brew.1
+++ b/manpages/brew.1
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
-.TH "BREW" "1" "September 2016" "Homebrew" "brew"
+.TH "BREW" "1" "October 2016" "Homebrew" "brew"
.
.SH "NAME"
\fBbrew\fR \- The missing package manager for macOS
@@ -730,7 +730,7 @@ If \fB\-\-reverse\fR is passed, print the dylib followed by the binaries which l
Generate Homebrew\'s manpages\.
.
.IP
-If \fB\-\-fail\-if\-changed\fR is passed, the command will return a failing status code if changes are detected in the manpage outputs\. This can be used for CI to be notified when the manpages are out of date\.
+If \fB\-\-fail\-if\-changed\fR is passed, the command will return a failing status code if changes are detected in the manpage outputs\. This can be used for CI to be notified when the manpages are out of date\. Additionally, the date used in new manpages will match those in the existing manpages (to allow comparison without factoring in the date)\.
.
.P
\fBpull\fR [\fB\-\-bottle\fR] [\fB\-\-bump\fR] [\fB\-\-clean\fR] [\fB\-\-ignore\-whitespace\fR] [\fB\-\-resolve\fR] [\fB\-\-branch\-okay\fR] [\fB\-\-no\-pbcopy\fR] [\fB\-\-no\-publish\fR] \fIpatch\-source\fR [\fIpatch\-source\fR]