aboutsummaryrefslogtreecommitdiffstats
path: root/share
AgeCommit message (Collapse)Author
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.
2016-01-02Cookbook: clearer wordingBaptiste Fontaine
2015-12-30FAQ: fix -- to — conversion.Zhuoyun Wei
Closes Homebrew/homebrew#47523. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-12-26Formula-Cookbook: recommend gdm for go resourcesCameron Sparr
Closes Homebrew/homebrew#46889. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-12-13cleanup: consistently document --dry-run optionMartin Afanasjew
All other commands document both `--dry-run` and `-n` in the option description and mention only `--dry-run` in the command summary. Let's do the same for `cleanup`. Closes Homebrew/homebrew#46942. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2015-12-10xcode.md: document xcode 7.2Dominyk Tiller
Closes Homebrew/homebrew#46822. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-12-10Troubleshooting: fixed typoAnton Danilchenko
Closes Homebrew/homebrew#46867. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-12-10manpage: remove superfluous spaces for consistencyMartin Afanasjew
All other alternatives already don't use spaces around the pipe symbol. Closes Homebrew/homebrew#46825. Signed-off-by: Martin Afanasjew <martin@afanasjew.de>
2015-12-10manpage: fix formatting of command listMartin Afanasjew
Restore definition list in `COMMANDS` section, thus massively improve formatting. In theory, `ronn` supports nested (definition) lists. In practice, this does not work (and is unlikely to be fixed soon because upstream seems to be rather inactive) causing the entire definition list to be longer recognized because of a single nested list. Work around by rearranging the `tap` documentation (sole command with a nested list).
2015-12-10Do not `brew install brew-cask`Josh Hagins
Refs caskroom/homebrew-cask#15381 Closes Homebrew/homebrew#46845.
2015-12-09Remove Git Conflict Markers in DocumentationRobert Eshleman
`Formula-Cookbook.md` contains leftover git conflict markers introduced in 15f291ddaa05cc010456a733b799382175c29dd4. This commit removes the conflict makers and a duplicated paragraph. Closes Homebrew/homebrew#46836. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-12-08manpages: minor markup fixesAndrew Janke
Fixes a couple issues left behind by Homebrew/homebrew#46676. Closes Homebrew/homebrew#46706. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-07Overhaul, simplify and cleanup documentation.Mike McQuaid
Remove duplication, link to the API documentation more often, tweak wording, add `@UniqMartin` as a maintainer, note `@jacknagel`'s and `@adamv`'s significant past contributions to Homebrew, delete some outdated or unneeded documentation, add some missing `Formula` API. entries and simplify/improve `CONTRIBUTING.md`. Closes Homebrew/homebrew#46179. Closes Homebrew/homebrew#46618. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-12-05manpages: fix missing backtickAndrew Janke
2015-12-05man page: finer-grained markupAndrew Janke
Closes Homebrew/homebrew#44769 Closes Homebrew/homebrew#46676. Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-04Formula-Cookbook: wording clarityDominyk Tiller
2015-12-02manpage: synchronize maintainer list with READMEMartin Afanasjew