From: Justin Tobler <jltobler@gmail•com>
To: git@vger•kernel.org
Cc: ps@pks•im, Justin Tobler <jltobler@gmail•com>
Subject: [PATCH] docs: clarify git-rev-list(1) --filter behavior
Date: Mon, 15 Dec 2025 14:05:12 -0600 [thread overview]
Message-ID: <20251215200512.2694155-1-jltobler@gmail.com> (raw)
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
next reply other threads:[~2025-12-15 20:05 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-12-15 20:05 Justin Tobler [this message]
2025-12-16 1:13 ` [PATCH] docs: clarify git-rev-list(1) --filter behavior Junio C Hamano
2025-12-16 8:12 ` Patrick Steinhardt
2025-12-16 14:36 ` Justin Tobler
2025-12-16 14:49 ` Patrick Steinhardt
2025-12-16 18:07 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20251215200512.2694155-1-jltobler@gmail.com \
--to=jltobler@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=ps@pks$(echo .)im \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox