doc: process: Add "Root-caused-by" and "Suggested-by"
Subsystems (3)
PATCH 1/1 doc: process: Add "Root-caused-by" and "Suggested-by"
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.
--- Documentation/process/5.Posting.rst | 7 +++++++ scripts/checkpatch.pl | 2 ++ 2 files changed, 9 insertions(+)
Documentation/process/5.Posting.rst +7 -0
@@ -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.
scripts/checkpatch.pl +2 -0
@@ -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:
Signature · 6 lines
2.7.4 -- Kees Cook Pixel Security
Joe Perches
maintainerQuoted 4 lines · 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.
[]
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0
[]
scripts/checkpatch.pl our $logFunctions = qr{(?x: · line 474
Quoted 12 lines
scripts/checkpatch.pl +2
-0@@ -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
Quoted 8 lines · Joe Perches
Quoted 4 lines · 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.
[]
scripts/checkpatch.pl
Quoted 1 line
scripts/checkpatch.pl +0
-0[]
Quoted 14 lines
scripts/checkpatch.pl our $logFunctions = qr{(?x: · line 474
Quoted 12 lines
scripts/checkpatch.pl +2
-0@@ -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
Signature · 2 lines
Kees Cook Pixel Security
Randy Dunlap
reviewerQuoted 10 lines · 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 <[email protected]>--- 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. :(
Quoted 35 lines
Documentation/process/5.Posting.rst +7
-0@@ -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.scripts/checkpatch.pl +2
-0@@ -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:
Signature · 1 line
~Randy
Quoted 6 lines · Randy Dunlap
Quoted 5 lines · 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.
Quoted 7 lines
Quoted 5 lines
Signed-off-by Kees Cook <[email protected]>--- 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
Quoted 40 lines
Quoted 26 lines
Documentation/process/5.Posting.rst +7
-0@@ -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.scripts/checkpatch.pl +0
-0@@ -464,9 +464,11 @@ our $logFunctions = qr{(?x: our $signature_tags = qr{(?xi:scripts/checkpatch.pl our $logFunctions = qr{(?x: · line 474
Quoted 10 lines
scripts/checkpatch.pl +2
-0Signed-off-by:| Acked-by:| + Co-Developed-by:| Tested-by:| Reviewed-by:| Reported-by:| + Root-caused-by:| Suggested-by:| To:| Cc:--
~Randy
Signature · 2 lines
Kees Cook Pixel Security
Randy Dunlap
reviewerQuoted 13 lines · Kees Cook
Quoted 12 lines · Randy Dunlap
Quoted 10 lines · 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 <[email protected]>--- Documentation/process/5.Posting.rst | 7 +++++++ scripts/checkpatch.pl | 2 ++ 2 files changed, 9 insertions(+)
Quoted 3 lines
Quoted 1 line
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.
Signature · 1 line
~Randy
Jonathan Corbet
maintainerQuoted 4 lines · On Wed, 21 Feb 2018 16:37:50 -0800 Kees Cook <[email protected]> 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
Joe Perches
maintainerQuoted 2 lines · Jonathan Corbet
That said, we can add this one; I'll take the patch if I get an ack from Joe.