Skip to content

Commit

Permalink
Merge pull request #17208 from Homebrew/hcv-doc-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
p-linnane authored May 2, 2024
2 parents 6768b64 + e4f7618 commit 9457875
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 10 deletions.
6 changes: 1 addition & 5 deletions docs/Acceptable-Casks.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,9 @@ We maintain separate taps for different types of binaries. Our nomenclature is:

Stable versions live in the main repository at [Homebrew/homebrew-cask](https://github.com/Homebrew/homebrew-cask). They should run on the latest release of macOS or the previous point release (Monterey and Ventura as of late 2022).

#### But there is no Stable version

When software is only available as a beta, development, or unstable version, its cask can go in the main `homebrew/cask` repository. When stable versions become available, only those will be accepted as subsequent updates.

### Beta, Unstable, Development, Nightly, or Legacy

Alternative versions should be submitted to [Homebrew/homebrew-cask-versions](https://github.com/Homebrew/homebrew-cask-versions).
These versions also live in the main repository at [Homebrew/homebrew-cask](https://github.com/Homebrew/homebrew-cask). The filename and token should include `@beta`, `@nightly`, etc. to distinguish them from stable versions.

### Regional and Localized

Expand Down
3 changes: 1 addition & 2 deletions docs/Cask-Cookbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -1053,7 +1053,7 @@ The block will be called immediately before downloading; its result value will b

You can use the `url` stanza with either a direct argument or a block but not with both.

Example of using the block syntax: [vlc-nightly.rb](https://github.com/Homebrew/homebrew-cask-versions/blob/d3b9d0fdcf83f1f87c3ad64a852323a6e687c5f7/Casks/vlc-nightly.rb#L7-L12)
Example of using the block syntax: [vlc@nightly.rb](https://github.com/Homebrew/homebrew-cask/blob/0b2b76ad8c3fbf4e1ee2f5e758640c4963ad6aaf/Casks/v/vlc%40nightly.rb#L7-L12)

##### Mixing additional URL parameters with the block syntax

Expand Down Expand Up @@ -1399,7 +1399,6 @@ These illustrate most of the rules for generating a token:

Cask taps have naming conventions specific to each tap.

* [Homebrew/cask-versions](https://github.com/Homebrew/homebrew-cask-versions/blob/HEAD/CONTRIBUTING.md#naming-versions-casks)
* [Homebrew/cask-fonts](https://github.com/Homebrew/homebrew-cask-fonts/blob/HEAD/CONTRIBUTING.md#naming-font-casks)

### Special affixes
Expand Down
3 changes: 1 addition & 2 deletions docs/Homebrew-homebrew-cask-Maintainer-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@

This guide is intended to help maintainers effectively maintain the cask repositories. It is meant to be used in conjunction with the more generic [Maintainer Guidelines](Maintainer-Guidelines.md).

This guide applies to all three of the cask repositories:
This guide applies to both of the cask repositories:

- [Homebrew/homebrew-cask](https://github.com/Homebrew/homebrew-cask): The main cask repository
- [Homebrew/homebrew-cask-fonts](https://github.com/Homebrew/homebrew-cask-fonts): Casks of fonts
- [Homebrew/homebrew-cask-versions](https://github.com/Homebrew/homebrew-cask-versions): Alternate versions of casks

## Common Situations

Expand Down
2 changes: 1 addition & 1 deletion docs/Maintainer-Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ All Homebrew maintainers are encouraged to contribute to all parts of the projec
- `brew` maintainers: this team maintains the [`Homebrew/brew`](https://github.com/Homebrew/brew) repository. See the [Homebrew/brew Maintainer Guide](Homebrew-brew-Maintainer-Guide.md) for more details about being a `brew` maintainer.
- Core maintainers: this team maintains the [`Homebrew/homebrew-core`](https://github.com/Homebrew/homebrew-core) repository. See the [Homebrew/homebrew-core Maintainer Guide](Homebrew-homebrew-core-Maintainer-Guide.md) for more details about being a core maintainer.
- Linux maintainers: this team maintains the [`Homebrew/homebrew-core`](https://github.com/Homebrew/homebrew-core) repository on Linux.
- Cask maintainers: this team maintains the [`Homebrew/homebrew-cask`](https://github.com/Homebrew/homebrew-cask), [`Homebrew/homebrew-cask-fonts`](https://github.com/Homebrew/homebrew-cask-fonts) and [`Homebrew/homebrew-cask-versions`](https://github.com/Homebrew/homebrew-cask-versions) repositories. See the [Homebrew/homebrew-cask Maintainer Guide](Homebrew-homebrew-cask-Maintainer-Guide.md) for more details about being a cask maintainer.
- Cask maintainers: this team maintains the [`Homebrew/homebrew-cask`](https://github.com/Homebrew/homebrew-cask) and [`Homebrew/homebrew-cask-fonts`](https://github.com/Homebrew/homebrew-cask-fonts) repositories. See the [Homebrew/homebrew-cask Maintainer Guide](Homebrew-homebrew-cask-Maintainer-Guide.md) for more details about being a cask maintainer.

These documents are meant to serve as guiding principles. As a maintainer, you can make a call to either request changes from a contributor or help them out based on their comfort and previous contributions. Remember, as a team we [Prioritise Maintainers Over Users](Maintainers-Avoiding-Burnout.md) to avoid burnout. If you wish to change or discuss any of the guidelines: open a PR to suggest a change.

Expand Down

0 comments on commit 9457875

Please sign in to comment.