77 Commits

Author SHA1 Message Date
Mike Miller
cf4d5c80c0 man: mention HOMEBREW_DISPLAY in man page 2019-02-12 12:39:59 -08:00
Mike McQuaid
947b90961b
Note leadership changes
Today the Homebrew maintainers elected a new PLC, TSC and project lead.
Documentation is to follow detailing exactly the responsibilities for
each of these roles but adjust these to reflect the current state until
that point.
2019-02-04 17:09:31 +01:00
Mike McQuaid
267d721988
Note HOMEBREW_NO_INSTALL_CLEANUP in the help/manual 2019-02-03 09:34:00 +01:00
Mike McQuaid
a10ba20459
brew.1.md.erb: improve output consistency. 2019-01-30 21:39:29 +00:00
Mike McQuaid
eed1444d61
Update deprecations and cleanup
- Move `odeprecated` to `odisabled`
- Remove `odisabled`
- Enable automatic cleanup on install/reinstall/upgrade.
2019-01-23 21:57:40 +00:00
Maxim Belkin
e89cdf3681
Fiks HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK description
This change fixes a syntax error introduced in b278165da
2019-01-14 16:29:42 -06:00
Mike McQuaid
b278165dab
Add HOMEBREW_NO_BOTTLE_SOURCE_FALLBACK variable
If set, Homebrew will fail if on the failure of installation from a
bottle rather than falling back to building from source.
2019-01-12 12:08:18 +00:00
Mike McQuaid
170c5493a4
Update deprecations
- Add some `odeprecated`
- Make some `odeprecated` now `odisabled`
- Remove `odisabled` code.
- Remove old update migrations
- Remove GCC 4.0 compiler
- Remove Tiger-only code
- Remove 32-bit-only code
- Remove use of LD64
- Remove GCC 4.3 - 4.8 support.
2019-01-08 19:13:46 +00:00
Mike McQuaid
8144667a71
Cleanup periodically if HOMEBREW_INSTALL_CLEANUP is set.
This will become the default in a later version of Homebrew but has an
opt-out through HOMEBREW_NO_INSTALL_CLEANUP.

Also, always cleanup files older than 120 days and set the general
default value for "old" logs, casks etc. to 30 days.
2019-01-03 16:23:44 +00:00
EricFromCanada
799086f548 docs: update man page text 2018-12-04 10:47:38 -05:00
Bryce Glover
387fb2fde0 man: Mention neither HOMEBREW_DEBUG_INSTALL nor HOMEBREW_DEBUG_PREFIX any
more.

     `brew`'s `man` page's 'ENVIRONMENT' section is intended to list only those
environment variables that users can set, not any that Homebrew sets as part of
its operation.
2018-11-30 13:00:10 -05:00
Mike McQuaid
70bf0d39f3
manpage: add HOMEBREW_UPDATE_TO_TAG docs. 2018-11-25 20:16:27 +00:00
Ivan Pozdeev
57b744680c docs: bottle is a valid formula specifier, too 2018-11-10 20:33:51 +03:00
EricFromCanada
9e4fb40f92 docs: update descriptions of git- and curl-related vars
Note that the `HOMEBREW_FORCE_BREWED_` vars are automatically set if the system `git` and `curl` are too old. Drop mention of `HOMEBREW_GIT` which isn't user-settable.
2018-10-26 23:47:59 -04:00
EricFromCanada
b2b8f632bb docs: distinguish <code> and <var> in HTML output
Replace <var> tags with markup for italicized monospaced text in Markdown.
This requires the source to not combine bracketed and backticked text.
2018-10-06 00:51:13 -04:00
EricFromCanada
997a207889 docs: fix Official External Commands section
Work around ronn's inability to nest indents within list items by modifying its output to add a line break and indent after lines ending with a colon that aren't a list item's first line. This allows `brew.1.md.erb` to join the commands' help text without extra line breaks, which avoids the issue where kramdown was turning any command specs containing pipe characters into tables in the HTML output.
2018-10-05 23:47:48 -04:00
Gautham Goli
446b1cb9e3
man: Seperate global options into a section 2018-10-03 19:49:45 +05:30
Jonathan Chang
812ba7ea59 Update manpages about artifact/bottle variables 2018-08-14 00:56:26 -04:00
Mike McQuaid
daa3e415d6 Add/remove more maintainers.
And remove the Homebrew/homebrew-core lead maintainer role.
2018-08-08 09:41:26 +01:00
Mike McQuaid
ba410959c0 Add new maintainers
Also add some who were missing (sorry folks) and our Linux maintainers.
2018-08-07 10:51:16 +01:00
Markus Reiter
13c65eed70 Change docs to use symbols instead of class names. 2018-08-03 17:50:57 +02:00
Mike McQuaid
ee5a073b05 Add the SFC PLC to the README and manpage.
Let's document these so people know who the leadership team behind the
project is.
2018-08-02 13:26:02 +01:00
Mike McQuaid
6417332a3a Change Mojave bottle behaviour
Rather than relying on a `HOMEBREW_FORCE_BOTTLE` variable (which ends
up doing silly things like forcing bottle usage even when options are
provided) instead handle this at the `or_later` bottle detection
level so on prerelease versions of macOS any bottle looks like an
`or_later` bottle (unless various environment variables are set).

Fixes issues noted in:
https://github.com/Homebrew/brew/pull/4520#issuecomment-407229605
2018-07-24 09:25:32 +01:00
Mike McQuaid
3e93d4c6cf Add HOMEBREW_FORCE_BOTTLE variable
This does the equivalent of always passing `--force-bottle`. This will
be enabled by default on Mojave to allow people to avoid building
everything from source until our porting and bottling is a bit further
along.
2018-07-20 14:28:14 +01:00
Jack Haden-Enneking
9fd5a92ff6 Implement HOMEBREW_FORCE_BREWED_GIT
Because of this messing with the user's path:
https://github.com/Homebrew/brew/blob/
    efc02899c851c62c9ce0d15dea9a231575d7d774/bin/brew#L68
brew uses /usr/bin/git over brewed git, even when the former is
problematically old.
There may also be other reasons a user prefers to use brewed git.

There was already a HOMEBREW_FORCE_BREWED_CURL option and a
HOMEBREW_SYSTEM_CURL_TOO_OLD check to set it. This mostly copies those
to implement HOMEBREW_FORCE_BREWED_GIT & HOMEBREW_SYSTEM_GIT_TOO_OLD.

See also: https://github.com/Linuxbrew/brew/issues/736
2018-06-25 23:36:12 -07:00
Markus Reiter
de246cc528 Update Homebrew-Cask references. 2018-05-25 18:20:02 +02:00
Markus Reiter
c4222141ac Revert "Update Homebrew-Cask references."
This reverts commit 4475651b548afdcf15c4cf7a7cb57baca1885186.
2018-05-25 17:57:32 +02:00
Markus Reiter
4475651b54 Update Homebrew-Cask references. 2018-05-25 17:56:16 +02:00
Mike McQuaid
99b89e4866
Merge pull request #4022 from stefansundin/disable-curlrc
Tell curl to not use .curlrc
2018-04-08 16:37:49 -07:00
Mike McQuaid
0bd5869319 Add/use HOMEBREW_CURLRC variable. 2018-04-08 15:51:58 -07:00
Mike McQuaid
845b29467f Note environment variables need to have values.
Address the confusion in #4015.
2018-04-07 10:10:24 +01:00
Mike McQuaid
b23f66982f Improve external command documentation
Extract `brew bundle` and `brew services` docs from their help. Add a
little for `brew cask` until we can think about e.g. merging the
manpages.
2018-03-15 16:25:14 +00:00
Mike McQuaid
e817bba18d upgrade: add HOMEBREW_UPGRADE_CLEANUP variable.
Allow users to specify they want `brew upgrade --cleanup` to always be
run when they run `brew upgrade`.
2018-03-12 11:05:06 +00:00
Mike McQuaid
2205f62ec6 irb: add pry support.
Make `brew irb` optionally support `pry`. While doing so, also make it a `dev-cmd`.
2018-02-28 11:36:23 +00:00
Mike McQuaid
f2ce6489b2 Use more docs.brew.sh short links
These are nicer on the eyes.
2018-02-22 19:46:58 +00:00
joshua stein
7388acb86e Tty: if HOMEBREW_NO_COLOR env var is present, disable color
bin/brew will recognize NO_COLOR variable and copy it to
HOMEBREW_NO_COLOR
2018-02-12 14:19:25 -06:00
xiehuc
3e6adb7e33 update all_proxy and man pages #3751 2018-02-01 18:11:29 +08:00
Mike McQuaid
65695885b6 Update other Homebrew maintainers. 2018-01-18 15:45:51 +00:00
Ivars Berzinsh
28a0e445f0 Added info about no_proxy to docs 2017-12-19 10:59:04 +02:00
Mike McQuaid
4eeeb5eac4 brew.1: clarify Homebrew's Ruby isn't 2.0 now.
Make this generic; it doesn't matter what version this is and this will
future proof it.
2017-12-08 16:49:33 +00:00
Mike McQuaid
1d344cf2f5 Document HOMEBREW_FORCE_BREWED_CURL
Should have been in #3482.
2017-12-06 12:56:15 +00:00
Mike McQuaid
022303f96c Unify proxy documentation.
Specify under the list of environment variables how to set each of those
that we passthrough and use.
2017-11-30 14:05:06 +00:00
Mike McQuaid
baa61f5a6e Use https for all docs.brew.sh links.
May as well use the more secure link when possible.
2017-07-27 15:59:37 +01:00
Mike McQuaid
4fd8aea015 Documentation improvements
- Document ilovezfs as the official lead maintainer of
 Homebrew/homebrew-core. This is a role he's been doing unofficially
 (and brilliantly) for a while and explicit documentation of power
 structures makes it easier for non-Homebrew-maintainers to understand.
- Document the contents of some of Homebrew's subdirectories for people
  clicking around in the GitHub UI looking to contribute.
- Remove update bug mention from README. Enough time has passed that we
  can remove this disappointment.
2017-07-15 12:57:34 +01:00
Mike McQuaid
54e01d76db Merge pull request #2599 from peternewman/patch-1
Fix internal links on the manpage
2017-06-04 11:52:13 +01:00
Mike McQuaid
9e17e44b3e Change manpage internal links in correct location. 2017-06-04 11:12:56 +01:00
Mike McQuaid
8205e61e64 More environment filtering tweaks
- only document HOMEBREW_* variables in the manpage (although still
  read from all the original environment variables).
- resort manpage environment variables in alphabetical order
- check the original path for trailing slashes
2017-05-13 11:42:01 +01:00
EricFromCanada
aee23ccb03 Add more flags and descriptions to man pages. 2017-03-05 21:45:15 -05:00
EricFromCanada
afc539f86e Update brew's man page formatting and grammar
Also update command specifications to match descriptions.
2017-02-25 17:37:57 -05:00
Mike McQuaid
3ccbfa72a2 brew.1: use uninstall instead of remove.
Fixes #1817.
2017-01-11 14:19:56 -08:00