aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEricFromCanada2017-07-24 21:28:29 -0400
committerEricFromCanada2017-07-24 21:28:29 -0400
commitb4127ee84b42569cc58c4ce0335058b5cb85dae6 (patch)
tree8f83126117ddf77c2220d4f0366f63f48b6b2fd5
parentaa8eb21b8c650a2d0a5a060ff27507da60a17bee (diff)
downloadbrew-b4127ee84b42569cc58c4ce0335058b5cb85dae6.tar.bz2
docs: update guidelines for duplicates
As per #2873, duplicate and versioned formulae are fine if done right.
-rw-r--r--docs/Formula-Cookbook.md2
-rw-r--r--docs/Maintainer-Guidelines.md25
-rw-r--r--docs/brew-tap.md2
3 files changed, 4 insertions, 25 deletions
diff --git a/docs/Formula-Cookbook.md b/docs/Formula-Cookbook.md
index 38874ddb0..1d4f37f67 100644
--- a/docs/Formula-Cookbook.md
+++ b/docs/Formula-Cookbook.md
@@ -124,8 +124,6 @@ to locate our OpenSSL. You can see this mechanism in the
formula. Usually this is unnecessary because Homebrew sets up our [build environment](https://github.com/Homebrew/brew/blob/fb3bec8d70d375a97554d4c3fed82ad2332b2191/Library/Homebrew/extend/ENV/super.rb)
to favour finding `keg_only` formulae first.
-Homebrew maintains a special [tap that provides other useful system duplicates](https://github.com/Homebrew/homebrew-dupes).
-
*Important:* `$(brew --prefix)/bin` is NOT on the `PATH` during formula installation. If you have dependencies at build time, you must specify them and `brew` will add them to the `PATH` or create a [`Requirement`](http://www.rubydoc.info/github/Homebrew/brew/master/Requirement).
### Specifying other formulae as dependencies
diff --git a/docs/Maintainer-Guidelines.md b/docs/Maintainer-Guidelines.md
index f796e2e96..1d69f5381 100644
--- a/docs/Maintainer-Guidelines.md
+++ b/docs/Maintainer-Guidelines.md
@@ -12,7 +12,7 @@ Maybe you were looking for the [Formula Cookbook](Formula-Cookbook.md)?
This is all that really matters:
- Ensure the name seems reasonable.
- Add aliases.
-- Ensure it is not an unreasonable dupe of anything that comes with macOS.
+- Ensure it uses `keg_only :provided_by_macos` if it already comes with macOS.
- Ensure it is not a library that can be installed with
[gem](https://en.wikipedia.org/wiki/RubyGems),
[cpan](https://en.wikipedia.org/wiki/Cpan) or
@@ -45,12 +45,7 @@ Add other names as aliases as symlinks in `Aliases` in the tap root. Ensure the
name referenced on the homepage is one of these, as it may be different and have
underscores and hyphens and so on.
-We mostly don’t allow versions in formula names (e.g. `bash4.rb`); these should
-be in the `homebrew/versions` tap. (`python3.rb` is a rare exception, because it’s
-basically a “new” language and installs no conflicting executables.)
-
-For now, if someone submits a formula like this, we’ll leave them in
-their own tree.
+We now accept versioned formulae as long as they [meet the requirements](Versions.md).
### Merging, rebasing, cherry-picking
Merging should be done in the `Homebrew/brew` repository to preserve history & GPG commit signing,
@@ -92,21 +87,7 @@ implemented!).
report and link to the commit
### Duplicates
-The main repository avoids duplicates as much as possible. The exception is
-libraries that macOS provides but have bugs, and the bugs are fixed in a
-newer version. Or libraries that macOS provides, but they are too old for
-some other formula. The rest should be in the `homebrew/dupes` tap.
-
-Still determine if it's possible to avoid the duplicate. Be thorough. Duped
-libraries and tools cause bugs that are tricky to solve. Once the formula is
-pulled, we can’t go back on that willy-nilly.
-
-If it duplicates anything ask another maintainer first. Some dupes are okay,
-some can cause subtle issues we don’t want to have to deal with in the future.
-
-Dupes we have allowed:
-- `libxml` \<— macOS version is old and buggy
-- `libpng` \<— Ditto
+We now accept stuff that comes with macOS as long as it uses `keg_only :provided_by_macos` to be keg-only by default.
### Add comments
It may be enough to refer to an issue ticket, but make sure changes are clear so that
diff --git a/docs/brew-tap.md b/docs/brew-tap.md
index de1c883ec..126ee11c2 100644
--- a/docs/brew-tap.md
+++ b/docs/brew-tap.md
@@ -11,7 +11,7 @@ but the command isn't limited to any one location.
```sh
$ brew tap
-homebrew/dupes
+homebrew/core
mistydemeo/tigerbrew
edavis/emacs
```