165 Commits

Author SHA1 Message Date
Dominyk Tiller
326cc5c438 doc/xcode: update for 7.2.1
Closes Homebrew/homebrew#48955.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-02-07 21:26:57 +00:00
Kazem Keshavarz
e945461212 Tips-N'-Tricks: fix symlink for zsh completion
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-07 04:01:47 +00:00
Joshua Jabbour
0d094ac8ef FAQ: fix brew pull GitHub link.
Closes Homebrew/homebrew#48794.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-02-03 21:10:34 +00:00
Prayag Verma
87ee0ab3af doc: fix typos in Formula Cookbook
`preprended` > `prepended`
Replace `a` with `an`
`throughly` > `thoroughly`
Remove extra `consider`

Closes Homebrew/homebrew#48697.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-02-03 16:53:11 +00:00
Marcelo Boeira
3d9bc57fea doc: Fix some typos at Formula Cookbook
Closes Homebrew/homebrew#48342.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-01-22 18:05:11 +00:00
Philip May
ead10917d6 Add directions for subscribing to mailing list
Closes Homebrew/homebrew#48369.

Signed-off-by: Tim D. Smith <git@tim-smith.us>
2016-01-22 08:05:55 -08:00
Tim D. Smith
fc704a9b44 Announce new mailing list address
Closes Homebrew/homebrew#48304.
2016-01-21 09:37:51 -08:00
Martin Afanasjew
4ffe25adc8 doc: move images into their own directory
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-20 09:44:33 +01:00
Martin Afanasjew
ca676d4d6f doc: remove unused images
These files were imported from the wiki, but they are not referenced by
any of the other documentation files.
2016-01-20 09:44:33 +01:00
Misty De Meo
d1440e504e Update manpage to remove cleanup --force 2016-01-18 10:14:56 -08:00
Baptiste Fontaine
159373707b Cookbook: remove ref to obsolete 'def patches' 2016-01-14 00:54:15 +01:00
Glenn / devalias
f239a448b2 Cookbook: Replace 'onoe' with 'odie'
Closes Homebrew/homebrew#47948.

Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2016-01-11 11:32:05 +01:00
Patrick Way
d6c6f00393 Common-Issues: add section for upgrading OS X.
Closes Homebrew/homebrew#47008.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-01-06 10:05:42 +00:00
Martin Afanasjew
53e1ba3274 manpage: document '--dry-run' for 'prune' command 2016-01-06 08:18:59 +01:00
Martin Afanasjew
8161595015 manpage: add parentheses in 'search' synopsis
For consistency with other commands where there is a list of mutually
exclusive options of which exactly one has to be specified.
2016-01-06 08:18:04 +01:00
Martin Afanasjew
b3627cc5b2 manpage: fix minor formatting inconsistencies 2016-01-06 08:17:29 +01:00
Martin Afanasjew
aaefcb02b6 manpage: improve synopsis for 'options' command
The options `--all`, `--installed`, and a list of formulae are mutually
exclusive arguments, of which exactly one is required.
2016-01-06 08:17:17 +01:00
Baptiste Fontaine
f29699f77c Cookbook: clearer wording 2016-01-02 23:27:56 +01:00
Zhuoyun Wei
bb38d90bce FAQ: fix -- to — conversion.
Closes Homebrew/homebrew#47523.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-12-30 08:16:17 +00:00
Cameron Sparr
30455d0fb5 Formula-Cookbook: recommend gdm for go resources
Closes Homebrew/homebrew#46889.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-12-26 20:18:44 +00:00
Martin Afanasjew
18bf5a74a8 cleanup: consistently document --dry-run option
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-13 02:20:02 +01:00
Dominyk Tiller
5b98a6c67d xcode.md: document xcode 7.2
Closes Homebrew/homebrew#46822.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-12-10 14:27:02 +00:00
Anton Danilchenko
7c78f76d16 Troubleshooting: fixed typo
Closes Homebrew/homebrew#46867.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-12-10 14:18:34 +00:00
Martin Afanasjew
85181a067f manpage: remove superfluous spaces for consistency
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-10 15:00:36 +01:00
Martin Afanasjew
8144f90eac manpage: fix formatting of command list
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-10 15:00:36 +01:00
Josh Hagins
d5de719c2b Do not brew install brew-cask
Refs caskroom/homebrew-cask#15381

Closes Homebrew/homebrew#46845.
2015-12-10 09:32:53 +00:00
Robert Eshleman
6d1959b265 Remove Git Conflict Markers in Documentation
`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-09 15:31:02 +00:00
Andrew Janke
92a1fca6e4 manpages: minor markup fixes
Fixes a couple issues left behind by Homebrew/homebrew#46676.

Closes Homebrew/homebrew#46706.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-08 12:35:20 -05:00
Mike McQuaid
b745546943 Overhaul, simplify and cleanup documentation.
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-07 13:37:49 +00:00
Andrew Janke
98fbcb7299 manpages: fix missing backtick 2015-12-05 10:23:16 -05:00
Andrew Janke
5230ed2117 man page: finer-grained markup
Closes Homebrew/homebrew#44769

Closes Homebrew/homebrew#46676.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2015-12-05 00:41:32 -05:00
Dominyk Tiller
92585165f3 Formula-Cookbook: wording clarity 2015-12-04 05:37:19 +00:00
Martin Afanasjew
18a743c470 manpage: synchronize maintainer list with README 2015-12-02 00:56:36 +01:00
Dominyk Tiller
b31f84f270 xcode.md: document xcode 7.1.1
Closes Homebrew/homebrew#46459.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-11-29 02:11:32 +00:00
Zhiming Wang
30d8084643 External-Commands: remove brew-any-tap, brew-desc.
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-27 08:17:42 +00:00
Dominyk Tiller
1e96ec1bde Formula-Cookbook: don't remove bottle revisions 2015-11-26 23:51:11 +00:00
gunnaraasen
293bd76658 Formula-Cookbook: note when to remove revisions
Closes Homebrew/homebrew#46286.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-11-26 23:46:22 +00:00
Zhiming Wang
5fc2405db3 Fix typo: hyphen-minus instead of en dash in command
Closes Homebrew/homebrew#46408.

Signed-off-by: Alex Dunn <dunn.alex@gmail.com>
2015-11-26 15:22:19 -08:00
Julian Berman
ef8f6e7aa8 Don't mention easy_install
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-23 22:56:18 -08:00
Baptiste Fontaine
2838fe493e Docs: deprecate homebrew/head-only
Closes Homebrew/homebrew#46243.

Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-11-23 22:05:16 +01:00
Joel B Schwartz
e4b4ad532f Tips-N'-Trick: add a tip to use switch.
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-06 16:23:47 -08:00
Mike McQuaid
2537942540 El Capitan and Homebrew: update instructions.
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-11-01 22:30:26 -08:00
Martin Afanasjew
4a9960bee7 doc: be consistent when referring to official taps
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-31 20:32:09 -07:00
Jacob Krall
6d57b3f4b9 Formula cookbook: PolarSSL was renamed to mbedtls
See 29bc61e9163e43931ff4736fa3cefaff1918f153

Closes Homebrew/homebrew#45533.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-10-31 15:45:21 +00:00
Mike McQuaid
74e407dc54 The Formula API is no longer work-in-progress.
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-27 10:45:23 -06:00
Baptiste Fontaine
eb576b3e0b cookbook: mention --set-name for 'brew create'
Closes Homebrew/homebrew#45335.

Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-10-26 21:21:15 +01:00
Alex Dunn
db66177d6c doc/Interesting-Taps-&-Branches: update emacs tap
Closes Homebrew/homebrew#45315.
2015-10-26 06:50:53 -07:00
Alex Dunn
417453401f doc/Interesting-Taps-&-Branches: tighter lists 2015-10-26 06:50:53 -07:00
Martin Afanasjew
f6cf1a4025 xcode: expect xcode 7.1
Closes Homebrew/homebrew#45266.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-10-24 17:19:05 +01:00
Mike McQuaid
b459ba7a83 El_Capitan_and_Homebrew: a few updates.
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-23 15:13:10 +01:00