39 Commits

Author SHA1 Message Date
Rahul Horé
8032ab9322 How To Open a PR: fix typo.
Closes Homebrew/homebrew#36916.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-02-18 13:37:31 +00:00
Dominyk Tiller
8e12390fc8 Update Example Formula documentation.
I feel like we’re probably fighting a losing battle here, but here’s a
bundle more updates to the example formula to cover some ground not
already covered.

Closes Homebrew/homebrew#36644.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-02-09 12:40:10 +00:00
Mike McQuaid
8e34b4c322 How-To-Open-a-Homebrew-Pull-Request: bottle update 2015-02-05 11:55:13 +00:00
Tim D. Smith
c3691ca950 Suggest homebrew-pypi-poet instead of mkpydeps 2015-02-04 18:18:29 -08:00
Dominyk Tiller
a2cb0c2af5 formula-cookbook: document conflicts
Closes Homebrew/homebrew#36179.
Closes Homebrew/homebrew#36184.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-01-27 12:27:42 +00:00
Mike McQuaid
eaba2607c4 Add brewdler tap to documentation. 2015-01-27 11:20:21 +00:00
Will Jordan
54eaa730da The-brew-command: link to manpage.
Closes Homebrew/homebrew#36252.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-01-27 08:19:36 +00:00
Joe Chan
b6a91fb234 Added link to fork Homebrew for the lazy.
Closes Homebrew/homebrew#36087.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-01-22 16:58:54 +01:00
Mike McQuaid
3e3603e9fb Acceptable Formulae: clarify rules.
Some clarification on these given discussion in https://github.com/Homebrew/homebrew/pull/35853.

Closes Homebrew/homebrew#35880.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-01-15 11:20:24 +00:00
Viktor Szakats
b81097cdee Use more https links and some link updates along the way
Closes Homebrew/homebrew#35529.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2015-01-03 23:03:08 -05:00
Dominyk Tiller
d071e2a5f4 Maintainer-Guidelines: basic touch-up
* Moved the `pip` homepage to something that points more directly at
`pip`.
* Adds a note on `test do`. All the maintainers and the bot check the
existence of such things these days, but I guess if anyone stumbles
across the document it’s useful to say.
* GiX is formally dead, and has two blessed forks.
* Typo on contributor.

Closes Homebrew/homebrew#35467.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-01-02 17:13:23 +00:00
Dominyk Tiller
7b0cc143cb Documentation Updates
Acceptable-Formulae:

* Makes the language around stable versions stricter.
* Fixes the Homebrew/Head-only lack-of-hyphen.
* Adds Homebrew/Devel-only.

Formula-Cookbook:
* Adds a link to Interesting-Taps-&-Branches.
* Fixes the Python language to match Tim’s latest guidelines.
* Adds a note on options that aren’t ` build-with? ` or `
build-without? `.

Interesting-Taps-&-Branches:
* Slightly modifies the Versions language to better match what the
repository actually ships.
* Adds Homebrew/Devel-only to the language.

Closes Homebrew/homebrew#35298.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-12-28 09:25:46 +00:00
Alan Ivey
cec6ee6527 Update brew-services information
@gapple has taken the mantle of brew services: https://github.com/Homebrew/homebrew/issues/28657#issuecomment-58318215

Closes Homebrew/homebrew#35090.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-12-18 15:39:37 +00:00
Dominyk Tiller
1c3a810830 Documentation Updates
Some minor changes to reflect Homebrew/homebrew#34989, and other bits and pieces.

Closes Homebrew/homebrew#35023.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2014-12-16 00:41:07 -05:00
Jack Nagel
007926d7a6 Correct external command docs 2014-12-11 21:53:11 -05:00
Tim D. Smith
df2e570fef Python docs: use prepend_create_path
prepend_path doesn't do anything if path doesn't already exist, so use
prepend_create_path.
2014-12-11 07:55:32 -08:00
Tim D. Smith
c5c4684714 docs: recommend setup_install_args instead of setup_install
Closes Homebrew/homebrew#34793.
2014-12-10 14:20:17 -08:00
chdiza
720f13d8d5 Cookbook: Fix the link for squashing-instructions
Closes Homebrew/homebrew#34859.

Signed-off-by: Misty De Meo <mistydemeo@gmail.com>
2014-12-10 11:25:44 -08:00
Xu Cheng
219ba68c2a doc: update brew-desc install method
Closes Homebrew/homebrew#34785.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-12-08 11:24:10 +00:00
Jakukyo Friel
aad52918f4 doc/External-Commands: update links
`brew-gem`'s link is 404.
`brew-pip` has reached EOL.
Thus I updates the link of `brew-gem`, and remove descriptions
about `brew-pip`.

Thanks @DomT4 for pointing out brew-gem's new home.

Closes Homebrew/homebrew#34569.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2014-12-06 22:05:23 -05:00
Dominyk Tiller
0d2ae7147c Documenting keg-only outside of Homebrew.
How-to-use-keg-only-outside-of-brew:
* A new piece of documentation detailing how to deal with using
keg_only formula outside of Brew itself. We’ve had a lot of questions
and issues about this recently, and the solutions aren’t as easy and
explicit to find elsewhere, so detailing it here may help reduce some
of the questions we’ve seen recently.
* I possibly whinged too much in the second section. I’m open to
criticism and being called whiny.
* Details flags, prepending the $PATH, and dealing with pkg-config.

Closes Homebrew/homebrew#34608.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-12-05 11:25:08 +00:00
Alessio Bogon
0a8b0d4a5c Add brew-livecheck to the list of external commands. 2014-12-03 13:36:23 +00:00
Dominyk Tiller
1e04a7f16a Documentation Changes
More proposed documentation updates.

Acceptable Formulae:

* Adds Perl to the list of stuff we offer Dupes of in the Core.
* Notes that OS X’s OpenSSL is usually horribly outdated.
* Removes the incorrect space between font and forge.

Common Issues:

* We said three issues, we listed four. Oops.

External Commands:

* The cache is usually at /Library rather than ~/Library, and the rest
of the documentation says /Library, so this makes the referencing
consistent.

FAQ:

* Adds a tiny section on pinning formulae.

Interesting-Taps-And-Branches:
* Notes gaming-emulation software belongs in Homebrew/Games as well.
* nolith/Embedded hasn’t been touched for 28 months. I’ve cut it.
* anarchivist/forensics hasn’t been touched for 35 months. I’ve cut it.
* codebutler’s GTK+ experiment seems to have been terminated after one
commit. I’ve cut it.
* paxam/linux hasn’t been touched for 34 months. I’ve cut it.
* rmyers/homebrew hasn’t been touched in 42 months. I’ve cut it.
* nddrylliog/winbrew has moved, I’ve changed the URL to the new one.

Winbrew.md:
* Removed. It’s referenced in the prior file, and doesn’t really need
its own.

Closes Homebrew/homebrew#34599.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-12-02 14:31:32 +00:00
Jack Nagel
88b93b7aa3 Formula files are created in the repository
which is not necessarily the same as the prefix.
2014-12-01 12:11:56 -05:00
Peter Aronoff
f8b4c3603f Add brew any-tap to the list of user commands
Closes Homebrew/homebrew#34571.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-11-30 21:52:10 +00:00
Jakukyo Friel
264886cfc9 Update doc/cookbook: use $HOMEBREW_PREFIX
Use $HOMEBREW_PREFIX instead of `/usr/local` when talking about
formula file path.

Closes Homebrew/homebrew#34568.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-11-30 17:08:02 +00:00
Tim D. Smith
d3ab27f860 docs: Python for formula authors
Closes Homebrew/homebrew#34228.
2014-11-26 00:21:43 -08:00
Dominyk Tiller
e8d7d1df9c Documentation Updates
Mike probably wants to cast an eye over all of this, but in summary:

In the Example Formula:
* Updates with a revision example.
* Updates with a mirror mirror (Whoa meta).
* Replaces the bottles with more modern examples.
* Adds the Yosemite binary dependency options.
* Improves the plist documentation

In the Bottles doc:
* Modernises the expected bottle readout.
* Adds double quotes.

In the FAQ:
* Updates the bottle language to reflect Yosemite’s arrival and the
Bot’s new minimum OS bottle generation.

In the Formula-Cookbook:
* Adds a mega block on the OpenSSL situation in Homebrew, complete with
examples and explanation.
* Changes the X11 dependency example to optional to reflect Jack’s
recently-expressed pattern in other formulae.
* Explains why and how formulae are sometimes revisioned, and the
mechanism behind that.
* Updates the Ldapvi `otool` readout to reflect the new usage of
OpenSSL. Setting a good example and all that.
* Updates the Python language to match Tim’s new Python handling.
* Updates the naming block to explain how Homebrew handles name
conflicts, complete with examples.
* Updates (a tiny bit) the sandbox creation in /tmp to reflect the
current style.
* Updates the chmod to move away from +x towards 0555 instead.
* Labels the `enable-ham` option depreciated rather than old. Slightly
firmer.
* Updates the bottle block instructions to reflect Homebrew’s audit
mechanism not crying about it locally.

Closes Homebrew/homebrew#34275.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-11-18 09:12:39 +00:00
Jack Nagel
e00a6e4c4d Remove more references to removed external commands 2014-11-16 21:57:08 -06:00
Mike McQuaid
62c270cbc6 Formula Cookbook: fix make install separation. 2014-11-13 13:04:42 +00:00
Dominyk Tiller
e66e302c14 Documentation Fixes
The bigger, uglier brother of Homebrew/homebrew#34090.

Closes Homebrew/homebrew#34106.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-11-12 08:03:13 +00:00
Kenneth Pullen
d78769743d Fix broken link in Acceptable Formulae
The link to the Homebrew dupes repo was broken because of a typo.

Closes Homebrew/homebrew#33931.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-11-05 11:26:49 +00:00
Mike McQuaid
b3838675ec Homebrew-and-Python: explain about Python bottles. 2014-11-01 10:42:56 +00:00
Mike McQuaid
f55ad864e0 Note that PRs will not show up as merged. 2014-10-31 22:13:03 +00:00
Jack Nagel
d1fae671f1 Update recommended Xcode for 10.9 2014-10-29 11:04:31 -05:00
Vítor Galvão
7557cc1683 Removed extraneous backtick in FAQ
It was causing a command to not display correctly.

Closes Homebrew/homebrew#33686.

Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2014-10-28 21:30:56 -05:00
Mike McQuaid
b5d96a80bf Acceptable Formulae: his/her -> their. 2014-10-26 15:51:06 +00:00
Mike McQuaid
03088c308e Tweak core contributor brew-test-bot docs. 2014-10-26 15:31:29 +00:00
Mike McQuaid
19d12aee45 Import docs from wiki.
Closes Homebrew/homebrew#33211.
2014-10-26 14:57:36 +00:00