2018-12-14 17:37:58

by Jorge Ramirez-Ortiz

[permalink] [raw]
Subject: [PATCH 0/2] Fix Co-Developed-by

The following set unifies the terminology for co-developed patches
(losing the capital in Developed) and adds the rule to the
checkpatch.pl script to stop warnings.

Jorge Ramirez-Ortiz (2):
docs: fix Co-Developed-by docs
checkpatch: add Co-developed-by to signature tags

Documentation/process/submitting-patches.rst | 4 ++--
scripts/checkpatch.pl | 1 +
2 files changed, 3 insertions(+), 2 deletions(-)

--
2.7.4



2018-12-14 17:37:13

by Jorge Ramirez-Ortiz

[permalink] [raw]
Subject: [PATCH 1/2] docs: fix Co-Developed-by docs

The accepted terminology will be Co-developed-by therefore losing the
capital letter from now on.

Signed-off-by: Jorge Ramirez-Ortiz <[email protected]>
---
Documentation/process/submitting-patches.rst | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index c091710..30dc00a 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -510,7 +510,7 @@ tracking your trees, and to people trying to troubleshoot bugs in your
tree.


-12) When to use Acked-by:, Cc:, and Co-Developed-by:
+12) When to use Acked-by:, Cc:, and Co-developed-by:
-------------------------------------------------------

The Signed-off-by: tag indicates that the signer was involved in the
@@ -543,7 +543,7 @@ person it names - but it should indicate that this person was copied on the
patch. This tag documents that potentially interested parties
have been included in the discussion.

-A Co-Developed-by: states that the patch was also created by another developer
+A Co-developed-by: states that the patch was also created by another developer
along with the original author. This is useful at times when multiple people
work on a single patch. Note, this person also needs to have a Signed-off-by:
line in the patch as well.
--
2.7.4


2018-12-14 17:39:04

by Jorge Ramirez-Ortiz

[permalink] [raw]
Subject: [PATCH 2/2] checkpatch: add Co-developed-by to signature tags

As per Documentation/process/submitting-patches, Co-developed-by is a
valid signature.

This commit removes the warning.

Signed-off-by: Jorge Ramirez-Ortiz <[email protected]>
---
scripts/checkpatch.pl | 1 +
1 file changed, 1 insertion(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 93e84c9..b737ca9 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -468,6 +468,7 @@ our $logFunctions = qr{(?x:

our $signature_tags = qr{(?xi:
Signed-off-by:|
+ Co-developed-by:|
Acked-by:|
Tested-by:|
Reviewed-by:|
--
2.7.4


2018-12-14 18:14:29

by Himanshu Jha

[permalink] [raw]
Subject: Re: [PATCH 1/2] docs: fix Co-Developed-by docs

On Fri, Dec 14, 2018 at 06:35:27PM +0100, Jorge Ramirez-Ortiz wrote:
> The accepted terminology will be Co-developed-by therefore losing the
> capital letter from now on.
>
> Signed-off-by: Jorge Ramirez-Ortiz <[email protected]>
> ---

Thanks. ACK!

Finally, the discussion converged at somepoint.

FYI, Cc Jonathan Cameron + IIO list.

> Documentation/process/submitting-patches.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
> index c091710..30dc00a 100644
> --- a/Documentation/process/submitting-patches.rst
> +++ b/Documentation/process/submitting-patches.rst
> @@ -510,7 +510,7 @@ tracking your trees, and to people trying to troubleshoot bugs in your
> tree.
>
>
> -12) When to use Acked-by:, Cc:, and Co-Developed-by:
> +12) When to use Acked-by:, Cc:, and Co-developed-by:
> -------------------------------------------------------
>
> The Signed-off-by: tag indicates that the signer was involved in the
> @@ -543,7 +543,7 @@ person it names - but it should indicate that this person was copied on the
> patch. This tag documents that potentially interested parties
> have been included in the discussion.
>
> -A Co-Developed-by: states that the patch was also created by another developer
> +A Co-developed-by: states that the patch was also created by another developer
> along with the original author. This is useful at times when multiple people
> work on a single patch. Note, this person also needs to have a Signed-off-by:
> line in the patch as well.
> --
> 2.7.4
>

--
Himanshu Jha
Undergraduate Student
Department of Electronics & Communication
Guru Tegh Bahadur Institute of Technology

2018-12-14 20:19:35

by Andrew Morton

[permalink] [raw]
Subject: Re: [PATCH 2/2] checkpatch: add Co-developed-by to signature tags

On Fri, 14 Dec 2018 18:35:28 +0100 Jorge Ramirez-Ortiz <[email protected]> wrote:

> As per Documentation/process/submitting-patches, Co-developed-by is a
> valid signature.
>

I'm with Joe - I find this tag kinda useless and duplicative. But whatever.

But as the documentation says, Co-developed-by must be accompanied by a
Signed-off-by:. It would be helpful if checkpatch were to detect a
failure to do this.


2018-12-14 20:59:23

by Himanshu Jha

[permalink] [raw]
Subject: Re: [PATCH 2/2] checkpatch: add Co-developed-by to signature tags

On Fri, Dec 14, 2018 at 12:16:34PM -0800, Andrew Morton wrote:
> On Fri, 14 Dec 2018 18:35:28 +0100 Jorge Ramirez-Ortiz <[email protected]> wrote:
>
> > As per Documentation/process/submitting-patches, Co-developed-by is a
> > valid signature.
> >
>
> I'm with Joe - I find this tag kinda useless and duplicative. But whatever.

I'm fine either way, just the problem is:

Co-developed-by Vs Co-Developed-by

with checkpatch spitting out that it is not a valid signature.

In the end, I can completely remove the tag from docs if it is useless
and duplicative.

--
Himanshu Jha
Undergraduate Student
Department of Electronics & Communication
Guru Tegh Bahadur Institute of Technology

2018-12-15 17:46:22

by Joe Perches

[permalink] [raw]
Subject: Re: [PATCH 2/2] checkpatch: add Co-developed-by to signature tags

On Fri, 2018-12-14 at 12:16 -0800, Andrew Morton wrote:
> On Fri, 14 Dec 2018 18:35:28 +0100 Jorge Ramirez-Ortiz <[email protected]> wrote:
>
> > As per Documentation/process/submitting-patches, Co-developed-by is a
> > valid signature.
> >
>
> I'm with Joe - I find this tag kinda useless and duplicative. But whatever.
>
> But as the documentation says, Co-developed-by must be accompanied by a
> Signed-off-by:. It would be helpful if checkpatch were to detect a
> failure to do this.

perhaps
---
scripts/checkpatch.pl | 15 ++++++++++++++-
1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 93e84c9504a1..056d4b47ffaf 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2673,7 +2673,20 @@ sub process {
WARN("BAD_SIGN_OFF",
"Duplicate signature\n" . $herecurr);
} else {
- $signatures{$sig_nospace} = 1;
+ $signatures{$sig_nospace} = $herecurr;
+ }
+ }
+
+# Check for "Co-developed-by:" uses without equivalent "Signed-off-by:"
+# $signatures keys are all lower case without spaces
+ if ($rawline =~ /^---$/) {
+ foreach my $sig (keys %signatures) {
+ next if ($sig !~ /^co-developed-by:(.*)/);
+ my $signer = $1;
+ if (!defined $signatures{"signed-off-by:$signer"}) {
+ WARN("CODEVELOPED_WITHOUT_SIGNOFF",
+ "Co-developed-by: used without Signed-off-by: by same person\n" . $signatures{$sig});
+ }
}
}