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

Re: [RFC PATCH 0/6] various documentation bits

From
Kenneth Lorber <keni@his.com>
Date
May 18, 2020, 23:44 UTC
Message-ID
<E4B7ABAF-DA2C-4A96-BBCF-4F8F0DB45585@his.com>
In-Reply-To
<xmqqv9ku5rsw.fsf@gitster.c.googlers.com>
Show 33 quoted lines
> On May 17, 2020, at 2:39 PM, Junio C Hamano <gitster@pobox.com> wrote:
> 
> Abhishek Kumar <abhishekkumar8222@gmail.com> writes:
> 
>> Some general notes about your patch series:
>> 
>> 1. Conventionally, we prefix the first line with "area: " where the area
>> is a filename or identifier for general area of the code being modified.
>> It's customary to start the remainder of the first line after "area: "
>> with a lower-case letter.
>> 
>> For example, your commit titles could have been:
>> - doc: tell the glossary about core.hooksPath
>> - doc: add bit on extending git to hacking Git
>> 
>> and so on.
>> 
>> Check out SubmittingPatches for more information.
> 
> Good suggestion.
> 
>> 2. We generally don't have a line like in our patches:
>> 
>>> From Kenneth Lorber <keni@his.com>
>> 
>> Between the author information and the signed-off-by, it's redundant.
> 
> Carefully inspect the e-mail header and in-body header ;-)  
> 
> The author identity must match the identity written for the
> signed-off-by trailer, so the in-body header becomes needed
> when the From: e-mail header does not match the true author,
> like these patches.
Email/git send-email configuration issue.  They should match on v2, if I'm lucky.
Show 9 quoted lines
> 
>> 3. You could probably join the patches 3 to 6 together. Or maybe
>> introduce namespace-collisions.txt in third patch and add
>> references in all other files in a new, fourth patch.
> 
> Perhaps, but I'd rather not to see a rule that hasn't been applied
> even once in the real situation written down like a law.  I'd prefer
> to see us gain experience by interacting tool authors on the list
> and learn what their concerns and pain-points are.
This tool author/git admin went for a patch to discuss.
I assume from the above there has been no interaction before, so at the very least we need a pointer to the list for this topic to cause that interaction to occur.
As I noted in another part of this thread, we can certainly make it less of a law and more of a recommendation or hint.
I listed some of the issues elsewhere; if that isn't quite what you are looking for I can expand on it.
> 
> Thansk.

Thank you, Keni

Previous: Junio C HamanoNext: Kenneth Lorber
Message 21 of 42 in “various documentation bits”
  1. 0/6 various documentation bitsKenneth Lorber, May 17, 2020
  2. 2/6 Add bit on extending git to Hacking GitKenneth Lorber, May 17, 2020
  3. Junio C HamanoMay 17, 2020
  4. Kenneth LorberMay 18, 2020
  5. 1/6 Tell the glossary about core.hooksPathKenneth Lorber, May 17, 2020
  6. Junio C HamanoMay 17, 2020
  7. Kenneth LorberMay 18, 2020
  8. 5/6 Tell config.txt about NAMESPACE COLLISIONSKenneth Lorber, May 17, 2020
  9. Junio C HamanoMay 18, 2020
  10. 4/6 Include NAMESPACE COLLISIONS doc into gitrepository-layout.txtKenneth Lorber, May 17, 2020
  11. Junio C HamanoMay 18, 2020
  12. Kenneth LorberMay 18, 2020
  13. 3/6 Add namespace collision avoidance guidelines fileKenneth Lorber, May 17, 2020
  14. Abhishek KumarMay 17, 2020
  15. Kenneth LorberMay 18, 2020
  16. Junio C HamanoMay 17, 2020
  17. Kenneth LorberMay 18, 2020
  18. 6/6 Add NAMESPACE COLLISIONS reference to Hacking GitKenneth Lorber, May 17, 2020
  19. Abhishek KumarMay 17, 2020
  20. Junio C HamanoMay 17, 2020
  21. Kenneth LorberMay 18, 2020
  22. Kenneth LorberMay 18, 2020
  23. 0/6 various documentation bitsKenneth Lorber, May 25, 2020
  24. 6/6 doc: Add collision reference to Hacking GitKenneth Lorber, May 25, 2020
  25. 2/6 doc: Add bit on extending git to Hacking GitKenneth Lorber, May 25, 2020
  26. 3/6 doc: Add namespace collision guidelines fileKenneth Lorber, May 25, 2020
  27. Junio C HamanoMay 28, 2020
  28. Junio C HamanoMay 28, 2020
  29. Junio C HamanoMay 29, 2020
  30. Junio C HamanoMay 29, 2020
  31. Kenneth LorberJun 1, 2020
  32. Kenneth LorberJun 1, 2020
  33. 4/6 doc: Add collision doc to gitrepository-layout.txtKenneth Lorber, May 25, 2020
  34. 1/6 doc: Tell the glossary about core.hooksPathKenneth Lorber, May 25, 2020
  35. Junio C HamanoMay 26, 2020
  36. Kenneth LorberMay 27, 2020
  37. Kenneth LorberMay 27, 2020
  38. Junio C HamanoMay 27, 2020
  39. 5/6 doc: Tell config.txt about namespace collisionsKenneth Lorber, May 25, 2020
  40. 0/2 update glossary hooks entryKenneth Lorber, May 31, 2020
  41. 1/2 doc: Tell the glossary about core.hooksPathKenneth Lorber, May 31, 2020
  42. 2/2 doc: remove dated info and refs to sample hooksKenneth Lorber, May 31, 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.