Skip to contentSkip to conversation

checkpatch: Documentation: include sign off for reverts

PATCH In review Aditya Srivastava 2 participants 6 messages Nov 10, 2020

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 checkpatch: Documentation: include sign off for reverts

Currently, we do not have any documentation on commit reverts regarding the requirement of Signed-off-by tag for it. This may be misleading to the users.

On evaluating MISSING_SIGN_OFF over v4.13..v5.8, it was found that 4 out of 11 cases for this error is because of missing sign offs in revert commits.

Add documentation regarding the same.

---
 Documentation/process/submitting-patches.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/process/submitting-patches.rst +2 -0
index 83d9a82055a7..ff065e1f6a25 100644
@@ -404,6 +404,8 @@ then you just add a line saying::
 
 using your real name (sorry, no pseudonyms or anonymous contributions.)
 This will be done for you automatically if you use ``git commit -s``.
+Also reverts should include a Signed-off-by. ``git revert -s`` does
+that for you.
 
 Some people also put extra tags at the end.  They'll just be ignored for
 now, but you can do this to mark internal company procedures or just
Signature · 6 lines
2.17.1

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
#1 lore raw
Quoted 6 lines · Aditya Srivastava

Currently, we do not have any documentation on commit reverts regarding the requirement of Signed-off-by tag for it. This may be misleading to the users.

On evaluating MISSING_SIGN_OFF over v4.13..v5.8, it was found that

Just some minor nitpicking on wording:

Evaluating MISSING_SIGN_OFF checkpatch warnings on v4.13..v5.8 showed that

Quoted 1 line

4 out of 11 cases for this error is because of missing sign offs in

4 out of 11 cases missing a sign-off are revert commits.

Quoted 4 lines

revert commits.

Add documentation regarding the same.

...to document the community consensus and let readers know.

Send the revised patch out to the appropriate developers and mailing lists and please CC me and Joe (because it is also on checkpatch rules).

Quoted 19 lines
---
 Documentation/process/submitting-patches.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/process/submitting-patches.rst +2 -1
index 83d9a82055a7..ff065e1f6a25 100644
@@ -404,6 +404,8 @@ then you just add a line saying::
 
 using your real name (sorry, no pseudonyms or anonymous contributions.)
 This will be done for you automatically if you use ``git commit -s``.
+Also reverts should include a Signed-off-by. ``git revert -s`` does
+that for you.
 
 Some people also put extra tags at the end.  They'll just be ignored for
 now, but you can do this to mark internal company procedures or just
--
Quoted 2 lines

2.17.1

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

author
#2 lore raw
Quoted 16 lines · Lukas Bulwahn
Quoted 6 lines · Aditya Srivastava

Currently, we do not have any documentation on commit reverts regarding the requirement of Signed-off-by tag for it. This may be misleading to the users.

On evaluating MISSING_SIGN_OFF over v4.13..v5.8, it was found that

Just some minor nitpicking on wording:

Evaluating MISSING_SIGN_OFF checkpatch warnings on v4.13..v5.8 showed that

Quoted 1 line

4 out of 11 cases for this error is because of missing sign offs in

4 out of 11 cases missing a sign-off are revert commits.

Quoted 2 lines

revert commits.

Quoted 9 lines
Quoted 2 lines

Add documentation regarding the same.

...to document the community consensus and let readers know.

Send the revised patch out to the appropriate developers and mailing lists and please CC me and Joe (because it is also on checkpatch rules).

Thanks for reviewing. I have updated the message. Actually when I ran ./scripts/get_maintainer.pl over this patch I am getting a long list of maintainers, so I wanted to confirm once if I should send to everyone in this list.

Jonathan Corbet <[email protected]> (maintainer:DOCUMENTATION,commit_signer:9/11=82%)
Drew DeVault <[email protected]> (commit_signer:4/11=36%,authored:4/11=36%,added_lines:53/80=66%,removed_lines:212/228=93%) Mauro Carvalho Chehab <[email protected]> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%,removed_lines:13/228=6%) Krzysztof Kozlowski <[email protected]> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%)
Greg Kroah-Hartman <[email protected]> (commit_signer:1/11=9%) Aditya Srivastava <[email protected]> (authored:1/11=9%)
"Alexander A. Klimov" <[email protected]> (authored:1/11=9%)
Tom Rix <[email protected]> (added_lines:5/80=6%)
[email protected] (open list:DOCUMENTATION) [email protected] (open list)

Thanks
Aditya
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

#3 lore raw
Quoted 32 lines · Aditya
Quoted 16 lines · Lukas Bulwahn
Quoted 6 lines · Aditya Srivastava

Currently, we do not have any documentation on commit reverts regarding the requirement of Signed-off-by tag for it. This may be misleading to the users.

On evaluating MISSING_SIGN_OFF over v4.13..v5.8, it was found that

Just some minor nitpicking on wording:

Evaluating MISSING_SIGN_OFF checkpatch warnings on v4.13..v5.8 showed that

Quoted 1 line

4 out of 11 cases for this error is because of missing sign offs in

4 out of 11 cases missing a sign-off are revert commits.

Quoted 2 lines

revert commits.

Quoted 9 lines
Quoted 2 lines

Add documentation regarding the same.

...to document the community consensus and let readers know.

Send the revised patch out to the appropriate developers and mailing lists and please CC me and Joe (because it is also on checkpatch rules).

Thanks for reviewing. I have updated the message. Actually when I ran ./scripts/get_maintainer.pl over this patch I am getting a long list of maintainers, so I wanted to confirm once if I should send to everyone in this list.

Quoted 4 lines

Jonathan Corbet <[email protected]> (maintainer:DOCUMENTATION,commit_signer:9/11=82%)
Drew DeVault <[email protected]> (commit_signer:4/11=36%,authored:4/11=36%,added_lines:53/80=66%,removed_lines:212/228=93%)

It could be that Drew was contracted long ago and is not in the community anymore.

You can drop these five people:

Quoted 7 lines

Mauro Carvalho Chehab <[email protected]> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%,removed_lines:13/228=6%) Krzysztof Kozlowski <[email protected]> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%)
Greg Kroah-Hartman <[email protected]> (commit_signer:1/11=9%) "Alexander A. Klimov" <[email protected]> (authored:1/11=9%)
Tom Rix <[email protected]> (added_lines:5/80=6%)

These are the right mailing lists:

Quoted 3 lines

[email protected] (open list:DOCUMENTATION) [email protected] (open list)

Lukas
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

#4 lore raw
Quoted 29 lines · Lukas Bulwahn
Quoted 27 lines · Aditya
Quoted 25 lines · Lukas Bulwahn
Quoted 6 lines · Aditya Srivastava

Currently, we do not have any documentation on commit reverts regarding the requirement of Signed-off-by tag for it. This may be misleading to the users.

On evaluating MISSING_SIGN_OFF over v4.13..v5.8, it was found that

Just some minor nitpicking on wording:

Evaluating MISSING_SIGN_OFF checkpatch warnings on v4.13..v5.8 showed that

Quoted 1 line

4 out of 11 cases for this error is because of missing sign offs in

4 out of 11 cases missing a sign-off are revert commits.

Quoted 4 lines

revert commits.

Add documentation regarding the same.

...to document the community consensus and let readers know.

Send the revised patch out to the appropriate developers and mailing lists and please CC me and Joe (because it is also on checkpatch rules).

Quoted 5 lines
Quoted 5 lines

Thanks for reviewing. I have updated the message. Actually when I ran ./scripts/get_maintainer.pl over this patch I am getting a long list of maintainers, so I wanted to confirm once if I should send to everyone in this list.

Maybe you misunderstand my previous email:

you should send it to those two people:

Quoted 7 lines
Quoted 4 lines

Jonathan Corbet <[email protected]> (maintainer:DOCUMENTATION,commit_signer:9/11=82%)
Drew DeVault <[email protected]> (commit_signer:4/11=36%,authored:4/11=36%,added_lines:53/80=66%,removed_lines:212/228=93%)

Quoted 5 lines

It could be that Drew was contracted long ago and is not in the community anymore.

You can drop these five people:

And "drop from the list" means: You should not send it to those five people below.

Quoted 8 lines
Quoted 7 lines

Mauro Carvalho Chehab <[email protected]> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%,removed_lines:13/228=6%) Krzysztof Kozlowski <[email protected]> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%)
Greg Kroah-Hartman <[email protected]> (commit_signer:1/11=9%) "Alexander A. Klimov" <[email protected]> (authored:1/11=9%)
Tom Rix <[email protected]> (added_lines:5/80=6%)

Quoted 8 lines

These are the right mailing lists:

Quoted 3 lines

[email protected] (open list:DOCUMENTATION) [email protected] (open list)

Lukas

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

#5 lore raw

Also I just noticed that the subject line is a mess.

just make it "Documentation: include sign off for reverts"; remove checkpatch. This patch is not about checkpatch.

I have seen the patch already on linux-doc. You can fix the recipient list and the subject line and simply send out a PATCH v2.

Sorry for the confusion, I did not review as carefully as I should have, and I must have been not clear enough on what I wrote.

Quoted 48 lines · Lukas Bulwahn
Quoted 29 lines · Lukas Bulwahn
Quoted 27 lines · Aditya
Quoted 25 lines · Lukas Bulwahn
Quoted 6 lines · Aditya Srivastava

Currently, we do not have any documentation on commit reverts regarding the requirement of Signed-off-by tag for it. This may be misleading to the users.

On evaluating MISSING_SIGN_OFF over v4.13..v5.8, it was found that

Just some minor nitpicking on wording:

Evaluating MISSING_SIGN_OFF checkpatch warnings on v4.13..v5.8 showed that

Quoted 1 line

4 out of 11 cases for this error is because of missing sign offs in

4 out of 11 cases missing a sign-off are revert commits.

Quoted 4 lines

revert commits.

Add documentation regarding the same.

...to document the community consensus and let readers know.

Send the revised patch out to the appropriate developers and mailing lists and please CC me and Joe (because it is also on checkpatch rules).

Quoted 5 lines
Quoted 5 lines

Thanks for reviewing. I have updated the message. Actually when I ran ./scripts/get_maintainer.pl over this patch I am getting a long list of maintainers, so I wanted to confirm once if I should send to everyone in this list.

Maybe you misunderstand my previous email:

you should send it to those two people:

Quoted 5 lines
Quoted 4 lines

Jonathan Corbet <[email protected]> (maintainer:DOCUMENTATION,commit_signer:9/11=82%)
Drew DeVault <[email protected]> (commit_signer:4/11=36%,authored:4/11=36%,added_lines:53/80=66%,removed_lines:212/228=93%)

Quoted 25 lines
Quoted 5 lines

It could be that Drew was contracted long ago and is not in the community anymore.

You can drop these five people:

And "drop from the list" means: You should not send it to those five people below.

Quoted 16 lines
Quoted 7 lines

Mauro Carvalho Chehab <[email protected]> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%,removed_lines:13/228=6%) Krzysztof Kozlowski <[email protected]> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%)
Greg Kroah-Hartman <[email protected]> (commit_signer:1/11=9%) "Alexander A. Klimov" <[email protected]> (authored:1/11=9%)
Tom Rix <[email protected]> (added_lines:5/80=6%)

These are the right mailing lists:

Quoted 3 lines

[email protected] (open list:DOCUMENTATION) [email protected] (open list)

Lukas

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees