aboutsummaryrefslogtreecommitdiffstats
path: root/share/doc
AgeCommit message (Collapse)Author
2016-04-18brew test, install, update-test: add --keep-tmp optionAndrew Janke
Also enables sandbox for --interactive and --debug use of install and test, using automatic retention. Closes #66. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-16update manpage for deps/usesXu Cheng
2016-04-16doc: remove outdated documentation for completion (#99)Chayoung You
By the commit edf000e4cd30c3626ccc28c52ed32f2d84a200dd, bash and zsh completion scripts have been moved to `etc/bash_completion.d/brew` and `share/zsh/site-functions/_brew`, respectively. Now completion will be done automatically without any trick.
2016-04-16analytics: add more documentation, Linuxbrew ID. (#98)Mike McQuaid
2016-04-12Document disabling of opt-in Homebrew analytics. (#79)Mike McQuaid
2016-04-12Homebrew (opt-in) Analytics tweaks. (#57)Mike McQuaid
- add `HOMEBREW_PRODUCT` global variable - only differentiate between `/usr/local` and `non-/usr/local` Homebrew prefixes to avoid sharing sensitive user information - note if e.g. build errors are occurring under CI - Add `HOMEBREW_NO_ANALYTICS` variable (this will be how people opt-out when this is enabled for everyone) - Add `HOMEBREW_ANALYTICS_DEBUG` variable to output all the analytics that are sent - Move Bash analytics code to `Library/Homebrew/utils/analytics.sh` - Add documentation for our analytics and why/what/when/how and opt-out - Only official Homebrew commands are reported - Ruby analytics are now reported in a forked, background process
2016-04-11doco: more updates for core/formula separationAndrew Janke
Closes #71. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-10Fix documentation errorMax Nordlund
Closes #10. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-04-10Generate the new man pageMax Nordlund
2016-04-10xcode: expect 7.3 on 10.11Dominyk Tiller
xcode: expect 7.3 on 10.11
2016-04-09Remove advice on bad Python linkingTim D. Smith
This is pathological and something that should be fixed in core, not by working around it. Closes https://github.com/Homebrew/legacy-homebrew/pull/45704.
2016-04-06prune: handle broken app symlinksMartin Afanasjew
Remove broken symlinks from `/Applications` and `~/Applications` that were previously created by `brew linkapps`, but are no longer valid because formulae were uninstalled or the provided apps have changed.
2016-04-06unlinkapps: add --dry-run optionMartin Afanasjew
Add `--dry-run` option as is customary for destructive commands. Update `bash` completion and man page accordingly. Also correct and update documentation for both `brew linkapps` and `brew unlinkapps` in more general terms.
2016-04-05tap: support --full even if installedilovezfs
Makes `tap` re-runnable and unshallows when requested with `--full`. Tapping with a different URL raises an exception. The homebrew/core tap cannot be untapped with `untap` so running `brew tap --full homebrew/core` is now a built-in way to get a full clone of this tap without resorting to workarounds. Closes #17. Signed-off-by: ilovezfs <ilovezfs@icloud.com>
2016-04-03Update documentation after repository split.Mike McQuaid
2016-04-02doc: update for core/formula separationXu Cheng
Closes Homebrew/homebrew#50632. Signed-off-by: Xu Cheng <xucheng@me.com>
2016-03-26Fix backticks to prevent missing rendered textCarol (Nichols || Goulding)
The backticks being where they were, or not, caused text like `<formula>` to not be shown when viewing the rendered text in a browser. Closes Homebrew/homebrew#50428. Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2016-03-26share/doc/homebrew/README: fix supporters link.Chris Bracco
The link to the Kickstarter Supporters file was broken. This new link points to the ./Kickstarter-Supporters.md file. Closes Homebrew/homebrew#50335. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-03-24--repository: support to show tap pathXu Cheng
This can become handy when we separate core code and formulae. For example, we could use `cd $(brew --repo homebrew/core)` to go to core tap path. Closes Homebrew/homebrew#50346. Signed-off-by: Xu Cheng <xucheng@me.com>
2016-03-24keg_only external builds documentation: cleanupDominyk Tiller
2016-03-23Checksum_Deprecation: add guiding documentDominyk Tiller
Closes Homebrew/homebrew#50282. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-03-20Tips & Tricks: remove obsolete ref to SHA1Baptiste Fontaine
2016-03-19Formula Cookbook: /environmental/environment/Alex Dunn
Closes Homebrew/homebrew#50146. Signed-off-by: Alex Dunn <adunn@ucsb.edu>
2016-03-19Formula Cookbook: note $HOME overrideAlex Dunn
See https://github.com/Homebrew/homebrew/pull/50130#discussion_r56254860
2016-03-01Clarify case conventions in formula namingDamien Pollet
If a formula's class name contains an uppercase-spelled acronym, the messages given by `brew install` can be pretty confusing (it recommends a formula named exactly the same…) Closes Homebrew/homebrew#49639. Signed-off-by: Tim D. Smith <git@tim-smith.us>
2016-02-29Formula-Cookbook: Improve testing suggestionsGeorge Hartzell
Based on recent feedback on some pull requests, I touched up the section about adding tests to formula. I wanted to make it clearer that the examples demonstrate how to create files on the fly and add a pointer to the tinyxml2 formula (DomT4 pointed it out to me as a good example). Closes Homebrew/homebrew#49641. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-02-18Move Kickstarter supporters file.Mike McQuaid
2016-02-18FAQ: minor tweaksDominyk Tiller
Closes Homebrew/homebrew#49281. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-02-18Formula-Cookbook: update CONTRIBUTING pathDominyk Tiller
2016-02-18doc/homebrew/FAQ: update CONTRIBUTING pathDominyk Tiller
2016-02-18doc/homebrew/README: update CONTRIBUTING pathDominyk Tiller
2016-02-18Troubleshooting: remove dead linkDominyk Tiller
2016-02-17El_Capitan_and_Homebrew: remove documentDominyk Tiller
We haven't seen this for a fair while since Apple pushed further updates to the SIP mechanism and believe it to be far less of an issue than it was previously. If you encounter further failure, please file an Issue and we'll be happy to help! At the moment though this advice is making people think there _will_ be an issue at some point, which isn't generally proving the case.
2016-02-07doc/xcode: update for 7.2.1Dominyk Tiller
Closes Homebrew/homebrew#48955. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-02-07Tips-N'-Tricks: fix symlink for zsh completionKazem Keshavarz
From `Library/Contributions/brew_zsh_completion.zsh`: ````bash ```` Then it should give symlinked file name of `_brew` instead of being just `brew_zsh_completion.zsh` Closes Homebrew/homebrew#48897. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-02-03FAQ: fix `brew pull` GitHub link.Joshua Jabbour
Closes Homebrew/homebrew#48794. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-02-03doc: fix typos in Formula CookbookPrayag Verma
`preprended` > `prepended` Replace `a` with `an` `throughly` > `thoroughly` Remove extra `consider` Closes Homebrew/homebrew#48697. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-01-22doc: Fix some typos at Formula CookbookMarcelo Boeira
Closes Homebrew/homebrew#48342. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-01-22Add directions for subscribing to mailing listPhilip May
Closes Homebrew/homebrew#48369. Signed-off-by: Tim D. Smith <git@tim-smith.us>
2016-01-21Announce new mailing list addressTim D. Smith
Closes Homebrew/homebrew#48304.
2016-01-20doc: move images into their own directoryMartin Afanasjew
By doing this, make the GitHub directory listing for the documentation directory more useful and less cluttered. Closes Homebrew/homebrew#48219. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2016-01-20doc: remove unused imagesMartin Afanasjew
These files were imported from the wiki, but they are not referenced by any of the other documentation files.
2016-01-18Update manpage to remove cleanup --forceMisty De Meo
2016-01-14Cookbook: remove ref to obsolete 'def patches'Baptiste Fontaine
2016-01-11Cookbook: Replace 'onoe' with 'odie'Glenn / devalias
Closes Homebrew/homebrew#47948. Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2016-01-06Common-Issues: add section for upgrading OS X.Patrick Way
Closes Homebrew/homebrew#47008. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-01-06manpage: document '--dry-run' for 'prune' commandMartin Afanasjew
2016-01-06manpage: add parentheses in 'search' synopsisMartin Afanasjew
For consistency with other commands where there is a list of mutually exclusive options of which exactly one has to be specified.
2016-01-06manpage: fix minor formatting inconsistenciesMartin Afanasjew
2016-01-06manpage: improve synopsis for 'options' commandMartin Afanasjew
The options `--all`, `--installed`, and a list of formulae are mutually exclusive arguments, of which exactly one is required.