From 89bd6a76ee6983768dbceb2a41c59264eb6b29fc Mon Sep 17 00:00:00 2001 From: Peter Wu Date: Tue, 9 Jun 2020 09:52:00 +0200 Subject: [PATCH] docs: clarify Formula location in Tap repositories 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 --- docs/How-to-Create-and-Maintain-a-Tap.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/How-to-Create-and-Maintain-a-Tap.md b/docs/How-to-Create-and-Maintain-a-Tap.md index 63a08a87c2..3bfd2fc555 100644 --- a/docs/How-to-Create-and-Maintain-a-Tap.md +++ b/docs/How-to-Create-and-Maintain-a-Tap.md @@ -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.