docs: process: submitting-patches: Clarify the Reported-by usage
Subsystems (2)
PATCH v2 1/1 docs: process: submitting-patches: Clarify the Reported-by usage
It's unclear from "Submitting Patches" documentation that Reported-by is not supposed to be used against new features. (It's more clear in the section 5.4 "Patch formatting and changelogs" of the "A guide to the Kernel Development Process", where it suggests that change should fix something existing in the kernel. Clarify the Reported-by usage in the "Submitting Patches".
---
v2: rephrased as suggested by Jonathan
Documentation/process/submitting-patches.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
Documentation/process/submitting-patches.rst +2 -1
@@ -495,7 +495,8 @@ Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: The Reported-by tag gives credit to people who find bugs and report them and it hopefully inspires them to help us again in the future. Please note that if the bug was reported in private, then ask for permission first before using the -Reported-by tag. +Reported-by tag. The tag is intended for bugs; please do not use it to credit +feature requests. A Tested-by: tag indicates that the patch has been successfully tested (in some environment) by the person named. This tag informs maintainers that
Signature · 1 line
2.34.1
Quoted 19 lines · Andy Shevchenko
It's unclear from "Submitting Patches" documentation that Reported-by is not supposed to be used against new features. (It's more clear in the section 5.4 "Patch formatting and changelogs" of the "A guide to the Kernel Development Process", where it suggests that change should fix something existing in the kernel. Clarify the Reported-by usage in the "Submitting Patches".
Reported-by Florian Eckert <[email protected]>Signed-off-by Andy Shevchenko <[email protected]>---
v2: rephrased as suggested by JonathanDocumentation/process/submitting-patches.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)Documentation/process/submitting-patches.rst +0
-0
Documentation/process/submitting-patches.rst Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: · line 500
Quoted 7 lines
Documentation/process/submitting-patches.rst +2
-1@@ -495,7 +495,8 @@ Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: The Reported-by tag gives credit to people who find bugs and report them and it hopefully inspires them to help us again in the future. Please note that if the bug was reported in private, then ask for permission first before using the -Reported-by tag. +Reported-by tag. The tag is intended for bugs; please do not use it to credit +feature requests.
LGTM.
Although it could refer to Suggested-by. :)
thanks.
Quoted 2 lines
Documentation/process/submitting-patches.rst +0
-0A Tested-by: tag indicates that the patch has been successfully tested (in some environment) by the person named. This tag informs maintainers that
Signature · 1 line
~Randy
Quoted 1 line · Randy Dunlap
On 1/27/22 08:32, Andy Shevchenko wrote:
...
Quoted 6 lines
Documentation/process/submitting-patches.rst Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: · line 499
Quoted 3 lines
Documentation/process/submitting-patches.rst +2
-1-Reported-by tag. +Reported-by tag. The tag is intended for bugs; please do not use it to credit +feature requests.LGTM.
Although it could refer to Suggested-by. :)
The main issue here is that automated CIs may suggest people to include the tag. And people (especially who are new in the community) tend to obey without a doubt.
Quoted 1 line
Acked-by Randy Dunlap <[email protected]>
Thanks!
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 31 lines · Randy Dunlap
Quoted 19 lines · Andy Shevchenko
It's unclear from "Submitting Patches" documentation that Reported-by is not supposed to be used against new features. (It's more clear in the section 5.4 "Patch formatting and changelogs" of the "A guide to the Kernel Development Process", where it suggests that change should fix something existing in the kernel. Clarify the Reported-by usage in the "Submitting Patches".
Reported-by Florian Eckert <[email protected]>Signed-off-by Andy Shevchenko <[email protected]>---
v2: rephrased as suggested by JonathanDocumentation/process/submitting-patches.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)Documentation/process/submitting-patches.rst +0
-0Documentation/process/submitting-patches.rst Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: · line 500
Quoted 7 lines
Documentation/process/submitting-patches.rst +2
-1@@ -495,7 +495,8 @@ Using Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes: The Reported-by tag gives credit to people who find bugs and report them and it hopefully inspires them to help us again in the future. Please note that if the bug was reported in private, then ask for permission first before using the -Reported-by tag. +Reported-by tag. The tag is intended for bugs; please do not use it to credit +feature requests.LGTM.
Although it could refer to Suggested-by. :)
Quoted 1 line
Acked-by Randy Dunlap <[email protected]>
Applied, thanks.
jon