aboutsummaryrefslogtreecommitdiffstats
path: root/share/doc
AgeCommit message (Collapse)Author
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
2015-11-29xcode.md: document xcode 7.1.1Dominyk Tiller
Closes Homebrew/homebrew#46459. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-11-27External-Commands: remove brew-any-tap, brew-desc.Zhiming Wang
The functionality of both external commands have been merged into core (#40326 and Homebrew/homebrew#39911). Closes Homebrew/homebrew#46412. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-11-26Formula-Cookbook: don't remove bottle revisionsDominyk Tiller
2015-11-26Formula-Cookbook: note when to remove revisionsgunnaraasen
Closes Homebrew/homebrew#46286. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-11-26Fix typo: hyphen-minus instead of en dash in commandZhiming Wang
Closes Homebrew/homebrew#46408. Signed-off-by: Alex Dunn <dunn.alex@gmail.com>
2015-11-23Don't mention easy_installJulian Berman
That which shall not be named! Remove outdated references to easy_install and point users at the pip installation docs. Closes Homebrew/homebrew#44834. Signed-off-by: Tim D. Smith <git@tim-smith.us>
2015-11-23Docs: deprecate homebrew/head-onlyBaptiste Fontaine
Closes Homebrew/homebrew#46243. Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-11-06Tips-N'-Trick: add a tip to use switch.Joel B Schwartz
I find brew switch very helpful to activate a different version of an installed formula. This seems worth calling out in the documentation to elevate awareness. Closes Homebrew/homebrew#45694. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-11-01El Capitan and Homebrew: update instructions.Mike McQuaid
These seem to not apply for everyone on 10.11 any more (as explained in Homebrew/homebrew#45387). Closes Homebrew/homebrew#45387. Closes Homebrew/homebrew#45566. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-31doc: be consistent when referring to official tapsMartin Afanasjew
Always use the `<user/repo>` format as used by the `brew tap` command. Also fixed a link to `homebrew/head-only` and sorted a list in `FAQ.md` in alphabetical order. Closes Homebrew/homebrew#45535. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-31Formula cookbook: PolarSSL was renamed to mbedtlsJacob Krall
See 29bc61e9163e43931ff4736fa3cefaff1918f153 Closes Homebrew/homebrew#45533. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-10-27The Formula API is no longer work-in-progress.Mike McQuaid
Feature it a bit more prominently in the documentation as a result. Closes Homebrew/homebrew#45374. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-26cookbook: mention --set-name for 'brew create'Baptiste Fontaine
Closes Homebrew/homebrew#45335. Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-10-26doc/Interesting-Taps-&-Branches: update emacs tapAlex Dunn
Closes Homebrew/homebrew#45315.
2015-10-26doc/Interesting-Taps-&-Branches: tighter listsAlex Dunn
2015-10-24xcode: expect xcode 7.1Martin Afanasjew
Closes Homebrew/homebrew#45266. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-10-23El_Capitan_and_Homebrew: a few updates.Mike McQuaid
Firm up some of the wording and remove stuff given that 10.10.1 didn't reset permissions back. Closes Homebrew/homebrew#45267. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-20Update manpage.Mike McQuaid
2015-10-18doc: add links to jenkins jobsSteven Peters
Add links to specific jenkins jobs described in Brew-Test-Bot-For-Core-Contributors.md Closes Homebrew/homebrew#45052. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-16New-Maintainer-Checklist: general updates.Mike McQuaid
2015-10-15Formula-Cookbook: point to audit --strict.Raimonds Kalnins
Closes Homebrew/homebrew#44940. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-07Encourage https for bottle hostingSteven Peters
I assume that we want to encourage people hosting their own bottles to serve them using `https`. This PR has a trivial change in the example. We may consider adding some text to the `root_url` description with a discussion of security. Also use https://example.com instead of http://mikemcquaid.com in bottle example. Closes Homebrew/homebrew#44651. Signed-off-by: Xu Cheng <xucheng@me.com>
2015-10-07Remove extra wordAdrian Moisey
Closes Homebrew/homebrew#44708. Signed-off-by: Xu Cheng <xucheng@me.com>
2015-10-07brew upgrade: provides an option `--cleanup`Rakesh
Closes Homebrew/homebrew#44305. Signed-off-by: Xu Cheng <xucheng@me.com>
2015-10-03Remove redundant chown commands.Todd A. Jacobs
`chown -R` should be sufficient. There is no obvious reason to chown the top-level directory as a separate command. Closes Homebrew/homebrew#44554. Signed-off-by: Tim D. Smith <git@tim-smith.us>
2015-10-02Remove MacVTKITKPythonBottles from docMichka Popoff
Bottles for VTK and ITK python are no more provided. ITK can be wrapped with Python since version 4.8, so this tap is no more needed. Using the vanilla homebrew VTK and ITK formulas is the way to go. Closes Homebrew/homebrew#44467. Signed-off-by: Alex Dunn <dunn.alex@gmail.com>
2015-10-01El_Capitan_and_Homebrew: update dead linkDominyk Tiller
2015-10-01xcode: document xcode 7Dominyk Tiller
2015-09-28Python-for-Formula-Authors: use sha256 for exampleDominyk Tiller
2015-09-21add link to RISC-V toolchainScott Beamer
Closes Homebrew/homebrew#44196. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-09-20Troubleshooting: add El Cap doc linkDominyk Tiller
2015-09-20El_Capitan_and_Homebrew: add permissions docDominyk Tiller
2015-09-06update rename documentationVlad Shablinsky
Update commit format for formula renames Closes Homebrew/homebrew#43644. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-09-06manpage: add unlink --dry-runXu Cheng
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-01 15:58:22 +0000