Merge pull request #7039 from issyl0/depends_on-linux-is-the-linux-formula-identifier

docs: `depends_on :linux` is now the identifier for Linux-only formulae
This commit is contained in:
Issy Long 2020-02-16 11:39:57 +00:00 committed by GitHub
commit 3f654d6aba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -260,13 +260,14 @@ push a bottle commit to Homebrew/linuxbrew-core.
Make a PR to `Homebrew/linuxbrew-core` containing one commit named
like this: `name (new formula)`. Keep only one commit in this PR,
squash and force push to your branch if needed. Include a comment: `#
tag "linux"` in the formula after the `url` stanza, so maintainers can
easily find Linux only formulae.
squash and force push to your branch if needed. Include the line
`depends_on :linux` in the dependencies section, so that maintainers
can easily find Linux-only formulae.
For the bottle commit to be successful when new formulae are added, we
have to insert an empty bottle block into the formula code. This
usually goes after the `linux` tag.
usually goes after the `url` and `sha256` lines, with a blank line in
between.
```ruby
bottle do
@ -351,7 +352,7 @@ correct repository:
### Linux-only formulae
If the formula is a Linux-only formula, it either:
- will contain the line `# tag "linux"`
- will contain the line `depends_on :linux`
- won't have macOS bottles
If the user hasn't used `brew bump-formula-pr`, or is submitting