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

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

[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.

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.

Signed-off-by: Aditya Srivastava <yashsri421@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..fb8261a4be30 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``.
+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
-- 
2.17.1

_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

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

[Jonathan Corbet]

On Tue, 10 Nov 2020 23:17:49 +0530
Aditya Srivastava <yashsri421@gmail.com> wrote:

> 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.
> 
> Signed-off-by: Aditya Srivastava <yashsri421@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..fb8261a4be30 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``.
> +Reverts should also include "Signed-off-by". ``git revert -s`` does that
> +for you.

Applied, thanks.

jon
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees