git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Shourya Shukla <shouryashukla.oo@gmail.com>
Date
May 2, 2020, 06:13 UTC
Message-ID
<20200502061355.GB5582@konoha>
In-Reply-To
<xmqq7dxyxlpj.fsf@gitster.c.googlers.com>
On 29/04 10:09, Junio C Hamano wrote:
Show 15 quoted lines
> > ---
> > 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.)?

Show 23 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?

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?

Previous: Junio C HamanoNext: Junio C Hamano
Message 9 of 21 in “gitfaq: files in .gitignore are tracked”
  1. 1/4 gitfaq: files in .gitignore are trackedShourya Shukla, Apr 29, 2020
  2. 2/4 gitfaq: changing the remote of a repositoryShourya Shukla, Apr 29, 2020
  3. Elijah NewrenApr 29, 2020
  4. Junio C HamanoApr 29, 2020
  5. 3/4 gitfaq: shallow cloning a repositoryShourya Shukla, Apr 29, 2020
  6. Elijah NewrenApr 29, 2020
  7. Shourya ShuklaMay 2, 2020
  8. Junio C HamanoApr 29, 2020
  9. Shourya ShuklaMay 2, 2020
  10. Junio C HamanoMay 4, 2020
  11. Derrick StoleeMay 5, 2020
  12. dyrone tengMay 6, 2021
  13. 4/4 gitfaq: fetching and pulling a repositoryShourya Shukla, Apr 29, 2020
  14. Elijah NewrenApr 29, 2020
  15. Junio C HamanoApr 29, 2020
  16. Shourya ShuklaMay 2, 2020
  17. Elijah NewrenMay 2, 2020
  18. Junio C HamanoMay 3, 2020
  19. Elijah NewrenApr 29, 2020
  20. Shourya ShuklaMay 2, 2020
  21. Junio C HamanoApr 29, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.