aboutsummaryrefslogtreecommitdiffstats
path: root/share/doc/homebrew/Formula-Cookbook.md
AgeCommit message (Collapse)Author
2016-03-19Formula Cookbook: /environmental/environment/Alex Dunn
Closes Homebrew/homebrew#50146. Signed-off-by: Alex Dunn <adunn@ucsb.edu>
2016-03-19Formula Cookbook: note $HOME overrideAlex Dunn
See https://github.com/Homebrew/homebrew/pull/50130#discussion_r56254860
2016-03-01Clarify case conventions in formula namingDamien Pollet
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-02-29Formula-Cookbook: Improve testing suggestionsGeorge Hartzell
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-18Formula-Cookbook: update CONTRIBUTING pathDominyk Tiller
2016-02-03doc: fix typos in Formula CookbookPrayag Verma
`preprended` > `prepended` Replace `a` with `an` `throughly` > `thoroughly` Remove extra `consider` Closes Homebrew/homebrew#48697. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-01-22doc: Fix some typos at Formula CookbookMarcelo Boeira
Closes Homebrew/homebrew#48342. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2016-01-14Cookbook: remove ref to obsolete 'def patches'Baptiste Fontaine
2016-01-11Cookbook: Replace 'onoe' with 'odie'Glenn / devalias
Closes Homebrew/homebrew#47948. Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2016-01-02Cookbook: clearer wordingBaptiste Fontaine
2015-12-26Formula-Cookbook: recommend gdm for go resourcesCameron Sparr
Closes Homebrew/homebrew#46889. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-12-09Remove Git Conflict Markers in DocumentationRobert Eshleman
`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-07Overhaul, simplify and cleanup documentation.Mike McQuaid
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-04Formula-Cookbook: wording clarityDominyk Tiller
2015-11-26Formula-Cookbook: don't remove bottle revisionsDominyk Tiller
2015-11-26Formula-Cookbook: note when to remove revisionsgunnaraasen
Closes Homebrew/homebrew#46286. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-11-23Docs: deprecate homebrew/head-onlyBaptiste Fontaine
Closes Homebrew/homebrew#46243. Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-10-31Formula cookbook: PolarSSL was renamed to mbedtlsJacob Krall
See 29bc61e9163e43931ff4736fa3cefaff1918f153 Closes Homebrew/homebrew#45533. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-10-27The Formula API is no longer work-in-progress.Mike McQuaid
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-26cookbook: mention --set-name for 'brew create'Baptiste Fontaine
Closes Homebrew/homebrew#45335. Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-10-15Formula-Cookbook: point to audit --strict.Raimonds Kalnins
Closes Homebrew/homebrew#44940. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-29More API documentation.Mike McQuaid
And remove the documented stuff from the `example-formula.rb`. Closes Homebrew/homebrew#43241. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-08-22Formula-Cookbook: wording tweaksDominyk Tiller
2015-08-22Formula-Cookbook: document strict auditAldrin Piri
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-12cookbook: document pkgshareDominyk Tiller
2015-08-05Formula-Cookbook: avoid non-with optionsIan Lancaster
Closes Homebrew/homebrew#42433. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-08-04Formula-Cookbook: tweak conflicts_withDominyk Tiller
Closes Homebrew/homebrew#42432. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-06-23Formula-Cookbook: SSL/TLS homepage is preferredViktor Szakats
Closes Homebrew/homebrew#40998. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-06-10Various edits for punctuation, grammar, spelling, etc.Larry Gilbert
Closes Homebrew/homebrew#40478. Signed-off-by: Dominyk Tiller <dominyktiller@gmail.com>
2015-06-06Formula-Cookbook: update download strategy exampleViktor Szakats
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-06update docs to use https urlsViktor Szakats
Closes Homebrew/homebrew#40446. Signed-off-by: Xu Cheng <xucheng@me.com>
2015-06-01cookbook: add an explicit version if necessaryBaptiste Fontaine
Closes Homebrew/homebrew#40247. Signed-off-by: Baptiste Fontaine <batifon@yahoo.fr>
2015-05-26Formula-Cookbook: add description field.Mike McQuaid
2015-03-30Formula Cookbook: clarify new use of tag revision.Mike McQuaid
2015-03-19share/doc/homebrew: fix capitalization.Artur Dryomov
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-14Mention homebrew-go-resources in cookbookTim D. Smith
2015-03-05checksums: switch to sha256 for bottles and new formulaeDominyk Tiller
Closes Homebrew/homebrew#37164. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-02-09Update Example Formula documentation.Dominyk Tiller
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-01-27formula-cookbook: document conflictsDominyk Tiller
Closes Homebrew/homebrew#36179. Closes Homebrew/homebrew#36184. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2015-01-03Use more https links and some link updates along the wayViktor Szakats
Closes Homebrew/homebrew#35529. Signed-off-by: Jack Nagel <jacknagel@gmail.com>
2014-12-28Documentation UpdatesDominyk Tiller
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-16Documentation UpdatesDominyk Tiller
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-10Cookbook: Fix the link for squashing-instructionschdiza
Closes Homebrew/homebrew#34859. Signed-off-by: Misty De Meo <mistydemeo@gmail.com>
2014-12-01Formula files are created in the repositoryJack Nagel
which is not necessarily the same as the prefix.
2014-11-30Update doc/cookbook: use $HOMEBREW_PREFIXJakukyo Friel
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-18Documentation UpdatesDominyk Tiller
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-13Formula Cookbook: fix make install separation.Mike McQuaid
2014-11-12Documentation FixesDominyk Tiller
The bigger, uglier brother of Homebrew/homebrew#34090. Closes Homebrew/homebrew#34106. Signed-off-by: Mike McQuaid <mike@mikemcquaid.com>
2014-10-26Import docs from wiki.Mike McQuaid
Closes Homebrew/homebrew#33211.
generated by cgit v1.2.3 (git 2.25.1) at 2026-09-15 02:02:11 +0000