From: "Daniel P. Berrangé" <berrange@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Eric Blake" <eblake@redhat.com>,
"Philippe Mathieu-Daudé" <f4bug@amsat.org>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Thomas Huth" <thuth@redhat.com>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Daniel P. Berrangé" <berrange@redhat.com>
Subject: [PATCH v3 5/9] tests/style: check for commonly doubled up words
Date: Thu, 7 Jul 2022 17:37:16 +0100 [thread overview]
Message-ID: <20220707163720.1421716-6-berrange@redhat.com> (raw)
In-Reply-To: <20220707163720.1421716-1-berrange@redhat.com>
This style check looks for cases where the words
the then in an on if is it but for or at and do to
are repeated in a sentence. It uses a multi-line match to catch the
especially common mistake in docs where the last word on a line is
repeated as the first word of the next line.
There are inevitably be some false positives with this check, for
example, some docs data tables have the same word in adjacent columns.
There are a few different ways to express this text as a regex which
have wildly different execution time. This impl was carefully chosen
to attempt to minimize matching time.
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---
tests/style.yml | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
diff --git a/tests/style.yml b/tests/style.yml
index 704227d8e9..d06c55bb29 100644
--- a/tests/style.yml
+++ b/tests/style.yml
@@ -91,3 +91,33 @@ int_assign_bool:
files: \.c$
prohibit: \<int\>.*= *(true|false)\b
message: use bool type for boolean values
+
+double_words:
+ multiline: true
+ prohibit:
+ terms:
+ - the\s+the
+ - then\s+then
+ - in\s+in
+ - an\s+an
+ - on\s+on
+ - if\s+if
+ - is\s+is
+ - it\s+it
+ - but\s+but
+ - for\s+for
+ - or\s+or
+ - at\s+at
+ - and\s+and
+ - do\s+do
+ - to\s+to
+ - can\s+can
+ prefix: \b(?<!=|@|'|")
+ suffix: \b(?!=|@|'|")
+ message: doubled words
+ ignore:
+ - disas/sparc\.c
+ - pc-bios/
+ - qemu-options\.hx
+ - scripts/checkpatch\.pl
+ - tests/qtest/arm-cpu-features\.c
\ No newline at end of file
--
2.36.1
next prev parent reply other threads:[~2022-07-07 16:46 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-07 16:37 [PATCH v3 0/9] tests: introduce a tree-wide code style checking facility Daniel P. Berrangé
2022-07-07 16:37 ` [PATCH v3 1/9] tests: introduce tree-wide code style checking Daniel P. Berrangé
2022-07-20 16:25 ` Peter Maydell
2022-07-20 16:31 ` Daniel P. Berrangé
2022-07-20 17:08 ` Eric Blake
2022-07-20 17:38 ` Peter Maydell
2022-07-25 15:25 ` Peter Maydell
2022-07-21 14:54 ` Eric Blake
2022-07-07 16:37 ` [PATCH v3 2/9] misc: fix mixups of bool constants with int variables Daniel P. Berrangé
2022-07-11 14:18 ` Peter Maydell
2022-07-07 16:37 ` [PATCH v3 3/9] tests/style: check for " Daniel P. Berrangé
2022-07-11 16:24 ` Philippe Mathieu-Daudé via
2022-07-13 8:21 ` Daniel P. Berrangé
2022-07-07 16:37 ` [PATCH v3 4/9] misc: fix commonly doubled up words Daniel P. Berrangé
2022-07-11 14:21 ` Peter Maydell
2022-07-07 16:37 ` Daniel P. Berrangé [this message]
2022-07-07 16:37 ` [PATCH v3 6/9] misc: ensure qemu/osdep.h is included first in all .c files Daniel P. Berrangé
2022-07-07 16:37 ` [PATCH v3 7/9] tests/style: check qemu/osdep.h is included " Daniel P. Berrangé
2022-07-21 19:13 ` Eric Blake
2022-07-07 16:37 ` [PATCH v3 8/9] misc: remove qemu/osdep.h from headers / included source files Daniel P. Berrangé
2022-07-11 16:20 ` Philippe Mathieu-Daudé via
2022-07-20 17:10 ` Eric Blake
2022-07-07 16:37 ` [PATCH v3 9/9] tests/style: check qemu/osdep.h is NOT included in all .h/.c.inc files Daniel P. Berrangé
2022-07-11 16:21 ` Philippe Mathieu-Daudé via
2022-07-21 19:16 ` Eric Blake
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220707163720.1421716-6-berrange@redhat.com \
--to=berrange@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=eblake@redhat.com \
--cc=f4bug@amsat.org \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=thuth@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).