[PATCH] docs: clarify git-rev-list(1) --filter behavior

From: Justin Tobler <jltobler@gmail.com>
Date: Dec 15, 2025, 20:05 UTC
Message-ID: <20251215200512.2694155-1-jltobler@gmail.com>

When using the --filter option for git-rev-list(1), objects that are explicitly provided ignore filters and are always printed unless the --filter-provided-objects option is also specified. Clarify this behavior in the documentation.

Signed-off-by: Justin Tobler <jltobler@gmail.com>
---

Greetings,

This small documentation update is in response to discussion from [1].

Thanks, -Justin

[1]: <aT-djS-TrQJxxV8i@pks.im>

---
 Documentation/rev-list-options.adoc | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/rev-list-options.adoc b/Documentation/rev-list-options.adoc
index d9665d82c8..453ec59057 100644
--- a/Documentation/rev-list-options.adoc
+++ b/Documentation/rev-list-options.adoc
@@ -983,7 +983,9 @@ to name units in KiB, MiB, or GiB.  For example, `blob:limit=1k`
 is the same as 'blob:limit=1024'.
 +
 The form `--filter=object:type=(tag|commit|tree|blob)` omits all objects
-which are not of the requested type.
+which are not of the requested type. Note that explicitly provided objects
+ignore filters and are always printed unless `--filter-provided-objects` is
+also specified.
 +
 The form `--filter=sparse:oid=<blob-ish>` uses a sparse-checkout
 specification contained in the blob (or blob-expression) _<blob-ish>_

base-commit: d8af7cadaa79d5837d73ec949e10b57dedb43e9b

-- 
2.52.0.209.ge85ae279b0