From: Krzysztof Kozlowski <krzk@kernel.org>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
workflows@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Date: Mon, 29 Apr 2024 09:35:18 +0200 [thread overview]
Message-ID: <927c40c5-cfd7-4a22-a9c6-7b6f9592e4b0@kernel.org> (raw)
In-Reply-To: <20240423132024.2368662-3-andriy.shevchenko@linux.intel.com>
On 23/04/2024 15:19, Andy Shevchenko wrote:
> 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@linux.intel.com>
> ---
> 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.
Manually added useful Cc-tags should be kept in commit msg, because it
annotates who could be interested in the patch.
The problem is that people put output of get_maintainers.pl as Cc to the
commit list. This is 100% redundant because it can be recreated any
given time with 100% accuracy (for given kernel tree). Therefore I would
propose to rephrase it to something:
====
It is recommended to not add autogenerated scripts/get_maintainer.pl
CC-entries into the commit msg, but keep them under cutter '---'. There
is no single need to store automated output of get_maintainers.pl in the
git log. It can be easily re-created at any given time, thus its
presence in the git history is redundant and obfuscates the log.
====
Best regards,
Krzysztof
next prev parent reply other threads:[~2024-04-29 7:35 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-23 13:19 [PATCH v1 0/2] Documentation: process: Clarify use of Cc: Andy Shevchenko
2024-04-23 13:19 ` [PATCH v1 1/2] Documentation: process: Avoid unneeded Cc: tags Andy Shevchenko
2024-04-23 17:13 ` Dan Williams
2024-04-29 7:37 ` Krzysztof Kozlowski
2024-04-23 13:19 ` [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line Andy Shevchenko
2024-04-23 14:30 ` Jani Nikula
2024-04-23 14:37 ` Andy Shevchenko
2024-04-23 14:44 ` Jonathan Corbet
2024-04-23 16:46 ` Andy Shevchenko
2024-04-23 16:37 ` Jani Nikula
2024-04-23 16:45 ` Andy Shevchenko
2024-04-23 17:00 ` Jani Nikula
2024-04-23 17:04 ` Konstantin Ryabitsev
2024-04-23 15:26 ` Geert Uytterhoeven
2024-04-24 1:10 ` Mark Brown
2024-04-23 15:13 ` Greg KH
2024-04-23 15:28 ` Andy Shevchenko
2024-04-23 16:07 ` Greg KH
2024-04-23 16:12 ` Andy Shevchenko
2024-04-29 7:35 ` Krzysztof Kozlowski [this message]
2024-04-29 8:44 ` Andy Shevchenko
2024-04-23 13:59 ` [PATCH v1 0/2] Documentation: process: Clarify use of Cc: Geert Uytterhoeven
2024-04-24 14:53 ` Andy Shevchenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=927c40c5-cfd7-4a22-a9c6-7b6f9592e4b0@kernel.org \
--to=krzk@kernel.org \
--cc=andriy.shevchenko@linux.intel.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.