Re: [PATCH v4 3/4] gitfaq: shallow cloning a repository

[Shourya Shukla <shouryashukla.oo@gmail.com>]

On 29/04 10:09, Junio C Hamano wrote:
> > ---
> > 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).

May I try to add it? If yes then are there any points to be kept in mind
while writing this part (for eg., length of the subsection, writing
style, what all is to be written etc.)?
> 
> >  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?

Actually I intended to link to this page:
https://git-scm.com/docs/partial-clone

Do we link such pages in a manner different from linking command
documentations? Also, lets say I want to link this section using
gitlink:
https://git-scm.com/docs/git-clone#_git_urls

Do we change the number in 'linkgit:git-clone[n]'? If yes, then how do
we decide that number?