summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2020-04-22 13:42:42 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2020-04-22 13:42:42 -0700
commitfa0c1eb45170d3e4b80eb6805f9466baf1eef1fd (patch)
treeed2b2f766d699bebb9068861bcffdf9b56a25915 /Documentation
parentMerge branch 'ar/test-style-fixes' (diff)
parentclone: document --filter options (diff)
downloadtgif-fa0c1eb45170d3e4b80eb6805f9466baf1eef1fd.tar.xz
Merge branch 'ds/doc-clone-filter'
Doc update. * ds/doc-clone-filter: clone: document --filter options
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-clone.txt13
1 files changed, 12 insertions, 1 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index bf24f1813a..08d6045c4a 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -15,7 +15,8 @@ SYNOPSIS
[--dissociate] [--separate-git-dir <git dir>]
[--depth <depth>] [--[no-]single-branch] [--no-tags]
[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
- [--[no-]remote-submodules] [--jobs <n>] [--sparse] [--] <repository>
+ [--[no-]remote-submodules] [--jobs <n>] [--sparse]
+ [--filter=<filter>] [--] <repository>
[<directory>]
DESCRIPTION
@@ -162,6 +163,16 @@ objects from the source repository into a pack in the cloned repository.
of the repository. The sparse-checkout file can be
modified to grow the working directory as needed.
+--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 clone filter. 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].
+
--mirror::
Set up a mirror of the source repository. This implies `--bare`.
Compared to `--bare`, `--mirror` not only maps local branches of the