Skip to content

Commit 4e6b714

Browse files
knurdJonathan Corbet
authored andcommitted
docs: clarify rules wrt tagging other people
Point out that explicit permission is usually needed to tag other people in changes, but mention that implicit permission can be sufficient in certain cases. This fixes slight inconsistencies between Reported-by: and Suggested-by: and makes the usage more intuitive. While at it, explicitly mention the dangers of our bugzilla instance, as it makes it easy to forget that email addresses visible there are only shown to logged-in users. The latter is not a theoretical issue, as one maintainer mentioned that his employer received a EU GDPR (general data protection regulation) complaint after exposing a email address used in bugzilla through a tag in a patch description. Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Cc: Simona Vetter <simona.vetter@ffwll.ch> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Shuah Khan <skhan@linuxfoundation.org> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/588cf2763baa8fea1f4825f4eaa7023fe88bb6c1.1738852082.git.linux@leemhuis.info
1 parent fba374f commit 4e6b714

File tree

2 files changed

+36
-16
lines changed

2 files changed

+36
-16
lines changed

Documentation/process/5.Posting.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -268,10 +268,15 @@ The tags in common use are:
268268
- Cc: the named person received a copy of the patch and had the
269269
opportunity to comment on it.
270270

271-
Be careful in the addition of tags to your patches, as only Cc: is appropriate
272-
for addition without the explicit permission of the person named; using
273-
Reported-by: is fine most of the time as well, but ask for permission if
274-
the bug was reported in private.
271+
Be careful in the addition of the aforementioned tags to your patches, as all
272+
except for Cc:, Reported-by:, and Suggested-by: need explicit permission of the
273+
person named. For those three implicit permission is sufficient if the person
274+
contributed to the Linux kernel using that name and email address according
275+
to the lore archives or the commit history -- and in case of Reported-by:
276+
and Suggested-by: did the reporting or suggestion in public. Note,
277+
bugzilla.kernel.org is a public place in this sense, but email addresses
278+
used there are private; so do not expose them in tags, unless the person
279+
used them in earlier contributions.
275280

276281

277282
Sending the patch

Documentation/process/submitting-patches.rst

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -495,10 +495,10 @@ list archives. A "# Suffix" may also be used in this case to clarify.
495495

496496
If a person has had the opportunity to comment on a patch, but has not
497497
provided such comments, you may optionally add a ``Cc:`` tag to the patch.
498-
This is the only tag which might be added without an explicit action by the
499-
person it names - but it should indicate that this person was copied on the
500-
patch. This tag documents that potentially interested parties
501-
have been included in the discussion.
498+
This tag documents that potentially interested parties have been included in
499+
the discussion. Note, this is one of only three tags you might be able to use
500+
without explicit permission of the person named (see 'Tagging people requires
501+
permission' below for details).
502502

503503
Co-developed-by: states that the patch was co-created by multiple developers;
504504
it is used to give attribution to co-authors (in addition to the author
@@ -544,9 +544,9 @@ hopefully inspires them to help us again in the future. The tag is intended for
544544
bugs; please do not use it to credit feature requests. The tag should be
545545
followed by a Closes: tag pointing to the report, unless the report is not
546546
available on the web. The Link: tag can be used instead of Closes: if the patch
547-
fixes a part of the issue(s) being reported. Please note that if the bug was
548-
reported in private, then ask for permission first before using the Reported-by
549-
tag.
547+
fixes a part of the issue(s) being reported. Note, the Reported-by tag is one
548+
of only three tags you might be able to use without explicit permission of the
549+
person named (see 'Tagging people requires permission' below for details).
550550

551551
A Tested-by: tag indicates that the patch has been successfully tested (in
552552
some environment) by the person named. This tag informs maintainers that
@@ -596,11 +596,11 @@ Usually removal of someone's Tested-by or Reviewed-by tags should be mentioned
596596
in the patch changelog (after the '---' separator).
597597

598598
A Suggested-by: tag indicates that the patch idea is suggested by the person
599-
named and ensures credit to the person for the idea. Please note that this
600-
tag should not be added without the reporter's permission, especially if the
601-
idea was not posted in a public forum. That said, if we diligently credit our
602-
idea reporters, they will, hopefully, be inspired to help us again in the
603-
future.
599+
named and ensures credit to the person for the idea: if we diligently credit
600+
our idea reporters, they will, hopefully, be inspired to help us again in the
601+
future. Note, this is one of only three tags you might be able to use without
602+
explicit permission of the person named (see 'Tagging people requires
603+
permission' below for details).
604604

605605
A Fixes: tag indicates that the patch fixes an issue in a previous commit. It
606606
is used to make it easy to determine where a bug originated, which can help
@@ -618,6 +618,21 @@ Finally, while providing tags is welcome and typically very appreciated, please
618618
note that signers (i.e. submitters and maintainers) may use their discretion in
619619
applying offered tags.
620620

621+
.. _tagging_people:
622+
623+
Tagging people requires permission
624+
----------------------------------
625+
626+
Be careful in the addition of the aforementioned tags to your patches, as all
627+
except for Cc:, Reported-by:, and Suggested-by: need explicit permission of the
628+
person named. For those three implicit permission is sufficient if the person
629+
contributed to the Linux kernel using that name and email address according
630+
to the lore archives or the commit history -- and in case of Reported-by:
631+
and Suggested-by: did the reporting or suggestion in public. Note,
632+
bugzilla.kernel.org is a public place in this sense, but email addresses
633+
used there are private; so do not expose them in tags, unless the person
634+
used them in earlier contributions.
635+
621636
.. _the_canonical_patch_format:
622637

623638
The canonical patch format

0 commit comments

Comments
 (0)