[PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line

From: Andy Shevchenko
Date: Tue Apr 23 2024 - 09:20:41 EST


The recommendation is based on the following rationale:

- it makes the commit messages much cleaner and easy to read, especially
on the screens of the mobile devices;

- it reduces resources (memory, time, energy) to retrieve all these
headers, which are barely needed by a mere user, as for automation
they will be still available via mail archives, such as
https://lore.kernel.org, assuming the Link: or Message-ID tag is
provided.

Let's be environment friendly and save the planet!

Signed-off-by: Andy Shevchenko <andriy.shevchenko@xxxxxxxxxxxxxxx>
---
Documentation/process/5.Posting.rst | 4 ++++
Documentation/process/submitting-patches.rst | 5 +++++
2 files changed, 9 insertions(+)

diff --git a/Documentation/process/5.Posting.rst b/Documentation/process/5.Posting.rst
index 90a7fe2a85f2..157b3fc0087a 100644
--- a/Documentation/process/5.Posting.rst
+++ b/Documentation/process/5.Posting.rst
@@ -276,6 +276,10 @@ for addition without the explicit permission of the person named; using
Reported-by: is fine most of the time as well, but ask for permission if
the bug was reported in private.

+It's recommended to locate the additional Cc: tags after the cutter '---' line
+in the patches as it makes sure the commit message won't be polluted with them.
+At the same time they will be available via email headers on the mail archives,
+such as https://lore.kernel.org.

Sending the patch
-----------------
diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 6775f0698136..0c898d9e00f5 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -491,6 +491,11 @@ automatically converted to the Cc: email header and you do not need to
have an explicit ``Cc:`` tag, if the person is already mentioned by another
tag.

+It's recommended to locate the additional ``Cc:`` tags after the cutter '---' line
+in the patches as it makes sure the commit message won't be polluted with them.
+At the same time they will be available via email headers on the mail archives,
+such as https://lore.kernel.org.
+
Co-developed-by: states that the patch was co-created by multiple developers;
it is used to give attribution to co-authors (in addition to the author
attributed by the From: tag) when several people work on a single patch. Since
--
2.43.0.rc1.1336.g36b5255a03ac