checkpatches: verify in-reply-to header when possible

PATCH Superseded Robin Jarry 2 participants 4 messages Jul 5, 2024 – Oct 11, 2024

Share & tools

Robin Jarry

author

2024-07-05 15:35 UTC #0 lore raw

PATCH 1/1 checkpatches: verify in-reply-to header when possible

When using checkpatches.sh locally, verify that there is an In-Reply-To header when the patch is a respin (i.e. v2, v3, etc.). This is currently only enforced by the upstream CI but cannot be verified locally.

This cannot be verified when checking commit ids since --in-reply-to is a git-format-patch option which is not specified by checkpatches.sh when generating temporary files.

Here is an example:

 $ git format-patch -v6 -1 --stdout | devtools/checkpatches.sh
 warning: [PATCH v6] graph: expose node context as pointers
 warning: respins must be --in-reply-to=<[email protected]>.
 0/1 valid patch

 $ git format-patch -v6 -1 --stdout --in-reply-to=foo | \
                     devtools/checkpatches.sh
 1/1 valid patch

Link https://git.dpdk.org/tools/dpdk-ci/commit/?id=070b31649e48460b3

Signed-off-by Robin Jarry <[email protected]>

---
 devtools/checkpatches.sh | 13 +++++++++++++
 1 file changed, 13 insertions(+)

devtools/checkpatches.sh +13 -0

index bfacd77f398a..cb1c9972a71f 100755
@@ -405,11 +405,13 @@ status=0
 check () { # <patch-file> <commit>
 	local ret=0
 	local subject=''
+	local check_in_reply_to=false
 	headline_printed=false
 
 	total=$(($total + 1))
 	if [ -n "$1" ] ; then
 		tmpinput=$1
+		check_in_reply_to=true
 	else
 		tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
 		trap "rm -f '$tmpinput'" INT

@@ -419,6 +421,7 @@ check () { # <patch-file> <commit>
 			--no-stat --stdout -1 $commit > "$tmpinput"
 		else
 			cat > "$tmpinput"
+			check_in_reply_to=true
 		fi
 	fi

@@ -426,6 +429,16 @@ check () { # <patch-file> <commit>
 	subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$tmpinput")
 	! $verbose || print_headline "$subject"
 
+	# check In-Reply-To for version > 1
+	if [ "$check_in_reply_to" = true ] \
+		&& echo "$subject" | grep -qi 'v[2-9].*\]' \
+		&& ! grep -qi '^In-Reply-To: ' "$tmpinput"
+	then
+		echo "warning: $subject"
+		echo "warning: respins must be --in-reply-to=<[email protected]>."
+		ret=1
+	fi
+
 	! $verbose || printf 'Running checkpatch.pl:\n'
 	report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null)
 	if [ $? -ne 0 ] ; then

Signature · 1 line

2.45.2

Stephen Hemminger

2024-10-07 20:41 UTC #1 lore raw

Quoted 52 lines · On Fri, 5 Jul 2024 17:35:33 +0200 Robin Jarry <[email protected]> wrote:

When using checkpatches.sh locally, verify that there is an In-Reply-To header when the patch is a respin (i.e. v2, v3, etc.). This is currently only enforced by the upstream CI but cannot be verified locally.
This cannot be verified when checking commit ids since --in-reply-to is a git-format-patch option which is not specified by checkpatches.sh when generating temporary files.
Here is an example:
 $ git format-patch -v6 -1 --stdout | devtools/checkpatches.sh
 warning: [PATCH v6] graph: expose node context as pointers
 warning: respins must be --in-reply-to=<[email protected]>.
 0/1 valid patch
 $ git format-patch -v6 -1 --stdout --in-reply-to=foo | \
                     devtools/checkpatches.sh
 1/1 valid patch
Link https://git.dpdk.org/tools/dpdk-ci/commit/?id=070b31649e48460b3
Signed-off-by Robin Jarry <[email protected]>
---
 devtools/checkpatches.sh | 13 +++++++++++++
 1 file changed, 13 insertions(+)
devtools/checkpatches.sh +3 -0
index bfacd77f398a..cb1c9972a71f 100755
@@ -405,11 +405,13 @@ status=0
 check () { # <patch-file> <commit>
 	local ret=0
 	local subject=''
+	local check_in_reply_to=false
 	headline_printed=false
 
 	total=$(($total + 1))
 	if [ -n "$1" ] ; then
 		tmpinput=$1
+		check_in_reply_to=true
 	else
 		tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
 		trap "rm -f '$tmpinput'" INT
@@ -419,6 +421,7 @@ check () { # <patch-file> <commit>
 			--no-stat --stdout -1 $commit > "$tmpinput"
 		else
 			cat > "$tmpinput"
+			check_in_reply_to=true
 		fi
 	fi
 

devtools/checkpatches.sh check () { # <patch-file> <commit> · line 434

Quoted 6 lines

devtools/checkpatches.sh +3 -0

@@ -426,6 +429,16 @@ check () { # <patch-file> <commit>
 	subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$tmpinput")
 	! $verbose || print_headline "$subject"
 
+	# check In-Reply-To for version > 1
+	if [ "$check_in_reply_to" = true ] \
+		&& echo "$subject" | grep -qi 'v[2-9].*\]' \

Your regex won't work for v10 etc.

Robin Jarry

author

2024-10-07 20:43 UTC #2 lore raw

Stephen Hemminger, Oct 07, 2024 at 22:41:

Quoted 3 lines

devtools/checkpatches.sh check () { # <patch-file> <commit> · line 434
Quoted 1 line
devtools/checkpatches.sh +1 -0
+		&& echo "$subject" | grep -qi 'v[2-9].*\]' \
Your regex won't work for v10 etc.

Good catch. I'll send a v2.

Robin Jarry

author

2024-10-11 08:25 UTC #3 lore raw

PATCH v2 1/1 checkpatches: verify in-reply-to header when possible

In reply to Robin Jarry

This cannot be verified when checking commit ids since --in-reply-to is a git-format-patch option which is not specified by checkpatches.sh when generating temporary files.

Here is an example:

 $ git format-patch -v6 -1 --stdout | devtools/checkpatches.sh
 warning: [PATCH v6] graph: expose node context as pointers
 warning: respins must be --in-reply-to=<[email protected]>.
 0/1 valid patch

 $ git format-patch -v12345 -1 --stdout | devtools/checkpatches.sh
 warning: [PATCH v12345] graph: expose node context as pointers
 warning: respins must be --in-reply-to=<[email protected]>.
 0/1 valid patch

 $ git format-patch -v6 -1 --stdout --in-reply-to=foo | \
                     devtools/checkpatches.sh
 1/1 valid patch

Link https://git.dpdk.org/tools/dpdk-ci/commit/?id=070b31649e48460b3

Signed-off-by Robin Jarry <[email protected]>

Acked-by Stephen Hemminger <[email protected]>

---

Notes:

    v2: fix check for v1[0-9]+

 devtools/checkpatches.sh | 13 +++++++++++++
 1 file changed, 13 insertions(+)

devtools/checkpatches.sh +13 -0

index 17a05e4986fd..b8ca2f67bbd4 100755
@@ -414,11 +414,13 @@ status=0
 check () { # <patch-file> <commit>
 	local ret=0
 	local subject=''
+	local check_in_reply_to=false
 	headline_printed=false
 
 	total=$(($total + 1))
 	if [ -n "$1" ] ; then
 		tmpinput=$1
+		check_in_reply_to=true
 	else
 		tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
 		trap "rm -f '$tmpinput'" INT

@@ -428,6 +430,7 @@ check () { # <patch-file> <commit>
 			--no-stat --stdout -1 $commit > "$tmpinput"
 		else
 			cat > "$tmpinput"
+			check_in_reply_to=true
 		fi
 	fi

@@ -435,6 +438,16 @@ check () { # <patch-file> <commit>
 	subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$tmpinput")
 	! $verbose || print_headline "$subject"
 
+	# check In-Reply-To for version > 1
+	if [ "$check_in_reply_to" = true ] \
+		&& echo "$subject" | grep -Eq '\[[^]]+\<v([2-9]|[1-9][0-9]+)\>[^]]*\]' \
+		&& ! grep -qi '^In-Reply-To: ' "$tmpinput"
+	then
+		echo "warning: $subject"
+		echo "warning: respins must be --in-reply-to=<[email protected]>."
+		ret=1
+	fi
+
 	! $verbose || printf 'Running checkpatch.pl:\n'
 	report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null)
 	if [ $? -ne 0 ] ; then

Signature · 1 line

2.46.2