[PATCH 2/9] for-each-ref: clarify interaction of --omit-empty & --count

From: Victoria Dye via GitGitGadget <gitgitgadget@gmail.com>
Date: Nov 7, 2023, 01:25 UTC
Message-ID: <88eba4146cd250fcabfb9ffa9b410ce912a82ce7.1699320362.git.gitgitgadget@gmail.com>
In-Reply-To: <pull.1609.git.1699320361.gitgitgadget@gmail.com>

From: Victoria Dye <vdye@github.com>

Update the 'for-each-ref' builtin documentation to clarify that refs "omitted" by --omit-empty are still counted toward the limit specified by --count. The use of the term "omit" would otherwise be somewhat ambiguous and could incorrectly be construed as excluding empty refs entirely (i.e. not counting them towards the total ref count).

Signed-off-by: Victoria Dye <vdye@github.com>
---
 Documentation/git-for-each-ref.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index e86d5700ddf..407f624fbaa 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -101,7 +101,8 @@ OPTIONS
 
 --omit-empty::
 	Do not print a newline after formatted refs where the format expands
-	to the empty string.
+	to the empty string. Although omitted refs are not shown in the output,
+	they still count toward the total limited by `--count`.
 
 --exclude=<pattern>::
 	If one or more patterns are given, only refs which do not match

-- 
gitgitgadget