From: "Derrick Stolee via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Teng Long <dyroneteng@gmail.com>, Derrick Stolee <dstolee@microsoft.com>
Subject: [PATCH v2 2/3] clone: document --partial and --filter options
Date: Mon, 13 Apr 2020 15:25:59 +0000 [thread overview]
Message-ID: <9baf4c8ba383414e41d3d7726cf40c39cbf197e7.1586791560.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.745.v2.git.git.1586791560.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
next prev parent reply other threads:[~2020-04-13 15:26 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-02 2:02 [PATCH] clone: document partial clone section Teng Long via GitGitGadget
2020-04-02 11:29 ` Derrick Stolee
2020-04-02 17:37 ` Junio C Hamano
2020-04-02 17:52 ` Derrick Stolee
2020-04-13 15:25 ` [PATCH v2 0/3] " Teng Long via GitGitGadget
2020-04-13 15:25 ` [PATCH v2 1/3] partial-clone: set default filter with --partial Derrick Stolee via GitGitGadget
2020-04-13 15:25 ` Derrick Stolee via GitGitGadget [this message]
2020-04-13 15:26 ` [PATCH v2 3/3] clone: document partial clone section Dyrone Teng via GitGitGadget
2020-10-27 13:41 ` Philippe Blain
2020-04-13 22:45 ` [PATCH v2 0/3] " Junio C Hamano
2020-04-14 13:43 ` Derrick Stolee
2020-04-14 16:25 ` Junio C Hamano
2020-04-14 16:26 ` Derrick Stolee
2020-04-14 13:42 ` Derrick Stolee
2020-10-27 3:12 ` [PATCH v3] " Teng Long via GitGitGadget
2020-10-27 13:13 ` Philippe Blain
2020-10-27 18:51 ` Junio C Hamano
2021-02-25 9:13 ` [PATCH v4] " Teng Long via GitGitGadget
2021-02-25 13:38 ` Philippe Blain
2021-03-02 14:25 ` [PATCH v5] " Teng Long via GitGitGadget
2021-03-03 19:25 ` Junio C Hamano
2021-05-06 6:27 ` Fix inconsistent signed-off-by abd author name Teng Long
2021-05-06 6:30 ` [PATCH 1/1] clone: document partial clone section Teng Long
2021-05-07 4:00 ` Bagas Sanjaya
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=9baf4c8ba383414e41d3d7726cf40c39cbf197e7.1586791560.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=dstolee@microsoft.com \
--cc=dyroneteng@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).