From: Derrick Stolee via GitGitGadget Date: Mon, 13 Apr 2020 15:25:59 GMT Subject: [PATCH v2 2/3] clone: document --partial and --filter options Message-ID: <9baf4c8ba383414e41d3d7726cf40c39cbf197e7.1586791560.git.gitgitgadget@gmail.com> In-Reply-To: From: Derrick Stolee The previous change added the "--partial[=]" option to "git clone" equivalent to "--filter=blob:none" or "--filter=blob:limit=" but did not document that addition. It turns out that the "--filter=" option was not documented anywhere in the "git clone" page, and instead is detailed carefully in "git rev-list" where it serves a different purpose. Add a small bit about these options in the documentation. It would be worth some time to create a subsection in the "git clone" documentation about partial clone as a concept and how it can be a surprising experience. For example, "git checkout" will likely trigger a pack download. Signed-off-by: Derrick Stolee --- Documentation/git-clone.txt | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index bf24f1813ad..eafa1c39927 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -15,7 +15,8 @@ SYNOPSIS [--dissociate] [--separate-git-dir ] [--depth ] [--[no-]single-branch] [--no-tags] [--recurse-submodules[=]] [--[no-]shallow-submodules] - [--[no-]remote-submodules] [--jobs ] [--sparse] [--] + [--[no-]remote-submodules] [--jobs ] [--sparse] + [--partial[=]|--filter=] [--] [] DESCRIPTION @@ -162,6 +163,18 @@ 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. +--partial[=]:: +--filter=:: + 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 `` is used for + the partial clone filter. When using `--partial` with no ``, + the `blob:none` filter is applied to filter all blobs. When using + `--partial=` the `blob:limit=` filter is applied to + filter all blobs with size larger than ``. 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 -- gitgitgadget