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

From: Junio C Hamano <gitster@pobox.com>
Date: Apr 27, 2022, 21:48 UTC
Message-ID: <xmqqr15ijiyt.fsf@gitster.g>
In-Reply-To: <7e84d5b286de9dddf28ef1c8f38c7d7c28e266f0.1651086288.git.gitgitgadget@gmail.com>

"Philippe Blain via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 15 quoted lines

> 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"?