147 Commits

Author SHA1 Message Date
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
Mike McQuaid
4cfdef65ed Update manpage. 2015-10-20 08:52:46 +01:00
Steven Peters
0915f0c668 doc: add links to jenkins jobs
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-18 14:12:03 +01:00
Mike McQuaid
a9b3c9200e New-Maintainer-Checklist: general updates. 2015-10-16 09:27:30 +01:00
Raimonds Kalnins
f47f5088fb Formula-Cookbook: point to audit --strict.
Closes Homebrew/homebrew#44940.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-10-15 08:55:46 +01:00
Steven Peters
d3d1b6f0fe Encourage https for bottle hosting
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-07 19:42:02 +08:00
Adrian Moisey
8318500294 Remove extra word
Closes Homebrew/homebrew#44708.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-10-07 19:33:37 +08:00
Rakesh
2d60187e1a brew upgrade: provides an option --cleanup
Closes Homebrew/homebrew#44305.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-10-07 14:05:11 +08:00
Todd A. Jacobs
5f29dee138 Remove redundant chown commands.
`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-03 11:14:48 -07:00
Michka Popoff
8f072724de Remove MacVTKITKPythonBottles from doc
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-02 21:52:55 -07:00
Dominyk Tiller
ab19bc641c El_Capitan_and_Homebrew: update dead link 2015-10-01 20:58:30 +01:00
Dominyk Tiller
f5fd1c3c57 xcode: document xcode 7 2015-10-01 05:56:09 +01:00
Dominyk Tiller
04959403ac Python-for-Formula-Authors: use sha256 for example 2015-09-28 19:14:51 +01:00
Scott Beamer
15875ade93 add link to RISC-V toolchain
Closes Homebrew/homebrew#44196.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-09-21 15:19:40 +01:00
Dominyk Tiller
6e5bef5ee1 Troubleshooting: add El Cap doc link 2015-09-20 18:20:59 +01:00
Dominyk Tiller
bf5482216b El_Capitan_and_Homebrew: add permissions doc 2015-09-20 18:16:35 +01:00
Vlad Shablinsky
a3505b29c6 update rename documentation
Update commit format for formula renames

Closes Homebrew/homebrew#43644.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-09-06 13:57:25 +01:00
Xu Cheng
5eab79e70f manpage: add unlink --dry-run 2015-09-06 15:37:47 +08:00
Alex Dunn
23142bb226 tips-n-tricks: don't encourage sudo
Closes Homebrew/homebrew#43363.

Signed-off-by: Alex Dunn <dunn.alex@gmail.com>
2015-09-02 20:34:54 -07:00