53 Commits

Author SHA1 Message Date
Mike McQuaid
341b64cc96 Formula-Cookbook: better inreplace example.
Make multiple replacements if using the block form.
2016-04-22 09:58:40 +01:00
Andrew Janke
496fff643f doco: more updates for core/formula separation
Closes #71.

Signed-off-by: Andrew Janke <andrew@apjanke.net>
2016-04-11 19:29:42 -04: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
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
Dominyk Tiller
6e33ace71b Formula-Cookbook: update CONTRIBUTING path 2016-02-18 08:19:17 +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
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
Baptiste Fontaine
f29699f77c Cookbook: clearer wording 2016-01-02 23:27:56 +01: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
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
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
Dominyk Tiller
92585165f3 Formula-Cookbook: wording clarity 2015-12-04 05:37:19 +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
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
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
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
Mike McQuaid
2c959a7d58 More API documentation.
And remove the documented stuff from the `example-formula.rb`.

Closes Homebrew/homebrew#43241.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-29 15:43:16 +01:00
Dominyk Tiller
6362b5fdba Formula-Cookbook: wording tweaks 2015-08-22 19:49:20 +01:00
Aldrin Piri
6abf63c99b Formula-Cookbook: document strict audit
Providing specific reference to the --strict option for brew audit.

Closes Homebrew/homebrew#43155.
Closes Homebrew/homebrew#43156.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-08-22 19:49:19 +01:00
Dominyk Tiller
bb4237a230 cookbook: document pkgshare 2015-08-12 15:58:23 +01:00
Ian Lancaster
65dbdccfc0 Formula-Cookbook: avoid non-with options
Closes Homebrew/homebrew#42433.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-08-05 20:08:54 +01:00
Dominyk Tiller
e1d736a0fa Formula-Cookbook: tweak conflicts_with
Closes Homebrew/homebrew#42432.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-08-04 01:40:15 +01:00
Viktor Szakats
a639601f14 Formula-Cookbook: SSL/TLS homepage is preferred
Closes Homebrew/homebrew#40998.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-06-23 13:42:30 +01:00
Larry Gilbert
69b629b041 Various edits for punctuation, grammar, spelling, etc.
Closes Homebrew/homebrew#40478.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-06-10 17:44:00 +01:00
Viktor Szakats
a8caf3636c Formula-Cookbook: update download strategy example
The new one uses sha256 instead of md5 and
the urls still work and are all https, too.

Closes Homebrew/homebrew#40455.

Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-06-06 19:18:42 +01:00
Viktor Szakats
e5186c1541 update docs to use https urls
Closes Homebrew/homebrew#40446.

Signed-off-by: Xu Cheng <xucheng@me.com>
2015-06-06 17:45:41 +08:00
Baptiste Fontaine
9928754c22 cookbook: add an explicit version if necessary
Closes Homebrew/homebrew#40247.

Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-06-01 20:20:03 +02:00
Mike McQuaid
cd63b740a5 Formula-Cookbook: add description field. 2015-05-26 10:00:43 +01:00
Mike McQuaid
af66c12108 Formula Cookbook: clarify new use of tag revision. 2015-03-30 08:11:33 +01:00
Artur Dryomov
832c52db7e share/doc/homebrew: fix capitalization.
Reference.
* GitHub: https://github.com/about
* Xcode: https://developer.apple.com/xcode
* Zsh: http://www.zsh.org

Closes Homebrew/homebrew#37866.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-03-19 16:43:12 +00:00
Tim D. Smith
da0d2bf65d Mention homebrew-go-resources in cookbook 2015-03-14 22:50:58 -07:00
Dominyk Tiller
12861686b8 checksums: switch to sha256 for bottles and new formulae
Closes Homebrew/homebrew#37164.

Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-03-05 14:45:39 +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
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
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
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
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
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
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
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
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