Skip to content

Commit cd9123e

Browse files
ojedaJonathan Corbet
authored andcommitted
docs: submitting-patches: clarify Acked-by and introduce "# Suffix"
Acked-by is typically used by maintainers. However, sometimes it is useful to be able to accept the tag from other stakeholders that may not have done a deep technical review or may not be kernel developers. For instance: - People with domain knowledge, such as the original author of the code being modified. - Userspace-side reviewers for a kernel uAPI patch, like in DRM -- see Documentation/gpu/drm-uapi.rst: > The userspace-side reviewer should also provide an Acked-by on the > kernel uAPI patch indicating that they believe the proposed uAPI > is sound and sufficiently documented and validated for userspace's > consumption. - Key users of a feature, such as in [1]. Thus clarify that Acked-by may be used by other stakeholders (but most commonly by maintainers). Since, in these cases, it may be confusing why an Acked-by is/was provided, allow and suggest to provide a "# Suffix" explaining it. The "# Suffix" for Acked-by is already being used to clarify what part of the patch a maintainer is acknowledging, thus also mention "# Suffix" in the relevant paragraph. Link: https://lore.kernel.org/rust-for-linux/CANiq72m4fea15Z0fFZauz8N2madkBJ0G7Dc094OwoajnXmROOA@mail.gmail.com/ [1] Acked-by: Shuah Khan <[email protected]> Acked-by: Dan Williams <[email protected]> Signed-off-by: Miguel Ojeda <[email protected]> Reviewed-by: Neal Gompa <[email protected]> Acked-by: Greg Kroah-Hartman <[email protected]> Acked-by: Krzysztof Kozlowski <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Link: https://lore.kernel.org/r/[email protected]
1 parent f80aaf4 commit cd9123e

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

Documentation/process/submitting-patches.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -463,9 +463,17 @@ If a person was not directly involved in the preparation or handling of a
463463
patch but wishes to signify and record their approval of it then they can
464464
ask to have an Acked-by: line added to the patch's changelog.
465465

466-
Acked-by: is often used by the maintainer of the affected code when that
466+
Acked-by: is meant to be used by those responsible for or involved with the
467+
affected code in one way or another. Most commonly, the maintainer when that
467468
maintainer neither contributed to nor forwarded the patch.
468469

470+
Acked-by: may also be used by other stakeholders, such as people with domain
471+
knowledge (e.g. the original author of the code being modified), userspace-side
472+
reviewers for a kernel uAPI patch or key users of a feature. Optionally, in
473+
these cases, it can be useful to add a "# Suffix" to clarify its meaning::
474+
475+
Acked-by: The Stakeholder <[email protected]> # As primary user
476+
469477
Acked-by: is not as formal as Signed-off-by:. It is a record that the acker
470478
has at least reviewed the patch and has indicated acceptance. Hence patch
471479
mergers will sometimes manually convert an acker's "yep, looks good to me"
@@ -477,7 +485,7 @@ For example, if a patch affects multiple subsystems and has an Acked-by: from
477485
one subsystem maintainer then this usually indicates acknowledgement of just
478486
the part which affects that maintainer's code. Judgement should be used here.
479487
When in doubt people should refer to the original discussion in the mailing
480-
list archives.
488+
list archives. A "# Suffix" may also be used in this case to clarify.
481489

482490
If a person has had the opportunity to comment on a patch, but has not
483491
provided such comments, you may optionally add a ``Cc:`` tag to the patch.

0 commit comments

Comments
 (0)