This is a port of the corresponding commit from OVS tree:
An mbox in many cases has the Subject line wrapped at 78 characters
as suggested in RFC 5322. That includes the 'Subject: ' text itself
and the '[PATCH ... ]' tags. So, it is likely that a relatively short
commit subject line gets wrapped. This increases the length by an
extra line break. And we're also not taking into account the tags
themselves while checking the length, resulting in false positive
warnings:
== Checking "patch.mbox" ==
WARNING: The subject, 'area: summary', is over 70 characters, i.e., 73.
Subject: [PATCH] dpif-offload: Add support for offload provider specific
dp-hash.
Lines checked: 671, Warnings: 1, Errors: 0
Fix that by re-joining the split subject and stripping out the tags,
so the subject line length checks are accurate. This doesn't affect
checking the git commits with -N, since we're formatting the patch
without tags in this case and with an explicit %s that doesn't wrap.
There is one last issue with this: if the patch file is fed through
stdin, then we're not parsing it as email and only the first line of
the wrapped subject gets checked resulting in false positive 'dot'
warnings and false negative length check results. Should be fixed
separately.
>Fixes: 1b8fa4a66aa4 ("checkpatch: Add checks for the subject line.")
Acked-by: Eelco Chaudron <[email protected]>
Reviewed-by: Aaron Conole <[email protected]>
Signed-off-by: Ilya Maximets <[email protected]>
Fixes: 0ce21f2adda1 ("checkpatch.py: Port checkpatch related changes from the
OVS repo.")
Signed-off-by: Ilya Maximets <[email protected]>
---
Ideally we would port the fixes in bulk as it was done before, but it
needs some careful consideration due to dictionary exceptions moving and
some other non-trivial changes. And this particular subject length check
fix is needed for the LeadTestKit CI setup, which should come online
sooner rather than later, so sending this as a port of a single patch.
'Fixes' tag is escaped with '>' to avoid checkpatch complaining about it
not being at the beginning of the line. Should probbaly be fixed in OVS
and ported into OVN as well, but it's a separate issue.
tests/checkpatch.at | 17 +++++++++++++++++
utilities/checkpatch.py | 4 ++++
2 files changed, 21 insertions(+)
diff --git a/tests/checkpatch.at b/tests/checkpatch.at
index af95579bf..99f5feaf2 100755
--- a/tests/checkpatch.at
+++ b/tests/checkpatch.at
@@ -707,6 +707,23 @@ try_checkpatch \
"WARNING: The subject, '<area>: <summary>', is over 70 characters, i.e.,
85.
Subject: netdev: This is a way to long commit summary and therefor it
should report a WARNING!"
+try_checkpatch \
+ "Author: A
+ Commit: A
+ Subject: netdev: This is a way to long commit summary and therefor it
+ should report a WARNING!
+
+ Signed-off-by: A" \
+ "WARNING: The subject, '<area>: <summary>', is over 70 characters, i.e.,
85.
+ Subject: netdev: This is a way to long commit summary and therefor it
should report a WARNING!"
+
+try_checkpatch \
+ "Author: A
+ Commit: A
+ Subject: [[PATCH v7 branch-x.y RFC]] area: This one is actually not that
long and should not be reported.
+
+ Signed-off-by: A"
+
AT_CLEANUP
AT_SETUP([checkpatch - hardcoded table numbers])
diff --git a/utilities/checkpatch.py b/utilities/checkpatch.py
index 0c0ddef1d..ed202562f 100755
--- a/utilities/checkpatch.py
+++ b/utilities/checkpatch.py
@@ -1160,6 +1160,10 @@ def ovs_checkpatch_file(filename):
print("Subject missing! Your provisional subject is",
mail['Subject'])
+ subject = ' '.join(mail['Subject'].split())
+ subject = re.sub(r'^\[(PATCH|RFC)[^\]]*\]\s*', '', subject)
+ mail.replace_header('Subject', subject)
+
if run_subject_checks('Subject: ' + mail['Subject'], spellcheck):
result = True
--
2.56.0
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev