admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
This commit is contained in:
Carlo Cabrera 2022-01-18 18:57:14 +08:00 committed by GitHub
parent 9c171ea7da
commit 121771f1a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/Deprecating-Disabling-and-Removing-Formulae.md
View File

@ -18,11 +18,11 @@ A formula should be deprecated to indicate to users that the formula should not
The most common reasons for deprecation are when the upstream project is deprecated, unmaintained, or archived. The most common reasons for deprecation are when the upstream project is deprecated, unmaintained, or archived.
Formulae with dependents should **not** be deprecated unless: Formulae with dependents should **only** be deprecated if any of the below are true:
- all of its dependents are also deprecated; - its dependents are all deprecated
- the formula does not build on any of our supported platforms; or, - the formula does not build on any of our supported macOS versions and on Linux
- the formula has outstanding CVEs. - the formula has outstanding CVEs
To deprecate a formula, add a `deprecate!` call. This call should include a deprecation date (in the ISO 8601 format) and a deprecation reason: To deprecate a formula, add a `deprecate!` call. This call should include a deprecation date (in the ISO 8601 format) and a deprecation reason:
@ -47,7 +47,7 @@ The most common reasons for disabling a formula are:
- the upstream repository has been removed - the upstream repository has been removed
- the project has no license - the project has no license
Formulae should not be disabled without a reasonable deprecation period unless the circumstances are exceptional (e.g. the formula does not build). How long a reasonable period is depends on the formula's usage statistics. Popular formulae should have longer deprecation periods. We should aim to have a formula deprecated for at least three months before disabling it. Formulae should not be disabled without a deprecation period of at least three months unless the circumstances are exceptional (e.g. the formula does not build on any supported macOS version or Linux). How long a reasonable period is depends on the formula's usage statistics. Popular formulae should have longer deprecation periods.
**Note: disabled formulae in homebrew/core will be automatically removed one year after their disable date** **Note: disabled formulae in homebrew/core will be automatically removed one year after their disable date**