docs/Deprecating-Disabling-and-Removing-Casks.md: add cask deprecate/disable reasons

This commit is contained in:
Bevan Kay 2024-02-25 19:58:35 +11:00
parent 80d4488bbf
commit b544934fbf
No known key found for this signature in database
GPG Key ID: C55CB024B5314B57

View File

@ -75,6 +75,8 @@ When a cask is deprecated or disabled, a reason explaining the action must be pr
There are two ways to indicate the reason. The preferred way is to use a pre-existing symbol to indicate the reason. The available symbols are listed below and can be found in the [`DeprecateDisable` module](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/deprecate_disable.rb): There are two ways to indicate the reason. The preferred way is to use a pre-existing symbol to indicate the reason. The available symbols are listed below and can be found in the [`DeprecateDisable` module](https://github.com/Homebrew/brew/blob/master/Library/Homebrew/deprecate_disable.rb):
- `:discontinued`: the cask is discontinued upstream - `:discontinued`: the cask is discontinued upstream
- `:no_longer_available`: the cask is no longer available upstream
- `:unmaintained`: the cask is not maintained upstream
These reasons can be specified by their symbols (the comments show the message that will be displayed to users): These reasons can be specified by their symbols (the comments show the message that will be displayed to users):