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

[Linux-kernel-mentees] [PATCH] checkpatch: 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.

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@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

_______________________________________________
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] checkpatch: Documentation: include sign off for reverts

[Lukas Bulwahn]

On Tue, Nov 10, 2020 at 2:42 PM 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.
>
> 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
> 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.

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

> 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..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
>
_______________________________________________
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] checkpatch: Documentation: include sign off for reverts

[Aditya]

On 10/11/20 8:19 pm, Lukas Bulwahn wrote:
> On Tue, Nov 10, 2020 at 2:42 PM 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.
>>
>> 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
>> 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.
> 
>> 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).
> 
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 <corbet@lwn.net>
(maintainer:DOCUMENTATION,commit_signer:9/11=82%)
Drew DeVault <sir@cmpwn.com>
(commit_signer:4/11=36%,authored:4/11=36%,added_lines:53/80=66%,removed_lines:212/228=93%)
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
(commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%,removed_lines:13/228=6%)
Krzysztof Kozlowski <krzk@kernel.org>
(commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%)
Greg Kroah-Hartman <gregkh@linuxfoundation.org> (commit_signer:1/11=9%)
Aditya Srivastava <yashsri421@gmail.com> (authored:1/11=9%)
"Alexander A. Klimov" <grandmaster@al2klimov.de> (authored:1/11=9%)
Tom Rix <trix@redhat.com> (added_lines:5/80=6%)
linux-doc@vger.kernel.org (open list:DOCUMENTATION)
linux-kernel@vger.kernel.org (open list)

Thanks
Aditya
_______________________________________________
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] checkpatch: Documentation: include sign off for reverts

[Lukas Bulwahn]

On Tue, Nov 10, 2020 at 4:27 PM Aditya <yashsri421@gmail.com> wrote:
>
> On 10/11/20 8:19 pm, Lukas Bulwahn wrote:
> > On Tue, Nov 10, 2020 at 2:42 PM 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.
> >>
> >> 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
> >> 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.
> >
> >> 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).
> >
> 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 <corbet@lwn.net>
> (maintainer:DOCUMENTATION,commit_signer:9/11=82%)
> Drew DeVault <sir@cmpwn.com>
> (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:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%,removed_lines:13/228=6%)
> Krzysztof Kozlowski <krzk@kernel.org>
> (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%)
> Greg Kroah-Hartman <gregkh@linuxfoundation.org> (commit_signer:1/11=9%)
> "Alexander A. Klimov" <grandmaster@al2klimov.de> (authored:1/11=9%)
> Tom Rix <trix@redhat.com> (added_lines:5/80=6%)

These are the right mailing lists:

> linux-doc@vger.kernel.org (open list:DOCUMENTATION)
> linux-kernel@vger.kernel.org (open list)
>


Lukas
_______________________________________________
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] checkpatch: Documentation: include sign off for reverts

[Lukas Bulwahn]

On Tue, Nov 10, 2020 at 4:34 PM Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote:
>
> On Tue, Nov 10, 2020 at 4:27 PM Aditya <yashsri421@gmail.com> wrote:
> >
> > On 10/11/20 8:19 pm, Lukas Bulwahn wrote:
> > > On Tue, Nov 10, 2020 at 2:42 PM 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.
> > >>
> > >> 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
> > >> 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.
> > >
> > >> 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).
> > >
> > 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:

> > Jonathan Corbet <corbet@lwn.net>
> > (maintainer:DOCUMENTATION,commit_signer:9/11=82%)
> > Drew DeVault <sir@cmpwn.com>
> > (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:
>

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

> > Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%,removed_lines:13/228=6%)
> > Krzysztof Kozlowski <krzk@kernel.org>
> > (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%)
> > Greg Kroah-Hartman <gregkh@linuxfoundation.org> (commit_signer:1/11=9%)
> > "Alexander A. Klimov" <grandmaster@al2klimov.de> (authored:1/11=9%)
> > Tom Rix <trix@redhat.com> (added_lines:5/80=6%)
>
> These are the right mailing lists:
>
> > linux-doc@vger.kernel.org (open list:DOCUMENTATION)
> > linux-kernel@vger.kernel.org (open list)
> >
>
>
> Lukas
_______________________________________________
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] checkpatch: Documentation: include sign off for reverts

[Lukas Bulwahn]

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.

On Tue, Nov 10, 2020 at 5:45 PM Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote:
>
> On Tue, Nov 10, 2020 at 4:34 PM Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote:
> >
> > On Tue, Nov 10, 2020 at 4:27 PM Aditya <yashsri421@gmail.com> wrote:
> > >
> > > On 10/11/20 8:19 pm, Lukas Bulwahn wrote:
> > > > On Tue, Nov 10, 2020 at 2:42 PM 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.
> > > >>
> > > >> 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
> > > >> 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.
> > > >
> > > >> 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).
> > > >
> > > 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:
>
> > > Jonathan Corbet <corbet@lwn.net>
> > > (maintainer:DOCUMENTATION,commit_signer:9/11=82%)
> > > Drew DeVault <sir@cmpwn.com>
> > > (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:
> >
>
> And "drop from the list" means: You should not send it to those five
> people below.
>
> > > Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > > (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%,removed_lines:13/228=6%)
> > > Krzysztof Kozlowski <krzk@kernel.org>
> > > (commit_signer:2/11=18%,authored:2/11=18%,added_lines:9/80=11%)
> > > Greg Kroah-Hartman <gregkh@linuxfoundation.org> (commit_signer:1/11=9%)
> > > "Alexander A. Klimov" <grandmaster@al2klimov.de> (authored:1/11=9%)
> > > Tom Rix <trix@redhat.com> (added_lines:5/80=6%)
> >
> > These are the right mailing lists:
> >
> > > linux-doc@vger.kernel.org (open list:DOCUMENTATION)
> > > linux-kernel@vger.kernel.org (open list)
> > >
> >
> >
> > Lukas
_______________________________________________
Linux-kernel-mentees mailing list
Linux-kernel-mentees@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

[Linux-kernel-mentees] [PATCH] checkpatch: 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..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

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