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

docs/How-to-Create-and-Maintain-a-Tap: official vendor taps.

Browse Source 
Explain our policies around "Official Vendor Taps" and clarify the
formulae naming section.

Inspired by discussion in
https://discourse.brew.sh/t/maintenance-of-formulas-by-vendor/7649/.
This commit is contained in:
Mike McQuaid 2020-05-10 14:15:27 +01:00
parent 7bd454746e
commit 4cdc2a5c81
No known key found for this signature in database
GPG Key ID: 48A898132FD8EE70
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/How-to-Create-and-Maintain-a-Tap.md
View File

@ -26,7 +26,7 @@ a tap with a `Formula` subdirectory.
## Naming your formulae to avoid clashes
If your formulae have the same name as Homebrew/homebrew-core formulae they cannot be installed side-by-side. If you wish to create a different version of a formula that's in Homebrew/homebrew-core (e.g. with `option`s) consider giving it a different name e.g. `nginx-full` for more fully-featured `nginx` formula. This will allow both `nginx` and `nginx-full` to be installed at the same time (but not linked if there are conflicts and one of them is not declared to be `keg_only`).
If your formulae have the same name as Homebrew/homebrew-core formulae they cannot be installed side-by-side. If you wish to create a different version of a formula that's in Homebrew/homebrew-core (e.g. with `option`s) consider giving it a different name e.g. `nginx-full` for more fully-featured `nginx` formula. This will allow both `nginx` and `nginx-full` to be installed at the same time (assuming one is `keg_only` or the linked files do not clash).
### Installing
@ -81,3 +81,11 @@ You can provide your tap users with custom `brew` commands by adding them in a
See [homebrew/aliases](https://github.com/Homebrew/homebrew-aliases) for an
example of a tap with external commands.
## Official Vendor Taps
Some upstream software providers like to package their software in their own Homebrew tap. When their software is [eligible for Homebrew/homebrew-core](Acceptable-Formulae.md) we prefer to maintain software there for ease of updates, improved discoverability and use of tools such as [formulae.brew.sh](https://formulae.brew.sh).
We are not willing to remove software packaged in Homebrew/homebrew-core in favour of an upstream tap. We are not willing to instruct users in our formulae to use your formulae instead. If upstream projects have issues with how Homebrew packages your software: please file issues (or, ideally, pull requests) to address these problems.
There’s an increasing desire in commercial open source about “maintaining control” e.g. defining exactly what binaries are shipping to users. Not supporting users (or even software distributions) to build-from-source is antithetical to the values of open source. If you think Homebrew's perspective is annoying on this: try and see how Debian responds to requests to ship your binaries.