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] [day] [month] [year] [list]

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

On Mon, Apr 29, 2024 at 09:35:18AM +0200, Krzysztof Kozlowski wrote:
> 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!

..

> > +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.

Right, but still even for non-automated output it might (may) be redundant,
however I can go for this compromise as most of the Cc indeed duplicate
the output of get_maintainer.pl.

-- 
With Best Regards,
Andy Shevchenko