Commit Graph
58 Commits
Author SHA1 Message Date
Mike McQuaidandGitHub 9b0b10ca03 Formula Cookbook: use "caveats" name explicitly. 2019-06-20 11:05:28 +01:00
c592da2996 Pick up suggestio
Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
2019-06-20 10:37:26 +02:00
Sean MolenaarandGitHub 0980c4150f Docs: add caveat info to cookbook 2019-06-20 10:28:34 +02:00
Izaak Beekman 296a660215 Add MPI & linalg guidelines to Formula-Cookbook 2019-06-06 11:17:52 -04:00
Thierry Moisan 7a8a3a30d7 docs/Formula-Cookbook: add more details to tests 2019-04-22 19:08:34 -04:00
Mike McQuaid aa940a21a9 Generate and push rubydoc.brew.sh
This is a replacement for the rubydoc.info site that has been a bit
unreliable for us.

Also, note we're using the community Ruby style guide now rather than
the GitHub one.
2019-03-28 21:15:50 +00:00
FX Coudert a422e80b81 formula-cookbook: devel specs not allowed in core 2019-03-24 21:23:32 +01:00
FX Coudert 875a73dba9 Clarify that options are not allowed in homebrew-core 2019-03-02 11:03:31 +01:00
Mike McQuaidandGitHub 1325075820 Formula Cookbook: remove "see" 2019-02-22 08:49:55 +00:00
David BeiteyandGitHub 833aee53e0 Docs: fix formatting in Formula Cookbook 2019-02-22 00:45:27 +00:00
Mike McQuaidandGitHub d415600e20 Formula Cookbook: fix typo. 2019-02-16 09:50:18 +00:00
Mike McQuaidandGitHub a3a3e3b878 Formula Cookbook: env var docs tweaks. 2019-02-16 09:46:57 +00:00
David Beitey d5f6e4cd34 Add info on env variables for Formula Cookbook
This explains the levels of environment variable filtering present in Homebrew, explaining how and why variables without a `HOMEBREW_` prefix or those which contain `TOKEN` etc are made unavailable to a Formula.
2019-02-16 09:15:20 +10:00
Mike McQuaid 5363e0d4ce docs: update some legacy-homebrew commit URLs.
Use the nice homebrew-core ones instead.
2019-01-21 14:31:41 +00:00
Kenyon RalphandGitHub 91f9fba32b Formula-Cookbook.md: fix wording 2018-12-22 11:40:51 -08:00
Mike McQuaid 599ecc9b5a Deprecate unused download strategies
Download the unused, private download strategies. These are a better fit
for being declared in the formulae and/or taps that use them rather than
in Homebrew/brew where they are unused by Homebrew maintainers or
official taps/formulae.
2018-10-19 10:48:52 +01:00
EricFromCanada 31dbc4f985 Various documentation edits
Mostly edits to formatting, grammar, wording for consistency & readability.
2018-10-05 17:23:22 -04:00
Viktor Szakats a0d971a0d0 secure/fix URLs 2018-10-03 21:21:05 +00:00
EricFromCanada 4fbc1f4126 docs/Formula-Cookbook: update URLs
- update rubydoc.info link URLs to use HTTPS
- link to specific example formula revisions so line highlighting makes sense
- monospace formula link text
2018-10-02 11:55:25 -04:00
EricFromCanada b54b3933eb docs/Formula-Cookbook: Requirements can have a minimum version
And both dependencies and Requirements accept lists.
2018-10-02 11:55:09 -04:00
EricFromCanada f975732a44 docs/Formula-Cookbook: mention newer download strategies
Add `:fossil`, `:github_private_release`, `:github_private_repo`, `:s3`, `:scp`.
2018-10-02 11:55:09 -04:00
Mike McQuaid c1376f9f18 docs: various updates.
I read through the docs locally and made various fixes.
2018-09-06 15:07:00 +01:00
Claudia 6a38b0189c docs/Formula-Cookbook: preach what we practise 2018-09-04 13:56:02 +02:00
commitay 03f496b92e formula-cookbook: remove gdm 2018-05-29 17:28:23 +10:00
Markus Reiter de246cc528 Update Homebrew-Cask references. 2018-05-25 18:20:02 +02:00
Markus Reiter c4222141ac Revert "Update Homebrew-Cask references."
This reverts commit 4475651b54.
2018-05-25 17:57:32 +02:00
Markus Reiter 4475651b54 Update Homebrew-Cask references. 2018-05-25 17:56:16 +02:00
Mike McQuaid 49038a2cd9 Remove mentions to official taps
There are none remaining. We don’t want PHP to get the deprecated
messages until all formulae have been deleted so that will be in a
later PR.
2018-03-31 13:42:33 +01:00
Mike McQuaid d2c23bde6d Audit use of :run dependencies.
These are a no-op so let's remove them.
2018-03-19 10:11:08 +00:00
Mike McQuaid 190e665bb1 Revert "docs: use short links."
This reverts commit e63a2ee8de.

Closes #3832.
2018-02-23 19:52:00 +00:00
Mike McQuaid e63a2ee8de docs: use short links. 2018-02-22 19:25:44 +00:00
Mike McQuaid 977c3323d2 docs.brew.sh updates
- Remove no longer needed `acme-challenge` file
- Set title, description, social image, logo, etc. for SEO
- Use extensionless permalinks (old links still work)
- Cleanup `_config.yml`
- Import latest `_layouts/base` from https://brew.sh
2018-02-22 18:47:29 +00:00
Mike McQuaid 965c079f09 Formula-Cookbook: various updates.
Update some stuff that was deprecated or tweak wording.
2018-01-18 09:39:42 +00:00
Mike McQuaid 4d4722c97c Remove more uses of EOS.undent. 2017-11-10 14:22:39 +00:00
Viktor Szakats b44c7a1022 upgrade more urls to https 2017-08-22 10:31:21 +00:00
Mike McQuaid baa61f5a6e Use https for all docs.brew.sh links.
May as well use the more secure link when possible.
2017-07-27 15:59:37 +01:00
EricFromCanada b4127ee84b docs: update guidelines for duplicates
As per #2873, duplicate and versioned formulae are fine if done right.
2017-07-24 21:28:29 -04:00
Mike McQuaid ae97a9c34e docs: use long flags. 2017-04-02 10:14:58 +01:00
EricFromCanada dc7f74210a docs: code example reformatting
Add labeled fences to most code blocks, monospace terms where
appropriate, omit "$" when referring to variables
2017-03-25 22:53:33 -04:00
EricFromCanada 59fab56afd docs: update sample formula
Also works around bug in Jekyll where a URL with a "#" will cause links
in the same paragraph to not have their extensions replaced by using
"&num;" instead.
2017-03-25 22:36:09 -04:00
EricFromCanada ab4d1a1574 docs: grammar edits, sentence-case secondary headings
Also changes some heading levels so only one primary
heading appears per page.
2017-03-19 14:03:39 -04:00
EricFromCanada ca0071ffc9 Grammar fixes for docs
Fixes to spelling and punctuation for consistency and readability.
2017-02-23 12:20:07 -05:00
Saagar Jha b5b8e4cad7 Split two headers so that both render
The "Messaging" heading was failing to be rendered due to a missing newline between it and "Convenience Tools".
2017-01-26 21:09:34 -08:00
Mike McQuaidandGitHub d8d8c08596 Merge pull request #1839 from justinmayer/persistent-configuration
Add docs on persisting settings across upgrades
2017-01-25 09:35:01 +00:00
Andrew HundtandGitHub 7c7a878b1f clarify what should be in brew create url
resolves https://github.com/Homebrew/brew/issues/1821
2017-01-13 16:20:30 -05:00
Justin Mayer 653f900e59 Add docs on persisting settings across upgrades
There are some formulas in which Homebrew symlinks configuration files
into /usr/local/etc/ instead of copying them, resulting in custom
settings being overwritten on package upgrades. This addition to the
documentation illustrates one way to avoid this behavior by ensuring the
configure script is told where to copy the configuration file(s).

Refs https://github.com/Homebrew/homebrew-core/issues/8711
2017-01-13 11:38:02 -08:00
Mike McQuaidandGitHub 3fde8624b3 Merge pull request #1780 from MikeMcQuaid/use-docs-links
Use docs.brew.sh links.
2017-01-05 17:17:07 +00:00
Jonathan Chang 9a6cd9b83f docs: fix titles on docs.brew.sh 2017-01-04 16:16:00 -06:00
Mike McQuaid a3bffe70bc Use docs.brew.sh links. 2017-01-04 11:13:41 +00:00
Mike McQuaid bc0aa4e64c Add versions documentation. 2017-01-03 18:01:03 +00:00