mirrors/brew
1
0
Fork 0
mirror of https://github.com/Homebrew/brew.git synced 2025-07-14 16:09:03 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: clarify Formula location in Tap repositories

Browse Source 
Make clear that Formula locations cannot be mixed, they are mutually
exclusive. This avoids the (false) implication that top-level Formula
can override those in the Formula subdirectory.

This makes no change in recommendations following the original
discussion in https://github.com/Homebrew/legacy-homebrew/pull/41858
This commit is contained in:
Peter Wu 2020-06-09 09:52:00 +02:00
parent a81e1d1fa8
commit 89bd6a76ee
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -16,10 +16,11 @@ See the [manpage](Manpage.md) for more information on repository naming.
The `brew tap-new` command can be used to create a new tap along with some
template files.
Tap formulae follow the same format as the core’s ones, and can be added at the
repository’s root, or under `Formula` or `HomebrewFormula` subdirectories. We
recommend the latter options because it makes the repository organisation
easier to grasp, and top-level files are not mixed with formulae.
Tap formulae follow the same format as the core’s ones, and can be added under
either the `Formula` subdirectory, the `HomebrewFormula` subdirectory or the
repository’s root. The first available directory is used, other locations will
be ignored. We recommend use of subdirectories because it makes the repository
organisation easier to grasp, and top-level files are not mixed with formulae.
See [homebrew/core](https://github.com/Homebrew/homebrew-core) for an example of
a tap with a `Formula` subdirectory.