Re: [PATCH v4 3/4] gitfaq: shallow cloning a repository
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Apr 29, 2020, 17:09 UTC
- Message-ID
- <xmqq7dxyxlpj.fsf@gitster.c.googlers.com>
- In-Reply-To
- <20200429093811.8475-3-shouryashukla.oo@gmail.com>
Shourya Shukla <shouryashukla.oo@gmail.com> writes:
Show 9 quoted lines
> 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).
Show 20 quoted lines
> 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?