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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date: Mon, 29 Apr 2024 09:35:18 +0200
From: Krzysztof Kozlowski <krzk@...nel.org>
To: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
 workflows@...r.kernel.org, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org
Cc: Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags
 after cutter '---' line

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@...ux.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