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

Re: [PATCH 1/3] MyFirstContribution: move cover letter description to a separate file

From
Philippe Blain <levraiphilippeblain@gmail.com>
Date
Apr 28, 2022, 18:16 UTC
Message-ID
<706e34fb-fb0c-e86d-5d0f-0bd052566b3a@gmail.com>
In-Reply-To
<xmqqr15ijiyt.fsf@gitster.g>
Hi Junio,
Le 2022-04-27 à 17:48, Junio C Hamano a écrit :
Show 32 quoted lines
> "Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:
> 
>> From: Philippe Blain <levraiphilippeblain@gmail.com>
>>
>> In a subsequent commit we want to reuse the explanation of the purpose of
>> The cover letter form the "Sending Patches with git send-email" section
>> in the "Sending Patches via GitGitGadget" section.
>>
>> To avoid text duplication, move this explanation to a separate file and
>> include it in MyFirstContribution.txt.
>>
>> Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
>> ---
>>  .../MyFirstContribution-coverletter.txt       | 18 ++++++++++++++++
>>  Documentation/MyFirstContribution.txt         | 21 ++-----------------
>>  2 files changed, 20 insertions(+), 19 deletions(-)
>>  create mode 100644 Documentation/MyFirstContribution-coverletter.txt
> 
> If the end-product is a single document, "MyFirstContribution", I am
> skeptical if it is a good change to duplicate the same text in two
> sections.
> 
> Should we instead reorganize the document so these concepts like
> cover letters, log message for each commit, etc., which are
> applicable regardless of how you send them out, are explained,
> before we start talking about "now, we understand the components out
> of which a patch series is made of, here is how you give it a final
> polish and send it out, with send-email and/or with GGG"?
> 
> Short of that, perhaps whichever appears later in the document that
> uses "cover letter" can just say "see above"?
> 

Yeah, I guess you are right. I choosed to factor out the cover letter part like this mostly because it was a smaller change. I'll think of doing it like you suggest.

Thanks, Philippe.

Previous: Junio C HamanoNext: Philippe Blain via GitGitGadget
Message 15 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.