[PATCH v2 1/1] docs: process: submitting-patches: Clarify the Reported-by usage

[PATCH v2 1/1] docs: process: submitting-patches: Clarify the Reported-by usage

[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 <fe@dev.tdt.de>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
v2: rephrased as suggested by Jonathan
 Documentation/process/submitting-patches.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 31ea120ce531..fb496b2ebfd3 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -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
-- 
2.34.1

Re: [PATCH v2 1/1] docs: process: submitting-patches: Clarify the Reported-by usage

[Randy Dunlap]

On 1/27/22 08:32, Andy Shevchenko wrote:
> 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 <fe@dev.tdt.de>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> ---
> v2: rephrased as suggested by Jonathan
>  Documentation/process/submitting-patches.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
> index 31ea120ce531..fb496b2ebfd3 100644
> --- a/Documentation/process/submitting-patches.rst
> +++ b/Documentation/process/submitting-patches.rst
> @@ -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.  :)

Acked-by: Randy Dunlap <rdunlap@infradead.org>

thanks.

>  A Tested-by: tag indicates that the patch has been successfully tested (in
>  some environment) by the person named.  This tag informs maintainers that

-- 
~Randy

Re: [PATCH v2 1/1] docs: process: submitting-patches: Clarify the Reported-by usage

[Andy Shevchenko]

On Thu, Jan 27, 2022 at 09:21:21AM -0800, Randy Dunlap wrote:
> On 1/27/22 08:32, Andy Shevchenko wrote:

...

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

> Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks!

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v2 1/1] docs: process: submitting-patches: Clarify the Reported-by usage

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> On 1/27/22 08:32, Andy Shevchenko wrote:
>> 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 <fe@dev.tdt.de>
>> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
>> ---
>> v2: rephrased as suggested by Jonathan
>>  Documentation/process/submitting-patches.rst | 3 ++-
>>  1 file changed, 2 insertions(+), 1 deletion(-)
>> 
>> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
>> index 31ea120ce531..fb496b2ebfd3 100644
>> --- a/Documentation/process/submitting-patches.rst
>> +++ b/Documentation/process/submitting-patches.rst
>> @@ -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.  :)
>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>

Applied, thanks.

jon