Skip to contentSkip to conversation

Documentation: include sign off for reverts

PATCH Applied Aditya Srivastava 2 participants 2 messages Nov 10, 2020 – Nov 13, 2020

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

PATCH v3 1/1 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.

Evaluating MISSING_SIGN_OFF checkpatch warnings on v4.13..v5.8 showed that 4 out of 11 cases missing a sign-off are revert commits.

Add documentation regarding the same to document the community consensus and let readers know.

---
 Documentation/process/submitting-patches.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/process/submitting-patches.rst +2 -0
index 83d9a82055a7..fb8261a4be30 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``.
+Reverts should also include "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 · 1 line
2.17.1
maintainer Applied
#1 lore raw
Quoted 20 lines · On Tue, 10 Nov 2020 23:17:49 +0530 Aditya Srivastava <[email protected]>…

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.

Evaluating MISSING_SIGN_OFF checkpatch warnings on v4.13..v5.8 showed that 4 out of 11 cases missing a sign-off are revert commits.

Add documentation regarding the same to document the community consensus and let readers know.

---
 Documentation/process/submitting-patches.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/process/submitting-patches.rst +0 -0
index 83d9a82055a7..fb8261a4be30 100644

Documentation/process/submitting-patches.rst then you just add a line saying:: · line 408

Quoted 5 lines
Documentation/process/submitting-patches.rst +2 -0
@@ -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``.
+Reverts should also include "Signed-off-by". ``git revert -s`` does that
+for you.

Applied, thanks.

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