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

docs: mention optional replacement parameter for deprecate/disable

Browse Source
This commit is contained in:
Caleb Xu 2024-11-23 21:03:25 -05:00
parent 3b1d59d8c4
commit c5070e2c7e
No known key found for this signature in database
GPG Key ID: 47E6040D07B8407D
2 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Deprecating-Disabling-and-Removing-Casks.md
View File

@ -35,6 +35,12 @@ The `date` parameter should be set to the date that the deprecation period shoul
The `because` parameter can be a preset reason (using a symbol) or a custom reason. See the [Deprecate and Disable Reasons](#deprecate-and-disable-reasons) section below for more details about the `because` parameter.
An optional `replacement` parameter may also be specified to suggest a replacement formula or cask to the user. The value of the parameter is a string.
```ruby
deprecate! date: "YYYY-MM-DD", because: :reason, replacement: "foo"
```
## Disabling
If a user attempts to install a disabled cask, they will be shown an error message and the install will fail.
@ -62,6 +68,12 @@ The `date` parameter should be set to the date that the reason for disabling cam
The `because` parameter can be a preset reason (using a symbol) or a custom reason. See the [Deprecate and Disable Reasons](#deprecate-and-disable-reasons) section below for more details about the `because` parameter.
Similar to deprecated casks, an optional `replacement` parameter may also be specified for disabled casks to suggest a replacement formula or cask to the user. The value of the parameter is a string.
```ruby
disable! date: "YYYY-MM-DD", because: :reason, replacement: "foo"
```
## Removal
A cask should be removed if it does not meet our criteria for [acceptable casks](Acceptable-Casks.md) or has been disabled for over a year.

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

@ -37,6 +37,12 @@ The `date` parameter should be set to the date that the deprecation period shoul
The `because` parameter can be a preset reason (using a symbol) or a custom reason. See the [Deprecate and Disable Reasons](#deprecate-and-disable-reasons) section below for more details about the `because` parameter.
An optional `replacement` parameter may also be specified to suggest a replacement formula or cask to the user. The value of the parameter is a string.
```ruby
deprecate! date: "YYYY-MM-DD", because: :reason, replacement: "foo"
```
## Disabling
If a user attempts to install a disabled formula, they will be shown an error message and the install will fail.
@ -64,6 +70,12 @@ The `date` parameter should be set to the date that the reason for disabling cam
The `because` parameter can be a preset reason (using a symbol) or a custom reason. See the [Deprecate and Disable Reasons](#deprecate-and-disable-reasons) section below for more details about the `because` parameter.
Similar to deprecated formulae, an optional `replacement` parameter may also be specified for disabled formulae to suggest a replacement formula or cask to the user. The value of the parameter is a string.
```ruby
disable! date: "YYYY-MM-DD", because: :reason, replacement: "foo"
```
## Removal
A formula should be removed if it does not meet our criteria for [acceptable formulae](Acceptable-Formulae.md) or [versioned formulae](Versions.md), has a non-open-source license, or has been disabled for over a year.