Merge pull request #7710 from Lekensteyn/clarify-tap-docs

docs: clarify Formula location in Tap repositories
This commit is contained in:
Mike McQuaid 2020-06-12 10:46:53 +01:00 committed by GitHub
commit c989011325
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

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 The `brew tap-new` command can be used to create a new tap along with some
template files. template files.
Tap formulae follow the same format as the cores ones, and can be added at the Tap formulae follow the same format as the cores ones, and can be added under
repositorys root, or under `Formula` or `HomebrewFormula` subdirectories. We either the `Formula` subdirectory, the `HomebrewFormula` subdirectory or the
recommend the latter options because it makes the repository organisation repositorys root. The first available directory is used, other locations will
easier to grasp, and top-level files are not mixed with formulae. 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 See [homebrew/core](https://github.com/Homebrew/homebrew-core) for an example of
a tap with a `Formula` subdirectory. a tap with a `Formula` subdirectory.