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

Re: [PATCH V5 2/2] user-manual: add section documenting shallow clones

From
Junio C Hamano <gitster@pobox.com>
Date
Dec 29, 2015, 23:12 UTC
Message-ID
<xmqqd1tog88a.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<4187709.UG5bg1kMPP@thunderbird>
Stephen & Linda Smith <ischis2@cox.net> writes:
Show 16 quoted lines
> On Tuesday, December 29, 2015 11:24:00 AM Junio C Hamano wrote:
>> "Stephen P. Smith" <ischis2@cox.net> writes:
>> 
>> > Rather than merely pointing readers at the 1.5 release notes to
>> > learn about shallow clones, document them formally.
>> >
>> > Signed-off-by: Stephen P. Smith <ischis2@cox.net>
>> > ---
>> 
>> Thanks.  I do not think the reference to RelNotes were meant for the
>> end-user readers, though.  That was a hint for whoever is working to
>> clear the "todo" items from that list i.e. you ;-> ).
>
> Actually that was a suggested update[1].   Do you still think I should replace it?
>
> [1] http://article.gmane.org/gmane.comp.version-control.git/282831
Sorry, but I am not sure what you mean by "it".

If you mean "replace the proposed log message", yes, I do. The way I read "Document X? See Y" in the "todo" section is that it is a hint for later contributors that X might be worth documenting, and whoever wants to do so should look at Y while working on it. It is not at all telling the readers of the docuement to go read Y.

This commit follows through a "todo" item and what it did is sufficiently described by its title. I did not think there is anything to add in the body of the message, and I found what was there more confusing than enlightening, because the document wasn't even pointing readers at the 1.5 Release Notes.

Thanks for working on this. Perhaps the last paragraph can be like this?

    Merging inside a <<def_shallow_clone,shallow clone>> will work
    as long as a merge base is found in the resent history.
    Otherwise, it will be like merging unrelated histories and may
    have to result in huge conflicts.  This limitation may make such
    a repository unsuitable to be used in merge based workflows.
Previous: Stephen & Linda SmithNext: Stephen P. Smith
Message 14 of 22 in “Define the term shallow clone.”
  1. 1/2 Define the term shallow clone.Stephen P. Smith, Dec 22, 2015
  2. 2/2 Add a section to the users manual documenting shallow clones.Stephen P. Smith, Dec 22, 2015
  3. Eric SunshineDec 22, 2015
  4. 2/2 user-manual: add section documenting shallow clonesStephen P. Smith, Dec 22, 2015
  5. Stephen & Linda SmithDec 23, 2015
  6. 2/2 user-manual: add section documenting shallow clonesStephen P. Smith, Dec 23, 2015
  7. Eric SunshineDec 23, 2015
  8. 2/2 user-manual: add section documenting shallow clonesStephen P. Smith, Dec 23, 2015
  9. Junio C HamanoDec 28, 2015
  10. 1/2 glossary: define the term shallow cloneStephen P. Smith, Dec 29, 2015
  11. 2/2 user-manual: add section documenting shallow clonesStephen P. Smith, Dec 29, 2015
  12. Junio C HamanoDec 29, 2015
  13. Stephen & Linda SmithDec 29, 2015
  14. Junio C HamanoDec 29, 2015
  15. 2/2 user-manual: add section documenting shallow clonesStephen P. Smith, Dec 29, 2015
  16. Junio C HamanoDec 29, 2015
  17. 2/2 user-manual: add section documenting shallow clonesStephen P. Smith, Dec 30, 2015
  18. Stephen & Linda SmithDec 29, 2015
  19. Stephen & Linda SmithDec 22, 2015
  20. Eric SunshineDec 22, 2015
  21. 1/2 glossary: define the term shallow cloneStephen P. Smith, Dec 22, 2015
  22. 1/2 glossary: define the term shallow cloneStephen P. Smith, Dec 23, 2015

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.