235 Commits

Author SHA1 Message Date
ilovezfs
fad235d8e8 tap: support --full even if installed
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-05 07:25:27 -07:00
Mike McQuaid
276a797d37 Update documentation after repository split. 2016-04-03 14:03:33 +01:00
Xu Cheng
e72ea94824 doc: update for core/formula separation
Closes Homebrew/homebrew#50632.

Signed-off-by: Xu Cheng <xucheng@me.com>
2016-04-02 21:51:36 +08:00
Carol (Nichols || Goulding)
eda70673ea Fix backticks to prevent missing rendered text
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-26 14:50:10 +08:00
Chris Bracco
7f77adffd3 share/doc/homebrew/README: fix supporters link.
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-26 14:50:10 +08:00
Xu Cheng
b8a4677de0 --repository: support to show tap path
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-24 14:52:13 +08:00
Dominyk Tiller
773451f027 keg_only external builds documentation: cleanup 2016-03-24 14:52:13 +08:00
Dominyk Tiller
760c596a8e Checksum_Deprecation: add guiding document
Closes Homebrew/homebrew#50282.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-03-23 13:41:16 +08:00
Baptiste Fontaine
f30221c7e1 Tips & Tricks: remove obsolete ref to SHA1 2016-03-20 13:48:18 +08:00
Alex Dunn
4516375db4 Formula Cookbook: /environmental/environment/
Closes Homebrew/homebrew#50146.

Signed-off-by: Alex Dunn <adunn@ucsb.edu>
2016-03-19 19:14:50 +08:00
Alex Dunn
90246be60a Formula Cookbook: note $HOME override
See https://github.com/Homebrew/homebrew/pull/50130#discussion_r56254860
2016-03-19 19:14:50 +08:00
Damien Pollet
57a81f9e22 Clarify case conventions in formula naming
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-03-01 22:12:29 -08:00
George Hartzell
76767f3d6e Formula-Cookbook: Improve testing suggestions
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-29 16:30:23 +00:00
Mike McQuaid
8156e76576 Move Kickstarter supporters file. 2016-02-18 08:21:20 +00:00
Dominyk Tiller
3b0e89c43d FAQ: minor tweaks
Closes Homebrew/homebrew#49281.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2016-02-18 08:19:17 +00:00
Dominyk Tiller
6e33ace71b Formula-Cookbook: update CONTRIBUTING path 2016-02-18 08:19:17 +00:00
Dominyk Tiller
e9a9c8a73b doc/homebrew/FAQ: update CONTRIBUTING path 2016-02-18 08:19:17 +00:00
Dominyk Tiller
be79583b4e doc/homebrew/README: update CONTRIBUTING path 2016-02-18 08:19:17 +00:00
Dominyk Tiller
4a289a65d4 Troubleshooting: remove dead link 2016-02-18 05:07:25 +00:00
Dominyk Tiller
9b2765c04f El_Capitan_and_Homebrew: remove document
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-17 18:55:41 +00:00
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