aboutsummaryrefslogtreecommitdiffstats
path: root/share/doc
AgeCommit message (Collapse)Author
2016-08-12update: add --force argument.Mike McQuaid
Add a `brew update --force` to side-step all of the clever optimisations we have to detect if an update is unnecessary. That means if those optimisations go wrong in future we can tell people just to run this single command. This would have been a useful workaround for the issue fixed in 985c672.
2016-08-11Update --fetch-HEAD documentationVlad Shablinsky
2016-08-10Enable vendored Ruby 2.0.Mike McQuaid
2016-08-10Ship Homebrew auto-update support.Mike McQuaid
Roll this out to everyone (not just developers) and document the environment variables used for configuration.
2016-08-10Bottles.md: update documentation.Mike McQuaid
Fixes #672. Fixes #673.
2016-08-08FAQ: fix-up cache pathDominyk Tiller
2016-08-06Update upgrade/outdated documentation (#650)Uladzislau Shablinski
2016-08-02audit: add --new-formula option.Mike McQuaid
Rather than nudge people to run `--strict` and then ignore some of the results sometimes (e.g. GitHub repository notability) instead add a dedicated `--new-formula` option that implies this is a one-time advisory check.
2016-07-26Document virtualenv support for Python appsTim D. Smith
Closes #344. Signed-off-by: Tim D. Smith <git@tim-smith.us>
2016-07-24Fix spelling of penryn (#580)Nathan Henrie
penryn was misspelled, which led to me doing a fruitless code search for where the architecture stuff is set.
2016-07-15Deprecate homebrew/binary. (#512)Mike McQuaid
We're moving more stuff to Homebrew Cask which is better maintained and run.
2016-07-13Add HOMEBREW_ARTIFACT_DOMAIN option.jainish shah
If set, this environment variable instructs Homebrew to use the given URL as a download mirror (e.g. an Artifactory instance) for bottles and binaries. Closes #387. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-07-10tap-info: expand and correct help textMartin Afanasjew
2016-07-04Regenerate man page to pick up recent changesMartin Afanasjew
Amend 468ebc5ed540c77dea4772a35678b5b2575ac4ed by regenerating the man page and its HTML version according to the changes in #443.
2016-06-24create: add --tap option (#389)Zhiming Wang
This commit adds a --tap option to the create command such that a user could create a formula in a specified tap instead of the core.
2016-06-22audit.rb: require https for ftpmirror.gnu.org (#393)Viktor Szakats
* audit.rb: require https for ftpmirror.gnu.org The situation is similar to other mirror redirectors: the server may subsequently redirect to an insecure url. But it's a step. * manpage: update HOMEBREW_NO_INSECURE_REDIRECT section
2016-06-14manpage: update maintainers listXu Cheng
Closes #362. Signed-off-by: Xu Cheng <xucheng@me.com>
2016-06-04doc/External-Commands: update default HOMEBREW_CACHE (#316)Luca Favatella
2016-06-03How-To-Open-a-Homebrew-Pull-Request: do not install bottle for test (#315)Alexey Palazhchenko
2016-06-01Move HOMEBREW_CACHE to ~/Library/Caches (#292)Mike McQuaid
* cleanup: accept cache as an argument. * config: move default HOMEBREW_CACHE to ~/Library. * brew.1: document new default Homebrew cache. * update-report: migrate legacy Homebrew cache.
2016-05-30Bottle: remove local installation instructions.Mike McQuaid
These aren't targeted at end users.
2016-05-30man: changes for 75ab94cDominyk Tiller
2016-05-26search: add alias -S back to zero-argument helpMartin Afanasjew
Amends 132ada2b0ebb3751c0f8f42ca83bb257b55a50fd until we properly figure out a way of documenting built-in aliases (or not doing that) across all commands that currently have aliases. See #270 for full discussion.
2016-05-26Clarify brew search usage. (#270)Joe Gallo
* Include --desc in brew search help text. * Update brew search --desc text in README. * Remove mention of alias in brew search help text to avoid any confusion.
2016-05-19install: fix documentation of --keep-tmp option (#258)Zhiming Wang
Obvious copy/paste failure in acc9a7ca8554bc2413dee2d6d0f407b3a59c628c.
2016-05-11brew audit: add --display-filename format option for easy grepping (#221)Andrew Janke
2016-05-09fetch: document --retry option (#225)Martin Afanasjew
2016-05-09gist-logs: add proper documentation, improve error handling (#217)Jam
2016-05-09Update man page to pick up changes made in #205.Martin Afanasjew
Seems like last-minute changes were made without re-running `brew man`.
2016-05-06brew install: make -s apply only to given formula, not deps (#205)Andrew Janke
2016-05-05xcode: expect 7.3.1 on 10.11Martin Afanasjew
2016-05-04Analytics: remove cask.Mike McQuaid
2016-05-03deps: split and clarify documentationMartin Afanasjew
`brew deps` has three different modes of operation that were not easy to infer from the existing documentation. Split the help text into three parts to make this clearer. This also improves on the confusion when options were silently ignored because they don't apply to a certain mode of operation. Those are: 1. List the shared dependencies (either intersection or union) of explicitly named formulae with options for traversal depth/order. 2. Output separate trees of explicitly listed or all installed formulae. 3. List all available/installed formulae and their direct dependencies with one line per formula formatted as `<formula>: <dependencies>`. Closes #137. Closes #179. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-05-03Add "Maintainers: Avoiding Burnout" document.Mike McQuaid
2016-05-02Update Homebrew/homebrew references in man pageMartin Afanasjew
Replace `homebrew` with `brew`, `homebrew-core`, or `legacy-homebrew` depending on context. Closes #175. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-05-01add `brew analytics` command (#173)Xu Cheng
2016-04-30analytics: relocate UUID to homebrew.analyticsuuid in .git/configZhiming Wang
This way analytics related settings and parameters (currently analyticsdisabled, analyticsmessage and analyticsuuid) are all kept in the same place. Note that in this commit we offer a path of migration: if ~/.homebrew_analytics_user_uuid already exists, read the UUID from it, write to homebrew.analyticsuuid, and remove it. See more detailed discussions in #145. Closes #162. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-27Clarify opt-out commandsEitot
* Clarify opt-out commands * Partially rewrite opt-out paragraph
2016-04-27Language::Node.npm_install_args: add helper method (#37)Christian Moritz
* add Language::Node helper module This adds a language module for Node module based formulas. It contains the 2 public methods `std_npm_install_args(libexec)` and `local_npm_install_args`: * `std_npm_install_args` is intended to be used in formulas for standard node modules and returns `npm install` args for a global style module installation to libexec. * `local_npm_install_args` is for formulas, in which the `npm install` step is only one of multiple parts of the installation process and returns `npm install` args for a default local installation in place. Both methods have in common, that they are * making sure that a working copy of npm and node-gyp from node's libexec is prepended to the PATH (to not rely of a user managed npm) * seting the npm cache to HOMEBREW_CACHE/npm, which fixes issues caused by overriding $HOME resulting in long install times + high disk usage (see https://github.com/Homebrew/brew/pull/37#issuecomment-208840366) * audit: update npm install check for Language::Node * cleanup: remove npm_cache too * doc: add Node-for-Formula-Authors.md
2016-04-25doco: add Prose Guidelines (WIP)Andrew Janke
Closes #128. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-25doco: analytics: fix typoZev Eisenberg
Closes #150. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-25Fix a minor typoMilkey Mouse
Closes #149. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-25More analytics tweaks.Mike McQuaid
Provide a single command that can be run to disable analytics, run it if `HOMEBREW_NO_ANALYTICS` is ever set and remove the user UUID file in that case too. References https://github.com/Homebrew/brew/issues/142.
2016-04-25Point to analytics documentation on brew update.Mike McQuaid
Make sure that users are notified on the first run of `brew update` after we enabled analytics about how it works and how to opt-out. This will be shown to all users who have not already seen this message from `brew update` or through a new Homebrew installation. References https://github.com/Homebrew/install/pull/42 References https://github.com/Homebrew/brew/issues/142
2016-04-23Ship analytics for Homebrew.Mike McQuaid
For more information and opt-out instructions please read: https://github.com/Homebrew/brew/blob/master/share/doc/homebrew/Analytics.md#analytics
2016-04-22update: rebase (rather than merge) by default.Mike McQuaid
We want to always avoid merge commits being committed to Homebrew so this feels like a better fit.
2016-04-22Formula-Cookbook: better `inreplace` example.Mike McQuaid
Make multiple replacements if using the block form.
2016-04-21doco: "How to PR": do audit while revised formula is installedAndrew Janke
Reorders the PR submission steps so `brew audit` is done after `brew install`, so it can pick up issues with the installed formula, like non-executable stuff in `bin/`. Matches the `test-bot` process better. Minor style changes, including consistently using periods at the end of list items which are complete imperative sentences. Closes #127. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-21brew-audit: pull style checks in to main audit outputAndrew Janke
This collects all violations for each formula in a single place, instead of doing `brew style` outputs for all formulae first, and then the other audit checks. Closes #112. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-20--version: move help to documentation commentMartin Afanasjew
This implies that `--version` is treated in most places like a regular command, e.g. being suggested in shell completion. Also fix the help text that claimed output goes to standard error, while it actually goes to standard output.