[PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

[PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

[Kees Cook]

As recently pointed out by Linus, "Root-caused-by" is a good tag to include
since it can indicate significantly more work than "just" a Reported-by.
This adds it and "Suggested-by" (which was also missing) to the documented
list of tags. Additionally updates checkpatch.pl to match the process docs.

Signed-off-by: Kees Cook <keescook@chromium.org>
---
 Documentation/process/5.Posting.rst | 7 +++++++
 scripts/checkpatch.pl               | 2 ++
 2 files changed, 9 insertions(+)

diff --git a/Documentation/process/5.Posting.rst b/Documentation/process/5.Posting.rst
index 645fa9c7388a..2ff01f76f02a 100644
--- a/Documentation/process/5.Posting.rst
+++ b/Documentation/process/5.Posting.rst
@@ -234,6 +234,13 @@ The tags in common use are:
    people who test our code and let us know when things do not work
    correctly.
 
+ - Suggested-by: names a person who suggested the solution, but may not
+   have constructed the full patch. A weaker version of `Co-Developed-by`.
+
+ - Root-caused-by: names a person who diagnosed the root cause of a
+   problem. This usually indicates significantly more work than a simple
+   `Reported-by`.
+
  - Cc: the named person received a copy of the patch and had the
    opportunity to comment on it.
 
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 3d4040322ae1..a1ab82e70b54 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -464,9 +464,11 @@ our $logFunctions = qr{(?x:
 our $signature_tags = qr{(?xi:
 	Signed-off-by:|
 	Acked-by:|
+	Co-Developed-by:|
 	Tested-by:|
 	Reviewed-by:|
 	Reported-by:|
+	Root-caused-by:|
 	Suggested-by:|
 	To:|
 	Cc:
-- 
2.7.4


-- 
Kees Cook
Pixel Security

Re: [PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

[Joe Perches]

On Wed, 2018-02-21 at 16:37 -0800, Kees Cook wrote:
> As recently pointed out by Linus, "Root-caused-by" is a good tag to include
> since it can indicate significantly more work than "just" a Reported-by.
> This adds it and "Suggested-by" (which was also missing) to the documented
> list of tags. Additionally updates checkpatch.pl to match the process docs.
[]
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -464,9 +464,11 @@ our $logFunctions = qr{(?x:
>  our $signature_tags = qr{(?xi:
>  	Signed-off-by:|
>  	Acked-by:|
> +	Co-Developed-by:|
>  	Tested-by:|
>  	Reviewed-by:|
>  	Reported-by:|
> +	Root-caused-by:|
>  	Suggested-by:|
>  	To:|
>  	Cc:

Patch does not match commit description

Re: [PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

[Kees Cook]

On Wed, Feb 21, 2018 at 6:13 PM, Joe Perches <joe@perches.com> wrote:
> On Wed, 2018-02-21 at 16:37 -0800, Kees Cook wrote:
>> As recently pointed out by Linus, "Root-caused-by" is a good tag to include
>> since it can indicate significantly more work than "just" a Reported-by.
>> This adds it and "Suggested-by" (which was also missing) to the documented
>> list of tags. Additionally updates checkpatch.pl to match the process docs.
> []
>> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> []
>> @@ -464,9 +464,11 @@ our $logFunctions = qr{(?x:
>>  our $signature_tags = qr{(?xi:
>>       Signed-off-by:|
>>       Acked-by:|
>> +     Co-Developed-by:|
>>       Tested-by:|
>>       Reviewed-by:|
>>       Reported-by:|
>> +     Root-caused-by:|
>>       Suggested-by:|
>>       To:|
>>       Cc:
>
> Patch does not match commit description

Hm? Why not? It's updating checkpatch.pl to match the process docs.
checkpatch.pl was missing Co-Developed-by and Root-caused-by, relative
to the process docs.

-Kees

-- 
Kees Cook
Pixel Security

Re: [PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

[Randy Dunlap]

On 02/21/2018 04:37 PM, Kees Cook wrote:
> As recently pointed out by Linus, "Root-caused-by" is a good tag to include
> since it can indicate significantly more work than "just" a Reported-by.
> This adds it and "Suggested-by" (which was also missing) to the documented
> list of tags. Additionally updates checkpatch.pl to match the process docs.
> 
> Signed-off-by: Kees Cook <keescook@chromium.org>
> ---
>  Documentation/process/5.Posting.rst | 7 +++++++
>  scripts/checkpatch.pl               | 2 ++
>  2 files changed, 9 insertions(+)

I would still rather see Co-developed-by: in both the docs and in checkpatch. :(

> diff --git a/Documentation/process/5.Posting.rst b/Documentation/process/5.Posting.rst
> index 645fa9c7388a..2ff01f76f02a 100644
> --- a/Documentation/process/5.Posting.rst
> +++ b/Documentation/process/5.Posting.rst
> @@ -234,6 +234,13 @@ The tags in common use are:
>     people who test our code and let us know when things do not work
>     correctly.
>  
> + - Suggested-by: names a person who suggested the solution, but may not
> +   have constructed the full patch. A weaker version of `Co-Developed-by`.
> +
> + - Root-caused-by: names a person who diagnosed the root cause of a
> +   problem. This usually indicates significantly more work than a simple
> +   `Reported-by`.
> +
>   - Cc: the named person received a copy of the patch and had the
>     opportunity to comment on it.
>  
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 3d4040322ae1..a1ab82e70b54 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -464,9 +464,11 @@ our $logFunctions = qr{(?x:
>  our $signature_tags = qr{(?xi:
>  	Signed-off-by:|
>  	Acked-by:|
> +	Co-Developed-by:|
>  	Tested-by:|
>  	Reviewed-by:|
>  	Reported-by:|
> +	Root-caused-by:|
>  	Suggested-by:|
>  	To:|
>  	Cc:
> 


-- 
~Randy

Re: [PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

[Kees Cook]

On Wed, Feb 21, 2018 at 8:43 PM, Randy Dunlap <rdunlap@infradead.org> wrote:
> On 02/21/2018 04:37 PM, Kees Cook wrote:
>> As recently pointed out by Linus, "Root-caused-by" is a good tag to include
>> since it can indicate significantly more work than "just" a Reported-by.
>> This adds it and "Suggested-by" (which was also missing) to the documented
>> list of tags. Additionally updates checkpatch.pl to match the process docs.
>>
>> Signed-off-by: Kees Cook <keescook@chromium.org>
>> ---
>>  Documentation/process/5.Posting.rst | 7 +++++++
>>  scripts/checkpatch.pl               | 2 ++
>>  2 files changed, 9 insertions(+)
>
> I would still rather see Co-developed-by: in both the docs and in checkpatch. :(

Hm? It is in docs. This syncs the process doc to checkpatch...

-Kees

>
>> diff --git a/Documentation/process/5.Posting.rst b/Documentation/process/5.Posting.rst
>> index 645fa9c7388a..2ff01f76f02a 100644
>> --- a/Documentation/process/5.Posting.rst
>> +++ b/Documentation/process/5.Posting.rst
>> @@ -234,6 +234,13 @@ The tags in common use are:
>>     people who test our code and let us know when things do not work
>>     correctly.
>>
>> + - Suggested-by: names a person who suggested the solution, but may not
>> +   have constructed the full patch. A weaker version of `Co-Developed-by`.
>> +
>> + - Root-caused-by: names a person who diagnosed the root cause of a
>> +   problem. This usually indicates significantly more work than a simple
>> +   `Reported-by`.
>> +
>>   - Cc: the named person received a copy of the patch and had the
>>     opportunity to comment on it.
>>
>> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
>> index 3d4040322ae1..a1ab82e70b54 100755
>> --- a/scripts/checkpatch.pl
>> +++ b/scripts/checkpatch.pl
>> @@ -464,9 +464,11 @@ our $logFunctions = qr{(?x:
>>  our $signature_tags = qr{(?xi:
>>       Signed-off-by:|
>>       Acked-by:|
>> +     Co-Developed-by:|
>>       Tested-by:|
>>       Reviewed-by:|
>>       Reported-by:|
>> +     Root-caused-by:|
>>       Suggested-by:|
>>       To:|
>>       Cc:
>>
>
>
> --
> ~Randy



-- 
Kees Cook
Pixel Security

Re: [PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

[Randy Dunlap]

On 02/21/2018 10:03 PM, Kees Cook wrote:
> On Wed, Feb 21, 2018 at 8:43 PM, Randy Dunlap <rdunlap@infradead.org> wrote:
>> On 02/21/2018 04:37 PM, Kees Cook wrote:
>>> As recently pointed out by Linus, "Root-caused-by" is a good tag to include
>>> since it can indicate significantly more work than "just" a Reported-by.
>>> This adds it and "Suggested-by" (which was also missing) to the documented
>>> list of tags. Additionally updates checkpatch.pl to match the process docs.
>>>
>>> Signed-off-by: Kees Cook <keescook@chromium.org>
>>> ---
>>>  Documentation/process/5.Posting.rst | 7 +++++++
>>>  scripts/checkpatch.pl               | 2 ++
>>>  2 files changed, 9 insertions(+)
>>
>> I would still rather see Co-developed-by: in both the docs and in checkpatch. :(
> 
> Hm? It is in docs. This syncs the process doc to checkpatch...

Yes, I understand that.  I'm just saying that it's "wrong" in both places.

-- 
~Randy

Re: [PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

[Jonathan Corbet]

On Wed, 21 Feb 2018 16:37:50 -0800
Kees Cook <keescook@chromium.org> wrote:

> As recently pointed out by Linus, "Root-caused-by" is a good tag to include
> since it can indicate significantly more work than "just" a Reported-by.
> This adds it and "Suggested-by" (which was also missing) to the documented
> list of tags. Additionally updates checkpatch.pl to match the process docs.

So I'm not really opposed to this, but I do wonder if we really need to
make a catalog of all the tags that might appear.  A quick grep turns up
stuff like:

	Niced-by
	Based-on-a-patch-by
	Debugged-by
	Requested-by
	Despised-by
	Improvements-by
	Tracked-by
	Analyzed-by
	Bisected-by
	Okay-ished-by
	\o/-by
	Pointed-at-by
	Brown-paper-bag-to-be-worn-by
	Not-longer-ranted-at-by
	Rightfully-ranted-at-by
	Helped-by
	Architected-by
	Also-posted-by
	Complained-about-by
	Mehed-by
	Reminded-by
	Actually-written-by
	Generated-by
	Historical-research-by

Some of these are arguably more useful than others, but I'm not sure we
want to bother documenting even an often-used subset of them.

That said, we can add this one; I'll take the patch if I get an ack from
Joe.

jon

Re: [PATCH] doc: process: Add "Root-caused-by" and "Suggested-by"

[Joe Perches]

On Thu, 2018-02-22 at 10:40 -0700, Jonathan Corbet wrote:
> That said, we can add this one; I'll take the patch if I get an ack from
> Joe.

Meh-ed-by: Joe Perches <joe@perches.com>