56 Commits

Author SHA1 Message Date
Mike McQuaid
d661cffc1f
Switch to using main as the default branch
Homebrew/brew has moved to a `main` default branch so we can more move
references from `master` to `main`.
2025-06-24 11:14:57 +01:00
Eric Knibbe
29b2f35ce8
docs: prefer /opt/homebrew in examples 2025-02-03 15:30:03 +01:00
Issy Long
31d7bcc583
Add a last_reviewed_date to docs metadata
- At the AGM we formed an ad-hoc documentation working group.
- One of our ideas was that we should have a last reviewed date for
  documentation, so that we can periodically implement a review
  mechanism (GitHub Actions posts to Slack for a regular documentation
  outdatedness check?) to track how old docs are and ensure they're
  still relevant.
- This is a first step towards that goal, by adding a `last_review_date`
  to the metadata of all docs with a date of earlier than Homebrew's
  inception because everything needs reviewing so that we start from a
  good base!
2025-02-03 11:56:07 +00:00
Patrick Linnane
7fd9d09be0
Update docs/Acceptable-Formulae.md
Co-authored-by: Ruoyu Zhong <zhongruoyu@outlook.com>
2024-03-01 15:36:25 -08:00
Patrick Linnane
e98808e566
docs: update language on commit messages & notability
Signed-off-by: Patrick Linnane <patrick@linnane.io>
2024-03-01 11:05:08 -08:00
Mike McQuaid
947525893f
Merge pull request #16606 from Homebrew/deprecation-disable-forks-versions-docs
Update Acceptable/Deprecating/Forks/Versions docs
2024-02-14 19:29:18 +00:00
Mike McQuaid
ad25b5a776
Update docs/Acceptable-Formulae.md
Co-authored-by: Michael Cho <michael@michaelcho.dev>
2024-02-14 19:17:02 +00:00
Mike McQuaid
5e641f0d72
Update docs/Acceptable-Formulae.md
Co-authored-by: Ruoyu Zhong <zhongruoyu@outlook.com>
2024-02-14 17:32:00 +00:00
Mike McQuaid
fe90e98f79
Update docs/Acceptable-Formulae.md 2024-02-14 17:09:01 +00:00
Mike McQuaid
7e7096ba14
Update docs/Acceptable-Formulae.md
Co-authored-by: Ruoyu Zhong <zhongruoyu@outlook.com>
2024-02-14 16:14:22 +00:00
Mike McQuaid
bb57a09be0
Acceptable-Formulae: update static library guidance.
Resulting from discussion in https://github.com/Homebrew/homebrew-core/pull/162352
2024-02-14 08:50:24 +00:00
Mike McQuaid
63e1c540fd
Update Acceptable/Deprecating/Forks/Versions docs
As discussed at the AGM:
- Only allow formula/cask forks to be used when either blessed by
  the source or used by two other major distributions,
- Further elaborate and tweak reasons to deprecate/disable formulae.
- Allow more versioned formulae when widely used.
- Add a document (based on above) for deprecating/disabling casks.

While we're here:
- let VSCode Markdown linting remove the trailing `!` from an
  Acceptable Casks heading
2024-02-13 10:13:44 +00:00
Mike McQuaid
ae94d9e28b
docs: various tweaks.
Adjust various maintainer and contributor-focused documents after
recent maintainer conversations and generally anything I noticed was
wrong or outdated as I went through these.
2023-12-06 14:29:09 -05:00
Sean Molenaar
11821aa74b
Update Acceptable-Formulae.md
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2023-08-15 18:21:17 +02:00
Sean Molenaar
2db75db7f8
Update Acceptable-Formulae.md
Co-authored-by: Patrick Linnane <patrick@linnane.io>
2023-08-15 18:16:10 +02:00
Sean Molenaar
d523cdc0ec
fix: use cannot instead of can not
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
2023-08-15 17:27:02 +02:00
Sean Molenaar
8d537260af
chore: document the policy on static libraries 2023-08-15 17:18:33 +02:00
EricFromCanada
42e91e8668
docs: add Table of Contents to selected pages 2022-12-30 00:45:30 -05:00
EricFromCanada
d615899ca9
Contributors docs: content & formatting updates
Update How-To-Open-a-Homebrew-Pull-Request.md

Update Acceptable-Formulae.md

Update Acceptable-Casks.md

Update License-Guidelines.md

Update Versions.md

Update Versions.md

Update Deprecating-Disabling-and-Removing-Formulae.md

Update Node-for-Formula-Authors.md

Update Python-for-Formula-Authors.md

Update Brew-Livecheck.md

Update Migrating-A-Formula-To-A-Tap.md

Update Rename-A-Formula.md

Update How-to-Create-and-Maintain-a-Tap.md

Update Brew-Test-Bot.md

Update Typechecking.md
2022-11-16 09:03:12 -05:00
EricFromCanada
034bf72235
Contributors docs: adjust line breaks 2022-11-16 09:03:12 -05:00
Michka Popoff
08e4e2f201
docs: document CI versions of Ubuntu 2022-08-05 00:17:47 +02:00
Michka Popoff
c4f57af057
docs/Acceptable-Formulae: specifiy the list of supported platforms 2021-11-18 11:49:55 +00:00
Sean Molenaar
de63b4606d
docs: Acceptable-Formulae update
Co-authored-by: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2021-07-13 20:47:26 +02:00
Sean Molenaar
6bdb0cfb26
docs: don't allow patches for linux formula either 2021-07-12 08:11:52 +02:00
Alexander Bayandin
7513c9f3b1
Acceptable-Formulae: quote from Veracode report 2021-06-29 12:54:32 +01:00
Sean Molenaar
4af981338e
Update docs/Acceptable-Formulae.md
Co-authored-by: Carlo Cabrera <30379873+carlocab@users.noreply.github.com>
2021-03-25 08:20:56 +01:00
Sean Molenaar
657e4d1ace
docs: no more cask exceptions 2021-03-24 16:18:01 +01:00
Dustin Rodrigues
d400b151e7 minor typo fixes 2020-09-02 12:23:14 -04:00
Sean Molenaar
8ac3cd0e70
Add note about vendoring dependencies 2020-09-01 20:47:41 +02:00
Mike McQuaid
69066d3087
Tweak Acceptable Formulae
- make clearer how self-updates should be handled
- move from OSI to Debian approved licenses
- don't allow open source software to depend on proprietary software
2020-03-20 14:08:47 +00:00
Claudia Pellegrino
eeecb62568 Update docs/Acceptable-Formulae.md
Co-Authored-By: jonchang <jchang641@gmail.com>
2019-04-15 18:58:18 +10:00
Jonathan Chang
6748b1ee84 docs: update Acceptable Formula for options/guis 2019-04-15 18:22:39 +10:00
Jason Tedor
d8f4ce1e58
Clarify the meaning of open source for core formula
This commit clarifies the meaning of "open-source" when explaining that
only open source formulae are acceptable in core. In particular, the
open source license must be an OSI-approved license.
2018-12-14 16:09:45 -05:00
EricFromCanada
31dbc4f985 Various documentation edits
Mostly edits to formatting, grammar, wording for consistency & readability.
2018-10-05 17:23:22 -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
Reto Kromer
39e933bd10
fix typo 2018-06-10 19:36:24 +02: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 4475651b548afdcf15c4cf7a7cb57baca1885186.
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
c22fcac08d docs/Acceptable-Formulae: address feedback.
Address comments in:
27ec9dae5f
2018-04-28 15:03:05 +01:00
Mike McQuaid
27ec9dae5f
Acceptable Formulae: base on current thinking. 2018-04-26 08:26:57 +01:00
Mike McQuaid
84363f8a3a docs/Acceptable-Formulae: remove bindings mention.
We do accept these e.g. `boost-python`.
2018-03-02 16:21:29 +00:00
Mike McQuaid
190e665bb1 Revert "docs: use short links."
This reverts commit e63a2ee8de12f0f938f6a95cdb9763dbe0187b4a.

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
bm5k
696a07a010 another stray & 2017-07-11 23:58:19 -05:00
Mike McQuaid
9c616c0399 Acceptable-Formulae: general cleanup.
- We no longer care about dupes, really
- Extend `.app` criteria to include GUI applications in general
- Note we want things to build with Clang
- Note we don't want users to have to faff too much
2017-07-10 08:21:46 +01:00
Josh McKinney
251270e9a3 Remove duplicates repo from Acceptable formula doc
Duplicates repo is deprecated
2017-06-05 21:49:29 -05:00
Baptiste Fontaine
ca4ccce6ea Acceptable-Formulae: reword 'niche stuff' 2017-04-19 22:27:49 +02: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
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