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

Re: [PATCH v2 1/5] MyFirstContribution: add "Anatomy of a Patch Series" section

From
Philippe Blain <levraiphilippeblain@gmail.com>
Date
May 11, 2022, 21:48 UTC
Message-ID
<9e766e57-3b6c-494e-84b6-406a91ccf6ea@gmail.com>
In-Reply-To
<xmqqh75viwoo.fsf@gitster.g>
Hi Bagas and Junio,
Le 2022-05-11 à 17:30, Junio C Hamano a écrit :
Show 33 quoted lines
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
>> On Wed, May 11, 2022 at 01:47:30AM +0000, Philippe Blain via GitGitGadget wrote:
>>> +We can note a few things:
>>> +
>>> +- Each commit is sent as a separate email, with the commit message title as
>>> +  subject, prefixed with "[PATCH _i_/_n_]" for the _i_-th commit of an
>>> +  _n_-commit series.
>>> +- Each patch is sent as a reply to an introductory email called the _cover
>>> +  letter_ of the series, prefixed "[PATCH 0/_n_]".
>>> +- Subsequent iterations of the patch series are labelled "[PATCH v2]", "[PATCH
>>> +  v3]", etc. and sent with a new cover letter, itself a reply to the cover
>>> +  letter of the previous iteration (more on that below).
>>> +
>>> +At this point the tutorial diverges, in order to demonstrate two
>>>  different methods of formatting your patchset and getting it reviewed.
>>>
>>
>> In case of single-patch series submissions, the anatomy is simple: first
>> the email subject is commit message title prefixed with "[PATCH]" or
>> "[PATCH v_n_]" (in case of n-th iteration), then commit message and the
>> actual diff.
> 
> Correct.  There is no single-patch topic in the summary view shown
> in the document, so it does not belong to the above "We can note a
> few things" list.  But I agree that there should be a mention for a
> single-patch topic somewhere in this document, both for a patch and
> (the usual lack of) cover-letter for such a topic.
> 
> The sample topic this tutorial uses is a multi-patch series and
> everything in the document revolves around handing a multi-patch
> series, so finding a good place to fit it may be a bit tricky,
> though.

There is already a small section on single-patch topics, at the end of the 'git send-email' section [1]. And I add a link to it in the GGG section in patch 5/5.

[1] https://git-scm.com/docs/MyFirstContribution#single-patch
Show 16 quoted lines
>> Regarding n-th iteration series, sometimes it is desirable to break the
>> threading so that the original thread (of previous iterations) doesn't
>> get too long, by sending the series as completely new thread. Some
>> contributors (including myself) prefer that way. In that case, the link
>> to previous iteration is provided to aid reviewers.
> 
> This is often not very friendly to reviewers, unless the "new topic"
> is so different that it is almost totally unrelated to the old one.
> 
> Even in a "in earlier round, we perceived X as a problem and tried
> to solve it, but it turns out it is better to solve Y instead" case,
> it often helps to learn the reason why we ended up not addressing X
> after you use "git blame" to find a commit that solved Y in a later
> iteration and wonder why an approach to solve X was not taken.  It
> is a very good idea to mention the need to add a link to a previous
> thread if the submitter decides to break the thread.

Thanks for confirming. I think for a beginner tutorial like MyFirstContribution, we should keep things simple, so I would leave the content as-is regarding threading. If we ever revive the "mailing list etiquette" series, then I think we could add notes regarding this kind of things.

Cheers, Philippe.

Previous: Junio C HamanoNext: Junio C Hamano
Message 20 of 43 in “Improve MyFirstContribution's GitGitGadget section”
  1. 0/3 Improve MyFirstContribution's GitGitGadget sectionPhilippe Blain via GitGitGadget, Apr 27, 2022
  2. 3/3 MyFirstContribution: drop PR description for GGG single-patch contributionsPhilippe Blain via GitGitGadget, Apr 27, 2022
  3. Junio C HamanoApr 27, 2022
  4. Philippe BlainApr 28, 2022
  5. Junio C HamanoApr 28, 2022
  6. 2/3 MyFirstContribution: also explain cover letter in GitGitGadget sectionPhilippe Blain via GitGitGadget, Apr 27, 2022
  7. Victoria DyeApr 27, 2022
  8. Philippe BlainApr 28, 2022
  9. Victoria DyeApr 29, 2022
  10. Philippe BlainMay 10, 2022
  11. 1/3 MyFirstContribution: move cover letter description to a separate filePhilippe Blain via GitGitGadget, Apr 27, 2022
  12. Eric SunshineApr 27, 2022
  13. Philippe BlainApr 27, 2022
  14. Junio C HamanoApr 27, 2022
  15. Philippe BlainApr 28, 2022
  16. 0/5 Improve MyFirstContribution's GitGitGadget sectionPhilippe Blain via GitGitGadget, May 11, 2022
  17. 1/5 MyFirstContribution: add "Anatomy of a Patch Series" sectionPhilippe Blain via GitGitGadget, May 11, 2022
  18. Bagas SanjayaMay 11, 2022
  19. Junio C HamanoMay 11, 2022
  20. Philippe BlainMay 11, 2022
  21. Junio C HamanoMay 11, 2022
  22. Philippe BlainMay 12, 2022
  23. Philip OakleyMay 12, 2022
  24. Philippe BlainMay 12, 2022
  25. 2/5 MyFirstContribution: add standalone section on cover letterPhilippe Blain via GitGitGadget, May 11, 2022
  26. Junio C HamanoMay 11, 2022
  27. Philippe BlainMay 11, 2022
  28. 3/5 MyFirstContribution: reference "The cover letter" in "Preparing Email"Philippe Blain via GitGitGadget, May 11, 2022
  29. 5/5 MyFirstContribution: drop PR description for GGG single-patch contributionsPhilippe Blain via GitGitGadget, May 11, 2022
  30. 4/5 MyFirstContribution: reference "The cover letter" in GitGitGadget sectionPhilippe Blain via GitGitGadget, May 11, 2022
  31. Junio C HamanoMay 11, 2022
  32. Victoria DyeMay 11, 2022
  33. 0/5 Improve MyFirstContribution's GitGitGadget sectionPhilippe Blain via GitGitGadget, May 12, 2022
  34. 3/5 MyFirstContribution: reference "The cover letter" in "Preparing Email"Philippe Blain via GitGitGadget, May 12, 2022
  35. 1/5 MyFirstContribution: add "Anatomy of a Patch Series" sectionPhilippe Blain via GitGitGadget, May 12, 2022
  36. 5/5 MyFirstContribution: drop PR description for GGG single-patch contributionsPhilippe Blain via GitGitGadget, May 12, 2022
  37. 4/5 MyFirstContribution: reference "The cover letter" in GitGitGadget sectionPhilippe Blain via GitGitGadget, May 12, 2022
  38. 2/5 MyFirstContribution: add standalone section on cover letterPhilippe Blain via GitGitGadget, May 12, 2022
  39. Junio C HamanoMay 19, 2022
  40. Philippe BlainMay 21, 2022
  41. Junio C HamanoMay 22, 2022
  42. Philippe BlainMay 24, 2022
  43. Junio C HamanoMay 24, 2022

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.