Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Patrick Linnane <patrick@linnane.io>
  • Loading branch information
MikeMcQuaid and p-linnane committed Feb 8, 2024
1 parent 5a2e8e6 commit 121ddb0
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/Acceptable-Casks.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Note that none of these exceptions is a guarantee for inclusion, but examples of
We will not add new casks using forks unless at least one of the following is true:

* the fork has been "blessed" (i.e. pointed to by the original source repository and noted as the official successor)
* the fork has been used as the replacement by at least two other major distributions (e.g. Ubuntu, Debian, not Some Random Linux Distro Nobody Uses)
* the fork has been used as the replacement by at least two other major distributions (e.g. Ubuntu, Fedora, Arch Linux, not Some Random Linux Distro Nobody Uses)

The fork must still meet all the other acceptable casks requirements (including those of e.g. popularity and self-submission).

Expand Down
8 changes: 4 additions & 4 deletions docs/Deprecating-Disabling-and-Removing-Casks.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ A cask should be disabled to indicate to users that the cask cannot be used and
The most common reasons for disabling a cask are:

- it cannot be installed
- it has been deprecated for a long time
- the upstream URL has been removed
- it has been deprecated in Homebrew for at least six months
- the upstream URL has been removed or uses archive.org

Popular casks (i.e. have more than 999 [analytics installs in the last 30 days](https://formulae.brew.sh/analytics/cask-install/30d/)) should not be disabled without a deprecation period of at least six months even if e.g. they do not install on all macOS versions.
Popular casks (i.e. have more than 999 [analytics installs in the last 30 days](https://formulae.brew.sh/analytics/cask-install/30d/)) should be deprecated for at least six months even if e.g. they do not install on all macOS versions before being disabled.

Unpopular casks (i.e. have fewer than 1000 [analytics installs in the last 30 days](https://formulae.brew.sh/analytics/cask-install/30d/)) can be deprecated immediately for any of the reasons above e.g. they cannot be installed.

Expand Down Expand Up @@ -90,7 +90,7 @@ deprecate! date: "2020-01-01", because: :deprecated_upstream

```ruby
# Error: <cask> has been disabled because it does not build!
disable! date: "2020-01-01", because: :does_not_build
disable! date: "2020-01-01", because: :deprecated_upstream
```

If these pre-existing reasons do not fit, a custom reason can be specified. Such reasons should be written to fit into the sentence `<cask> has been deprecated/disabled because it <reason>!`.
Expand Down
6 changes: 3 additions & 3 deletions docs/Deprecating-Disabling-and-Removing-Formulae.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ 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.

Formulae should only be be deprecated if at least one of the following are true:
Formulae should only be be deprecated if at least one of the following is true:

- the formula does not build on any of our supported macOS versions and on Linux
- the formula has outstanding CVEs

Formulae with dependents should not be deprecated until or when all dependents are also deprecated.
Formulae with dependents cannot not be deprecated until or when all dependents are also deprecated.

To deprecate a formula, add a `deprecate!` call. This call should include a deprecation date (in the ISO 8601 format) and a deprecation reason:

Expand All @@ -48,7 +48,7 @@ The most common reasons for disabling a formula are:
- the upstream repository has been removed
- the project has no license

Popular formulae (i.e. have more than 999 [analytics installs in the last 30 days](https://formulae.brew.sh/analytics/install/30d/)) should not be disabled without a deprecation period of at least six months even if e.g. they do not build from source and do not have a license.
Popular formulae (i.e. have more than 999 [analytics installs in the last 30 days](https://formulae.brew.sh/analytics/install/30d/)) should be deprecated for at least six months even if e.g. they do not build from source and do not have a license before being disabled.

Unpopular formulae (i.e. have fewer than 1000 [analytics installs in the last 30 days](https://formulae.brew.sh/analytics/install/30d/)) can be deprecated immediately for any of the reasons above e.g. they cannot be built from source on any supported macOS version or Linux.

Expand Down

0 comments on commit 121ddb0

Please sign in to comment.