From 6c2f41b90cc77349f594be555aed7d01d5a9f3db Mon Sep 17 00:00:00 2001
From: Jarek Wojciechowski <jarekwojo@gmail.com>
Date: Tue, 30 Oct 2018 10:19:45 -0400
Subject: [PATCH] Update docs and manpage for HOMEBREW_INSTALL_CLEANUP

---
 Library/Homebrew/cmd/install.rb   |  2 +-
 Library/Homebrew/cmd/reinstall.rb |  2 +-
 docs/Manpage.md                   | 12 ++++++++----
 manpages/brew.1                   |  8 +++++++-
 4 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/Library/Homebrew/cmd/install.rb b/Library/Homebrew/cmd/install.rb
index 26ef6655e4..f7c233b923 100644
--- a/Library/Homebrew/cmd/install.rb
+++ b/Library/Homebrew/cmd/install.rb
@@ -75,7 +75,7 @@
 #:    creating patches to the software.
 #:
 #:    If `HOMEBREW_INSTALL_CLEANUP` is set then remove previously installed versions
-#:    of upgraded <formulae>.
+#:    of upgraded <formulae> as well as the HOMEBREW_CACHE for that formula.
 
 require "missing_formula"
 require "formula_installer"
diff --git a/Library/Homebrew/cmd/reinstall.rb b/Library/Homebrew/cmd/reinstall.rb
index 38adf73e0f..6bd1f41f88 100644
--- a/Library/Homebrew/cmd/reinstall.rb
+++ b/Library/Homebrew/cmd/reinstall.rb
@@ -5,7 +5,7 @@
 #:    at the end of the run.
 #:
 #:    If `HOMEBREW_INSTALL_CLEANUP` is set then remove previously installed versions
-#:    of upgraded <formulae>.
+#:    of upgraded <formulae> as well as the HOMEBREW_CACHE for that formula.
 
 require "formula_installer"
 require "development_tools"
diff --git a/docs/Manpage.md b/docs/Manpage.md
index 6264439cd4..d033dec5f2 100644
--- a/docs/Manpage.md
+++ b/docs/Manpage.md
@@ -311,6 +311,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
     If `--git` (or `-g`) is passed, Homebrew will create a Git repository, useful for
     creating patches to the software.
 
+    If `HOMEBREW_INSTALL_CLEANUP` is set then remove previously installed versions
+    of upgraded *`formulae`* as well as the HOMEBREW_CACHE for that formula.
+
   * `leaves`:
     Show installed formulae that are not dependencies of another installed formula.
 
@@ -428,6 +431,9 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
     If `--display-times` is passed, install times for each formula are printed
     at the end of the run.
 
+    If `HOMEBREW_INSTALL_CLEANUP` is set then remove previously installed versions
+    of upgraded *`formulae`* as well as the HOMEBREW_CACHE for that formula.
+
   * `search`, `-S`:
     Display all locally available formulae (including tapped ones).
     No online search is performed.
@@ -601,7 +607,7 @@ With `--verbose` or `-v`, many commands print extra debugging information. Note
 
     Options for the `install` command are also valid here.
 
-    If `--cleanup` is specified or `HOMEBREW_UPGRADE_CLEANUP` is set then remove
+    If `--cleanup` is specified or `HOMEBREW_INSTALL_CLEANUP` is set then remove
     previously installed version(s) of upgraded *`formulae`*.
 
     If `--fetch-HEAD` is passed, fetch the upstream repository to detect if
@@ -1255,10 +1261,8 @@ Note that environment variables must have a value set to be detected. For exampl
     This issue typically occurs when using FileVault or custom SSD
     configurations.
 
-  * `HOMEBREW_INSTALL_CLEANUP`:
+  * `HOMEBREW_UPGRADE_CLEANUP`:
     If set, `brew upgrade` always assumes `--cleanup` has been passed.
-    Additionally, `brew install` and `brew reinstall` will clean up associated
-    formulae.
 
   * `HOMEBREW_VERBOSE`:
     If set, Homebrew always assumes `--verbose` when running commands.
diff --git a/manpages/brew.1 b/manpages/brew.1
index 48c71f5902..540edab73a 100644
--- a/manpages/brew.1
+++ b/manpages/brew.1
@@ -315,6 +315,9 @@ If \fB\-\-interactive\fR (or \fB\-i\fR) is passed, download and patch \fIformula
 .IP
 If \fB\-\-git\fR (or \fB\-g\fR) is passed, Homebrew will create a Git repository, useful for creating patches to the software\.
 .
+.IP
+If \fBHOMEBREW_INSTALL_CLEANUP\fR is set then remove previously installed versions of upgraded \fIformulae\fR as well as the HOMEBREW_CACHE for that formula\.
+.
 .TP
 \fBleaves\fR
 Show installed formulae that are not dependencies of another installed formula\.
@@ -438,6 +441,9 @@ Uninstall and then install \fIformula\fR (with existing install options)\.
 .IP
 If \fB\-\-display\-times\fR is passed, install times for each formula are printed at the end of the run\.
 .
+.IP
+If \fBHOMEBREW_INSTALL_CLEANUP\fR is set then remove previously installed versions of upgraded \fIformulae\fR as well as the HOMEBREW_CACHE for that formula\.
+.
 .TP
 \fBsearch\fR, \fB\-S\fR
 Display all locally available formulae (including tapped ones)\. No online search is performed\.
@@ -614,7 +620,7 @@ Upgrade outdated, unpinned brews (with existing install options)\.
 Options for the \fBinstall\fR command are also valid here\.
 .
 .IP
-If \fB\-\-cleanup\fR is specified or \fBHOMEBREW_UPGRADE_CLEANUP\fR is set then remove previously installed version(s) of upgraded \fIformulae\fR\.
+If \fB\-\-cleanup\fR is specified or \fBHOMEBREW_INSTALL_CLEANUP\fR is set then remove previously installed version(s) of upgraded \fIformulae\fR\.
 .
 .IP
 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\.