Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Note HOMEBREW_NO_INSTALL_CLEANUP in the help/manual #5658

Merged
merged 1 commit into from
Feb 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions Library/Homebrew/cmd/install.rb
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ def install_args

<formula> is usually the name of the formula to install, but it can be specified
in several different ways.

Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the installed formulae or, every 30 days, for all formulae.
EOS

switch :debug,
Expand Down
2 changes: 2 additions & 0 deletions Library/Homebrew/cmd/reinstall.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ def reinstall_args
`reinstall` [<options>] <formula>

Uninstall and then install <formula> (with existing and any appended install options).

Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the reinstalled formulae or, every 30 days, for all formulae.
EOS
switch :debug,
description: "If brewing fails, open an interactive debugging session with access to IRB "\
Expand Down
2 changes: 2 additions & 0 deletions Library/Homebrew/cmd/upgrade.rb
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ def upgrade_args

If <formula> are given, upgrade only the specified brews (unless they
are pinned; see `pin`, `unpin`).

Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the upgraded formulae or, every 30 days, for all formulae.
EOS
switch :debug,
description: "If brewing fails, open an interactive debugging session with access to IRB "\
Expand Down
4 changes: 2 additions & 2 deletions Library/Homebrew/manpages/brew.1.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -238,8 +238,8 @@ Note that environment variables must have a value set to be detected. For exampl

* `HOMEBREW_NO_INSTALL_CLEANUP`:
If set, `brew install`, `brew upgrade` and `brew reinstall` will never
automatically remove the previously installed version(s) of the
installed/upgraded formulae.
automatically cleanup the installed/upgraded/reinstalled formulae or all
formulae every 30 days.

* `HOMEBREW_PRY`:
If set, Homebrew will use Pry for the `brew irb` command.
Expand Down
10 changes: 8 additions & 2 deletions docs/Manpage.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,8 @@ Install *`formula`*.
*`formula`* is usually the name of the formula to install, but it can be specified
in several different ways.

Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the installed formulae or, every 30 days, for all formulae.

* `--env`:
If `std` is passed, use the standard build environment instead of superenv.If `super` is passed, use superenv even if the formula specifies the standard build environment.
* `--ignore-dependencies`:
Expand Down Expand Up @@ -362,6 +364,8 @@ all formulae or to determine if any current formulae have Ruby issues.

Uninstall and then install *`formula`* (with existing and any appended install options).

Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the reinstalled formulae or, every 30 days, for all formulae.

* `-s`, `--build-from-source`:
Compile *`formula`* from source even if a bottle is available.
* `--force-bottle`:
Expand Down Expand Up @@ -538,6 +542,8 @@ Upgrade outdated, unpinned brews (with existing and any appended install options
If *`formula`* are given, upgrade only the specified brews (unless they
are pinned; see `pin`, `unpin`).

Unless `HOMEBREW_NO_INSTALL_CLEANUP` is set, `brew cleanup` will be run for the upgraded formulae or, every 30 days, for all formulae.

* `-s`, `--build-from-source`:
Compile *`formula`* from source even if a bottle is available.
* `--force-bottle`:
Expand Down Expand Up @@ -1107,8 +1113,8 @@ Note that environment variables must have a value set to be detected. For exampl

* `HOMEBREW_NO_INSTALL_CLEANUP`:
If set, `brew install`, `brew upgrade` and `brew reinstall` will never
automatically remove the previously installed version(s) of the
installed/upgraded formulae.
automatically cleanup the installed/upgraded/reinstalled formulae or all
formulae every 30 days.

* `HOMEBREW_PRY`:
If set, Homebrew will use Pry for the `brew irb` command.
Expand Down
11 changes: 10 additions & 1 deletion manpages/brew.1
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,9 @@ Install \fIformula\fR\.
.P
\fIformula\fR is usually the name of the formula to install, but it can be specified in several different ways\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will be run for the installed formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-\-env\fR
If \fBstd\fR is passed, use the standard build environment instead of superenv\.If \fBsuper\fR is passed, use superenv even if the formula specifies the standard build environment\.
Expand Down Expand Up @@ -453,6 +456,9 @@ Syntax\-check all of Homebrew\'s Ruby files\.
.SS "\fBreinstall\fR [\fIoptions\fR] \fIformula\fR"
Uninstall and then install \fIformula\fR (with existing and any appended install options)\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will be run for the reinstalled formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is available\.
Expand Down Expand Up @@ -652,6 +658,9 @@ Upgrade outdated, unpinned brews (with existing and any appended install options
.P
If \fIformula\fR are given, upgrade only the specified brews (unless they are pinned; see \fBpin\fR, \fBunpin\fR)\.
.
.P
Unless \fBHOMEBREW_NO_INSTALL_CLEANUP\fR is set, \fBbrew cleanup\fR will be run for the upgraded formulae or, every 30 days, for all formulae\.
.
.TP
\fB\-s\fR, \fB\-\-build\-from\-source\fR
Compile \fIformula\fR from source even if a bottle is available\.
Expand Down Expand Up @@ -1336,7 +1345,7 @@ If set, Homebrew will not use the GitHub API, e\.g\. for searches or fetching re
.
.TP
\fBHOMEBREW_NO_INSTALL_CLEANUP\fR
If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will never automatically remove the previously installed version(s) of the installed/upgraded formulae\.
If set, \fBbrew install\fR, \fBbrew upgrade\fR and \fBbrew reinstall\fR will never automatically cleanup the installed/upgraded/reinstalled formulae or all formulae every 30 days\.
.
.TP
\fBHOMEBREW_PRY\fR
Expand Down