Documentation: process: Clarify use of Cc:
Subsystems (2)
cover Documentation: process: Clarify use of Cc:
Add a couple of recommendations on how to utilise Cc header in environment friendly way.
Andy Shevchenko (2):
Documentation: process: Avoid unneeded Cc: tags
Documentation: process: Recommend to put Cc: tags after cutter '---'
line
Documentation/process/5.Posting.rst | 8 +++++++- Documentation/process/submitting-patches.rst | 10 +++++++++- 2 files changed, 16 insertions(+), 2 deletions(-)
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
PATCH 1/2 Documentation: process: Avoid unneeded Cc: tags
Add a note that explains that Cc: email header is implied by other tags, such as Reviewed-by:. In this case an explicit Cc: is _not_ needed.
--- Documentation/process/5.Posting.rst | 4 +++- Documentation/process/submitting-patches.rst | 5 ++++- 2 files changed, 7 insertions(+), 2 deletions(-)
Documentation/process/5.Posting.rst +3 -1
@@ -267,7 +267,9 @@ The tags in common use are: being reported. - Cc: the named person received a copy of the patch and had the - opportunity to comment on it. + opportunity to comment on it. Note that other formal tags are 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. Be careful in the addition of tags to your patches, as only Cc: is appropriate for addition without the explicit permission of the person named; using
Documentation/process/submitting-patches.rst +4 -1
@@ -486,7 +486,10 @@ provided such comments, you may optionally add a ``Cc:`` tag to the patch. This is the only tag which might be added without an explicit action by the person it names - but it should indicate that this person was copied on the patch. This tag documents that potentially interested parties -have been included in the discussion. +have been included in the discussion. Note that other formal tags are +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. 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
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
Re: [PATCH v1 1/2] Documentation: process: Avoid unneeded Cc: tags
Quoted 9 lines · Andy Shevchenko
Add a note that explains that Cc: email header is implied by other tags, such as Reviewed-by:. In this case an explicit Cc: is _not_ needed.
Signed-off-by Andy Shevchenko <[email protected]>--- Documentation/process/5.Posting.rst | 4 +++- Documentation/process/submitting-patches.rst | 5 ++++- 2 files changed, 7 insertions(+), 2 deletions(-)
[..]
Quoted 6 lines
Documentation/process/submitting-patches.rst +0
-0
Documentation/process/submitting-patches.rst provided such comments, you may optionally add a ``Cc:`` tag to the patch. · line 492
Quoted 8 lines
Documentation/process/submitting-patches.rst +4
-1@@ -486,7 +486,10 @@ provided such comments, you may optionally add a ``Cc:`` tag to the patch. This is the only tag which might be added without an explicit action by the person it names - but it should indicate that this person was copied on the patch. This tag documents that potentially interested parties -have been included in the discussion. +have been included in the discussion. Note that other formal tags are +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.
This just looks like a licsense to needle people that happen to ship a duplicate tag. It does not feel like a net improvement to community discourse.
Instead, one positive contribution in this area might be to patch "b4 am" to cleanup redundant tags when a Cc: is repeated by another tag. For example:
b4 am [email protected]
...could have elided the Cc: for Jonathan after applying his Reviewed-by:.
Re: [PATCH v1 1/2] Documentation: process: Avoid unneeded Cc: tags
In reply to Andy ShevchenkoQuoted 30 lines · Andy Shevchenko
Add a note that explains that Cc: email header is implied by other tags, such as Reviewed-by:. In this case an explicit Cc: is _not_ needed.
Signed-off-by Andy Shevchenko <[email protected]>--- Documentation/process/5.Posting.rst | 4 +++- Documentation/process/submitting-patches.rst | 5 ++++- 2 files changed, 7 insertions(+), 2 deletions(-)Documentation/process/5.Posting.rst +3
-1@@ -267,7 +267,9 @@ The tags in common use are: being reported. - Cc: the named person received a copy of the patch and had the - opportunity to comment on it. + opportunity to comment on it. Note that other formal tags are 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. Be careful in the addition of tags to your patches, as only Cc: is appropriate for addition without the explicit permission of the person named; usingDocumentation/process/submitting-patches.rst +0
-0
Documentation/process/submitting-patches.rst provided such comments, you may optionally add a ``Cc:`` tag to the patch. · line 492
Quoted 8 lines
Documentation/process/submitting-patches.rst +4
-1@@ -486,7 +486,10 @@ provided such comments, you may optionally add a ``Cc:`` tag to the patch. This is the only tag which might be added without an explicit action by the person it names - but it should indicate that this person was copied on the patch. This tag documents that potentially interested parties -have been included in the discussion. +have been included in the discussion. Note that other formal tags are +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 depends on the tool. b4 and git-send-email do it, but other might not (e.g. quilt?). Anyway, to me this is obvious and submitting-patches is already way too long, so I would just keep it in the "5.Posting", but not here.
Best regards,
Krzysztof
PATCH 2/2 Documentation: process: Recommend to put Cc: tags after cutter '---' line
In reply to Andy ShevchenkoThe 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!
--- Documentation/process/5.Posting.rst | 4 ++++ Documentation/process/submitting-patches.rst | 5 +++++ 2 files changed, 9 insertions(+)
Documentation/process/5.Posting.rst +4 -0
@@ -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 -----------------
Documentation/process/submitting-patches.rst +5 -0
@@ -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
Signature · 1 line
2.43.0.rc1.1336.g36b5255a03ac
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 10 lines · Andy Shevchenko
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.
I find the information in the commit message useful, and it tells me who were explicitly included in the discussion.
For example when fixing a regression I'd like to Cc everyone who was Cc'd in the regressing commit. The drm subsystem maintainer tool actually has a helper for doing just that. 'dim fixes <sha1>' digs up all the relevant info.
The Cc's on the mailing list archive are harder to dig up, and do not accurately reflect the same information. A lot of patches get sent with more Cc's in the mail message than in the commit message.
BR,
Jani.
Quoted 39 lines
Let's be environment friendly and save the planet!
Signed-off-by Andy Shevchenko <[email protected]>--- Documentation/process/5.Posting.rst | 4 ++++ Documentation/process/submitting-patches.rst | 5 +++++ 2 files changed, 9 insertions(+)Documentation/process/5.Posting.rst +4
-0@@ -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 -----------------Documentation/process/submitting-patches.rst +5
-0@@ -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
Signature · 1 line
Jani Nikula, Intel
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 15 lines · Jani Nikula
Quoted 10 lines · Andy Shevchenko
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.I find the information in the commit message useful, and it tells me who were explicitly included in the discussion.
Quoted 7 lines
For example when fixing a regression I'd like to Cc everyone who was Cc'd in the regressing commit. The drm subsystem maintainer tool actually has a helper for doing just that. 'dim fixes <sha1>' digs up all the relevant info.
The Cc's on the mailing list archive are harder to dig up, and do not accurately reflect the same information.
How comes? These Cc: are 1:1 mapped to the Cc: email headers.
Quoted 2 lines
A lot of patches get sent with
more Cc's in the mail message than in the commit message.
Note, this is the recommendation as it's stated. You can continue polluting the environment on your wish.
Quoted 1 line
Quoted 1 line
Let's be environment friendly and save the planet!
Signature · 2 lines
With Best Regards, Andy Shevchenko
Jonathan Corbet
maintainerRe: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 5 lines · Andy Shevchenko
Quoted 2 lines
A lot of patches get sent with
more Cc's in the mail message than in the commit message.Note, this is the recommendation as it's stated. You can continue polluting the environment on your wish.
The environmental case here is ... not strong.
I, too, have my doubts about this recommendation; responding this way is not going to change a lot of minds, IMO.
Thanks,
jon
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 5 lines · Jonathan Corbet
Quoted 3 lines · Andy Shevchenko
Quoted 2 lines
A lot of patches get sent with
more Cc's in the mail message than in the commit message.
Quoted 7 lines
Quoted 2 lines
Note, this is the recommendation as it's stated. You can continue polluting the environment on your wish.
The environmental case here is ... not strong.
I, too, have my doubts about this recommendation; responding this way is not going to change a lot of minds, IMO.
Let's see how discussion will go.
Nevertheless, there seem no objections against the first patch in the series. Can it be applied?
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
In reply to Andy ShevchenkoQuoted 5 lines · Andy Shevchenko
Quoted 2 lines · Jani Nikula
The Cc's on the mailing list archive are harder to dig up, and do not accurately reflect the same information.
How comes? These Cc: are 1:1 mapped to the Cc: email headers.
Patch Cc's get mapped to email Cc's depending on personal git sendemail configuration.
People can add more Cc's in the emails when sending.
Mailing list Cc's actually present in the archives depend on mailing list manager configuration, and, in some cases, even the personal list preferences of individual subscribers.
BR,
Jani.
Signature · 1 line
Jani Nikula, Intel
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 11 lines · Jani Nikula
Quoted 5 lines · Andy Shevchenko
Quoted 2 lines · Jani Nikula
The Cc's on the mailing list archive are harder to dig up, and do not accurately reflect the same information.
How comes? These Cc: are 1:1 mapped to the Cc: email headers.
Patch Cc's get mapped to email Cc's depending on personal git sendemail configuration.
People can add more Cc's in the emails when sending.
So, which exactly a proof why email headers are better for that, as they reflect _reality_.
Quoted 3 lines
Mailing list Cc's actually present in the archives depend on mailing list manager configuration, and, in some cases, even the personal list preferences of individual subscribers.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 8 lines · Andy Shevchenko
Quoted 7 lines · Jani Nikula
Quoted 5 lines · Andy Shevchenko
Quoted 2 lines · Jani Nikula
The Cc's on the mailing list archive are harder to dig up, and do not accurately reflect the same information.
How comes? These Cc: are 1:1 mapped to the Cc: email headers.
Quoted 7 lines
Quoted 4 lines
Patch Cc's get mapped to email Cc's depending on personal git sendemail configuration.
People can add more Cc's in the emails when sending.
So, which exactly a proof why email headers are better for that, as they reflect _reality_.
No, I think the point is, commit message Cc != email message Cc, they just have the same name.
Similar to, say, Reviewed-by, a commit message Cc may turn into an email message Cc. But you can't make assumptions about it one way or the other.
Imagine the commit message Cc was named "Attn:" and handled appropriately. That probably reflects a lot of commit message Cc usage.
BR,
Jani.
Quoted 4 lines
Quoted 4 lines
Mailing list Cc's actually present in the archives depend on mailing list manager configuration, and, in some cases, even the personal list preferences of individual subscribers.
Signature · 1 line
Jani Nikula, Intel
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 3 lines · Jani Nikula
Imagine the commit message Cc was named "Attn:" and handled appropriately. That probably reflects a lot of commit message Cc usage.
This is especially the case for get_maintainer.pl purposes. Adding a Cc:
in a commit message means that this person will be included on patches referencing this commit (e.g. via Fixes:).
-K
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
In reply to Jani NikulaHi Jani,
Quoted 6 lines · Jani Nikula
Quoted 5 lines · Andy Shevchenko
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;
Quoted 8 lines
Quoted 5 lines
- 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.I find the information in the commit message useful, and it tells me who were explicitly included in the discussion.
Contrary to popular belief, it does not tell you who was explicitly included in the discussion. Git history has lots of commits that state I was CCed on a patch, while I had no active participation in the discussion, or even any interest in the patch in the first place (scripts/get_mainter.pl considered harmful).
Gr{oetje,eeting}s,
Geert
Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected] In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
In reply to Jani NikulaQuoted 3 lines · Jani Nikula
The Cc's on the mailing list archive are harder to dig up, and do not accurately reflect the same information. A lot of patches get sent with more Cc's in the mail message than in the commit message.
These days with b4 and lore it's pretty straightforward, especially with subsystems that include a message ID based link to the discussion when applying the patch - you can just grab the original discussion with a b4 mbox command.
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
In reply to Andy ShevchenkoQuoted 4 lines · Andy Shevchenko
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;
Reading commits on a mobile device is not what kernel development is optimized for, sorry.
Quoted 6 lines
- 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.
Quoted 7 lines
Let's be environment friendly and save the planet!
Signed-off-by Andy Shevchenko <[email protected]>--- Documentation/process/5.Posting.rst | 4 ++++ Documentation/process/submitting-patches.rst | 5 +++++ 2 files changed, 9 insertions(+)
This breaks my existing workflow, sorry. I can't track cc: below the --- line because obviously, git cuts that off. So I put them above where git send-email can see them, AND where git can handle them when I rebase/revise/etc.
Also, as Jon points out, the "environmental" argument seems very odd, it's not like bits cost more to send around (they keep getting cheaper in power and money), and processing power is pretty constant for servers handling email, so I don't understand the power consumption argument. Without some sort of data to back that up, I'd be loath to repeat it.
thanks,
greg k-h
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 8 lines · Greg KH
Quoted 4 lines · Andy Shevchenko
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;
Reading commits on a mobile device is not what kernel development is optimized for, sorry.
The commit messages not always for the kernel development, some people may read them in order to understand code better or many other reasons. I.o.w. it's not the point.
Quoted 14 lines
Quoted 6 lines
- 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.Quoted 7 lines
Let's be environment friendly and save the planet!
Signed-off-by Andy Shevchenko <[email protected]>--- Documentation/process/5.Posting.rst | 4 ++++ Documentation/process/submitting-patches.rst | 5 +++++ 2 files changed, 9 insertions(+)
Quoted 3 lines
This breaks my existing workflow, sorry. I can't track cc: below the --- line because obviously, git cuts that off. So I put them above where git send-email can see them,
git send-email _sees_ them very well there.
Quoted 8 lines
AND where git can handle them when I
rebase/revise/etc.Also, as Jon points out, the "environmental" argument seems very odd, it's not like bits cost more to send around (they keep getting cheaper in power and money), and processing power is pretty constant for servers handling email, so I don't understand the power consumption argument. Without some sort of data to back that up, I'd be loath to repeat it.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 28 lines · Andy Shevchenko
Quoted 8 lines · Greg KH
Quoted 4 lines · Andy Shevchenko
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;
Reading commits on a mobile device is not what kernel development is optimized for, sorry.
The commit messages not always for the kernel development, some people may read them in order to understand code better or many other reasons. I.o.w. it's not the point.
Quoted 14 lines
Quoted 13 lines
- 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 <[email protected]>--- Documentation/process/5.Posting.rst | 4 ++++ Documentation/process/submitting-patches.rst | 5 +++++ 2 files changed, 9 insertions(+)
Quoted 5 lines
Quoted 3 lines
This breaks my existing workflow, sorry. I can't track cc: below the --- line because obviously, git cuts that off. So I put them above where git send-email can see them,
git send-email _sees_ them very well there.
Sorry, yes, but git itself can't track them in the commit when I rebase/squash/redo/etc. That's the point I was trying to make before my coffee kicked in...
thanks,
greg k-h
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 33 lines · Greg KH
Quoted 32 lines · Andy Shevchenko
Quoted 8 lines · Greg KH
Quoted 4 lines · Andy Shevchenko
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;
Reading commits on a mobile device is not what kernel development is optimized for, sorry.
The commit messages not always for the kernel development, some people may read them in order to understand code better or many other reasons. I.o.w. it's not the point.
Quoted 17 lines
Quoted 6 lines
- 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.Quoted 7 lines
Let's be environment friendly and save the planet!
Signed-off-by Andy Shevchenko <[email protected]>--- Documentation/process/5.Posting.rst | 4 ++++ Documentation/process/submitting-patches.rst | 5 +++++ 2 files changed, 9 insertions(+)This breaks my existing workflow, sorry. I can't track cc: below the --- line because obviously, git cuts that off. So I put them above where git send-email can see them,
Quoted 5 lines
Quoted 1 line
git send-email _sees_ them very well there.
Sorry, yes, but git itself can't track them in the commit when I rebase/squash/redo/etc. That's the point I was trying to make before my coffee kicked in...
It can in your _local_ repo if you have it as
Signed-off-by:
---
Cc:
Cc:
in the commit message. It won't go to the final commit message if you sending it out and apply via git am, or reapply with the latter locally instead of cherry-picking.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
In reply to Andy ShevchenkoQuoted 24 lines · Andy Shevchenko
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 <[email protected]>--- Documentation/process/5.Posting.rst | 4 ++++ Documentation/process/submitting-patches.rst | 5 +++++ 2 files changed, 9 insertions(+)Documentation/process/5.Posting.rst +0
-0
Documentation/process/5.Posting.rst for addition without the explicit permission of the person named; using · line 282
Quoted 7 lines
Documentation/process/5.Posting.rst +4
-0@@ -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
Re: [PATCH v1 2/2] Documentation: process: Recommend to put Cc: tags after cutter '---' line
Quoted 13 lines · Krzysztof Kozlowski
Quoted 12 lines · Andy Shevchenko
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!
...
Quoted 13 lines
Documentation/process/5.Posting.rst for addition without the explicit permission of the person named; using · line 282
Quoted 4 lines
Documentation/process/5.Posting.rst +4
-0+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:
Quoted 6 lines
====
It is recommended to not add autogeneratedscripts/get_maintainer.plCC-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.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 2 lines · Andy Shevchenko
Add a couple of recommendations on how to utilise Cc header in environment friendly way.
Gr{oetje,eeting}s,
Geert
Signature · 5 lines
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- [email protected] In personal conversations with technical people, I call myself a hacker. But when I'm talking to journalists I just say "programmer" or something like that. -- Linus Torvalds
+Cc: Dmitry
(have been told by colleague of mine that you also has an opinion on this
topic, sorry if I added you by a mistake).
Quoted 7 lines · Andy Shevchenko
Add a couple of recommendations on how to utilise Cc header in environment friendly way.
Andy Shevchenko (2):
Documentation: process: Avoid unneeded Cc: tags
Documentation: process: Recommend to put Cc: tags after cutter '---'
line
Signature · 2 lines
With Best Regards, Andy Shevchenko