[Linux-kernel-mentees] [PATCH] checkpatch: Documentation: include sign off for reverts

Aditya Srivastava yashsri421 at gmail.com
Tue Nov 10 13:42:14 UTC 2020


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.

Signed-off-by: Aditya Srivastava <yashsri421 at gmail.com>
---
 Documentation/process/submitting-patches.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 83d9a82055a7..ff065e1f6a25 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -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
-- 
2.17.1



More information about the Linux-kernel-mentees mailing list