87 Commits

Author SHA1 Message Date
Sam Ford
308390ba5b
Address feedback and expand documentation
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
Co-authored-by: Sean Molenaar <1484494+SMillerDev@users.noreply.github.com>
2021-01-11 17:51:41 -05:00
psobolewskiPhD
5159c8f6a6 Correct missing ? in build.with?("qt5")
Correct Messaging section:
missing ? in: build.with?("qt5")
2021-01-04 01:26:08 -05:00
Rylan Polster
5a1adeae06 docs: incorporate changes from code review
Co-Authored-By: Seeker <meaningseeking@protonmail.com>
Co-Authored-By: Sean Molenaar <smillerdev@me.com>
Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
Co-Authored-By: Michka Popoff <3406519+iMichka@users.noreply.github.com>
2020-12-25 11:00:58 -05:00
Sean Molenaar
402600a94f
docs: add documentation for plists 2020-12-11 21:33:19 +01:00
Misty De Meo
7f5a94bbcb Formula cookbook: document with_env
The other syntax for setting `ENV` was added in #9013,
but this form remained undocumented.

Fixes #8648.
2020-11-27 09:08:10 -08:00
hyuraku
b193564050 how to set ENV for formula install 2020-11-04 22:49:33 +09:00
KazuakiM
c1dd69f0f7
Update Formula-Cookbook.md
RuboCop.
`Use the new Ruby 1.9 hash syntax.`
2020-10-18 14:12:00 +09:00
Rylan Polster
3c55d8e528 docs: update license documentation 2020-08-25 17:22:35 -04:00
Mike McQuaid
94274f7ffc
docs/Formula-Cookbook: improve license text.
Co-authored-by: Jonathan Chang <jchang641@gmail.com>
2020-08-04 11:17:23 +01:00
Mike McQuaid
fb0268da7e
license: handle "Public Domain".
Allow `:public_domain` to be used as a `license` value and ensure that
it's handled correctly by `brew info`, `brew audit` and `brew install`.
2020-08-04 10:47:41 +01:00
Rylan Polster
19007de6a2
Merge pull request #8165 from Rylan12/python-docs-update
docs: add reference to update-python-resources
2020-08-03 17:10:40 -04:00
Rylan Polster
1173d00bf6 Add links for determining more restrictive license 2020-08-03 10:17:26 -04:00
Rylan Polster
7c6cd247ee
Apply suggestions from code review
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2020-08-03 10:10:17 -04:00
Rylan Polster
9dc21953e8 docs: update-python-resources in Formula Cookbook 2020-08-02 18:17:32 -04:00
Rylan Polster
7fe6384ca5
Improve wording
Co-authored-by: Adrian Ho <the.gromgit@gmail.com>
2020-08-01 13:39:08 -04:00
Rylan Polster
df5aac8b09 docs: add license information 2020-07-31 21:32:36 -04:00
Sean Molenaar
a1e2b8d75c
docs: reference formula assertions for tests 2020-06-27 20:09:15 +02:00
Mike McQuaid
ac0665daff
Refer to default branch in links with HEAD
Anywhere we can use `blob/master` we can use `blob/HEAD` instead. This
will make life easier if we ever rename our default branch in future
(once/if Git and GitHub provides the necessary tooling to do so).
2020-06-25 11:38:40 +01:00
Mike McQuaid
b58fa4ebb1
Drop Mavericks support.
Companion to https://github.com/Homebrew/brew/pull/7698.

Provide better, `odeprecated` messaging for
`depends_on :macos => :mavericks` and otherwise just fix up the code
that relied on `:mavericks`.
2020-06-10 10:06:46 +01:00
Mike McQuaid
1eefc4c584
Adjust documentation for devel deprecation.
Update the documentation to be consistent with #7688.
2020-06-10 09:06:36 +01:00
Mike McQuaid
ea22276e32
Merge pull request #7596 from Homebrew/SMillerDev-patch-1
Specify the stance on mocks in test blocks
2020-05-19 08:23:16 +01:00
Caleb Xu
1cd5d508a1
docs: mention that bin.install can rename file 2020-05-19 00:34:24 -04:00
Sean Molenaar
957f318f2c
Specify the stance on mocks in test blocks 2020-05-18 18:28:40 +02:00
Dan Fabulich
8762fc2d7e Fix formatting issue in Formula Cookbook 2020-05-12 10:34:18 -07:00
dfabulich
67ff3c53fe Document how to use test fixtures 2020-05-12 00:27:12 -07:00
Thierry Moisan
967a2d2687
Update docs/Formula-Cookbook.md
Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
2020-04-08 09:21:38 -04:00
Thierry Moisan
a245eea674
docs/Formula-Cookbook.md: mention the use of 'bottle :unneeded' 2020-04-08 09:14:45 -04:00
Issy Long
6a200cb88a
docs: Fix double-spacing after full stop issues 2019-12-18 16:09:06 +00:00
R Primus
1e57ca70d3
Replace American spelling with British spelling 2019-10-30 18:03:31 +00:00
Mike McQuaid
9b0b10ca03
Formula Cookbook: use "caveats" name explicitly. 2019-06-20 11:05:28 +01:00
Sean Molenaar
c592da2996
Pick up suggestio
Co-Authored-By: Mike McQuaid <mike@mikemcquaid.com>
2019-06-20 10:37:26 +02:00
Sean Molenaar
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 McQuaid
1325075820
Formula Cookbook: remove "see" 2019-02-22 08:49:55 +00:00
David Beitey
833aee53e0
Docs: fix formatting in Formula Cookbook 2019-02-22 00:45:27 +00:00
Mike McQuaid
d415600e20
Formula Cookbook: fix typo. 2019-02-16 09:50:18 +00:00
Mike McQuaid
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 Ralph
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