qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Philippe Mathieu-Daudé" <philmd@linaro.org>
To: Stefan Weil <sw@weilnetz.de>, qemu-devel@nongnu.org
Cc: "Thomas Huth" <thuth@redhat.com>,
	"Peter Maydell" <peter.maydell@linaro.org>,
	"Richard Henderson" <richard.henderson@linaro.org>,
	"open list:PReP" <qemu-ppc@nongnu.org>,
	"Daniel P. Berrangé" <berrange@redhat.com>
Subject: Re: [RFC PATCH] Add new build target 'check-spelling'
Date: Mon, 31 Oct 2022 16:40:40 +0100	[thread overview]
Message-ID: <8b60c05a-c687-30ec-160b-52a4993c65fd@linaro.org> (raw)
In-Reply-To: <20221031074317.377366-1-sw@weilnetz.de>

On 31/10/22 08:43, Stefan Weil via wrote:
> `make check-spelling` can now be used to get a list of spelling errors.
> It uses the latest version of codespell, a spell checker implemented in Python.
> 
> Signed-off-by: Stefan Weil <sw@weilnetz.de>
> ---
> 
> This RFC can already be used for manual tests, but still reports false
> positives, mostly because some variable names are interpreted as words.
> These words can either be ignored in the check, or in some cases the code
> might be changed to use different variable names.
> 
> The check currently only skips a few directories and files, so for example
> checked out submodules are also checked.
> 
> The rule can be extended to allow user provided ignore and skip lists,
> for example by introducing Makefile variables CODESPELL_SKIP=userfile
> or CODESPELL_IGNORE=userfile. A limited check could be implemented by
> providing a base directory CODESPELL_START=basedirectory, for example
> CODESPELL_START=docs.
> 
> Regards,
> Stefan
> 
>   tests/Makefile.include       | 10 ++++++++++
>   tests/codespell/README.rst   | 18 ++++++++++++++++++
>   tests/codespell/exclude-file |  3 +++
>   tests/codespell/ignore-words | 19 +++++++++++++++++++
>   tests/requirements.txt       |  1 +
>   5 files changed, 51 insertions(+)
>   create mode 100644 tests/codespell/README.rst
>   create mode 100644 tests/codespell/exclude-file
>   create mode 100644 tests/codespell/ignore-words

Just wondering about this list...

> +++ b/tests/codespell/ignore-words
> @@ -0,0 +1,19 @@
> +buid

What is 'buid'? PPC-specific apparently.

> +busses
> +dout
> +falt
> +fpr
> +hace
> +hax
> +hda
> +nd

Apparently 'NIC info'...

> +ot

Is 'ot' MemOp?

> +pard
> +parm
> +ptd
> +ser
> +som
> +synopsys
> +te

Is that 'target endianness'?

> +toke

Where is 'toke'?

> +ue
Where is 'ue'?



  parent reply	other threads:[~2022-10-31 15:41 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-31  7:43 [RFC PATCH] Add new build target 'check-spelling' Stefan Weil via
2022-10-31  7:52 ` Thomas Huth
2022-10-31 10:44   ` Stefan Weil via
2022-10-31 10:50     ` Thomas Huth
2022-10-31 10:52     ` Daniel P. Berrangé
2022-10-31 15:40 ` Philippe Mathieu-Daudé [this message]
2022-10-31 16:45   ` Stefan Weil via

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=8b60c05a-c687-30ec-160b-52a4993c65fd@linaro.org \
    --to=philmd@linaro.org \
    --cc=berrange@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-ppc@nongnu.org \
    --cc=richard.henderson@linaro.org \
    --cc=sw@weilnetz.de \
    --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).