[PATCH 2/2] clone: document --partial and --filter options
- From
Derrick Stolee via GitGitGadget <gitgitgadget@gmail.com>
- Date
- Mar 19, 2020, 17:28 UTC
- Message-ID
- <9baf4c8ba383414e41d3d7726cf40c39cbf197e7.1584638887.git.gitgitgadget@gmail.com>
- In-Reply-To
- <pull.586.git.1584638887.gitgitgadget@gmail.com>
From: Derrick Stolee <dstolee@microsoft.com>
The previous change added the "--partial[=<size>]" option to "git clone" equivalent to "--filter=blob:none" or "--filter=blob:limit=<size>" but did not document that addition. It turns out that the "--filter=<filter-spec>" 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 <dstolee@microsoft.com> --- 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 <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] + [--partial[=<size>]|--filter=<filter>] [--] <repository> [<directory>] 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[=<size>]:: +--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. When using `--partial` with no `<size>`, + the `blob:none` filter is applied to filter all blobs. When using + `--partial=<size>` the `blob:limit=<size>` filter is applied to + filter all blobs with size larger than `<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
-- gitgitgadget