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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



"Philippe Blain via GitGitGadget" <gitgitgadget@xxxxxxxxx> writes:

> From: Philippe Blain <levraiphilippeblain@xxxxxxxxx>
>
> 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@xxxxxxxxx>
> ---
>  .../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"?




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux