git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Shourya Shukla <shouryashukla.oo@gmail.com>
Cc: git@vger.kernel.org, newren@gmail.com,
	sandals@crustytoothpaste.net,
	Christian Couder <christian.couder@gmail.com>,
	Derrick Stolee <dstolee@microsoft.com>,
	Jonathan Tan <jonathantanmy@google.com>
Subject: Re: [PATCH v4 3/4] gitfaq: shallow cloning a repository
Date: Wed, 29 Apr 2020 10:09:44 -0700	[thread overview]
Message-ID: <xmqq7dxyxlpj.fsf@gitster.c.googlers.com> (raw)
In-Reply-To: <20200429093811.8475-3-shouryashukla.oo@gmail.com> (Shourya Shukla's message of "Wed, 29 Apr 2020 15:08:10 +0530")

Shourya Shukla <shouryashukla.oo@gmail.com> writes:

> Add issue in 'Common issue' section which covers issues with cloning
> large repositories. Use partial cloning to selectively clone the
> repository.
>
> Signed-off-by: Shourya Shukla <shouryashukla.oo@gmail.com>
> ---
> I wanted to ask why is there no mention of partial cloning in
> the 'git-clone' documentation? Is it because it is an experimental
> feature?

If the folks that have been pushing the feature haven't bothered to
document it fully, by definition, it must be a work in progress that
is not ready for the prime time ;-)

Jokes aside, the --filter=<filter-spec> option is mentioned in the
documentation and it says "...is used for the partial clone filter",
without even defining what a "partial clone filter" really is.

The topic deserves its own subsection, between the "Git URLs" and
the "Examples" sections, in git-clone(1).

>  Documentation/gitfaq.txt | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/Documentation/gitfaq.txt b/Documentation/gitfaq.txt
> index 7d294306f9..6f32846e3d 100644
> --- a/Documentation/gitfaq.txt
> +++ b/Documentation/gitfaq.txt
> @@ -243,6 +243,16 @@ I want to change the remote of my repository. How do I do that?::
>  One can list the remotes of a repository using `git remote -v` command.
>  The default name of a remote is 'origin'.
>  
> +[[shallow-cloning]]
> +The repository I am trying to clone is too big. Is there an alternative
> +way of cloning it in lesser space?::
> +	A good way to save up space when cloning a repository is
> +	by using `partial clones`. A partial clone will clone the
> +	full history of the repository but will skip out the entities
> +	specified by the `--filter` option one uses in `git clone`.
> +	Any entity which has not been cloned to save space can be cloned
> +	on-demand. See linkgit:partial-clone[1].

Where does this link go?

  parent reply	other threads:[~2020-04-29 17:10 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-29  9:38 [PATCH v4 1/4] gitfaq: files in .gitignore are tracked Shourya Shukla
2020-04-29  9:38 ` [PATCH v4 2/4] gitfaq: changing the remote of a repository Shourya Shukla
2020-04-29 16:17   ` Elijah Newren
2020-04-29 17:01   ` Junio C Hamano
2020-04-29  9:38 ` [PATCH v4 3/4] gitfaq: shallow cloning " Shourya Shukla
2020-04-29 16:00   ` Elijah Newren
2020-05-02  5:00     ` Shourya Shukla
2020-04-29 17:09   ` Junio C Hamano [this message]
2020-05-02  6:13     ` Shourya Shukla
2020-05-04 16:06       ` Junio C Hamano
2020-05-05 12:26         ` Derrick Stolee
2021-05-06  2:49           ` dyrone teng
2020-04-29  9:38 ` [PATCH v4 4/4] gitfaq: fetching and pulling " Shourya Shukla
2020-04-29 15:56   ` Elijah Newren
2020-04-29 17:19     ` Junio C Hamano
2020-05-02  6:57     ` Shourya Shukla
2020-05-02 19:00       ` Elijah Newren
2020-05-03  1:03         ` Junio C Hamano
2020-04-29 16:16 ` [PATCH v4 1/4] gitfaq: files in .gitignore are tracked Elijah Newren
2020-05-02  6:36   ` Shourya Shukla
2020-04-29 16:55 ` Junio C Hamano

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=xmqq7dxyxlpj.fsf@gitster.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=christian.couder@gmail.com \
    --cc=dstolee@microsoft.com \
    --cc=git@vger.kernel.org \
    --cc=jonathantanmy@google.com \
    --cc=newren@gmail.com \
    --cc=sandals@crustytoothpaste.net \
    --cc=shouryashukla.oo@gmail.com \
    /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).