aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Couder <christian.couder@gmail.com>2026-02-16 14:23:11 +0100
committerJunio C Hamano <gitster@pobox.com>2026-02-17 11:46:40 -0800
commit190438b62fa5624077c2ee48065f47e1a56d01a7 (patch)
tree65fdb330f9190ce97036bd22859205111fa1a879
parentf7565410e1f803873c097258109ff0258ad913fc (diff)
downloadgit-190438b62fa5624077c2ee48065f47e1a56d01a7.tar.xz
doc: fetch: document `--filter=<filter-spec>` option
The `--filter=<filter-spec>` option is documented in most commands that support it except `git fetch`. Let's fix that and document this option. To ensure consistency across commands, let's reuse the exact description currently found in `git clone`. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/fetch-options.adoc10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/fetch-options.adoc b/Documentation/fetch-options.adoc
index fcba46ee9e..1ef9807d00 100644
--- a/Documentation/fetch-options.adoc
+++ b/Documentation/fetch-options.adoc
@@ -88,6 +88,16 @@ linkgit:git-config[1].
This is incompatible with `--recurse-submodules=(yes|on-demand)` and takes
precedence over the `fetch.output` config option.
+`--filter=<filter-spec>`::
+ Use the partial clone feature and request that the server sends
+ a subset of reachable objects according to a given object filter.
+ When using `--filter`, the supplied _<filter-spec>_ is used for
+ the partial fetch. For example, `--filter=blob:none` will filter
+ out all blobs (file contents) until needed by Git. Also,
+ `--filter=blob:limit=<size>` will filter out all blobs of size
+ at least _<size>_. For more details on filter specifications, see
+ the `--filter` option in linkgit:git-rev-list[1].
+
ifndef::git-pull[]
`--write-fetch-head`::
`--no-write-fetch-head`::