DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
To: Stephen Hemminger <stephen@networkplumber.org>,
	Bruce Richardson <bruce.richardson@intel.com>
Cc: dev@dpdk.org
Subject: Re: [PATCH] devtools: fix false positive from checkpatch
Date: Tue, 17 Sep 2024 17:49:33 +0200	[thread overview]
Message-ID: <13789507.uLZWGnKmhe@thomas> (raw)
In-Reply-To: <ZumkH86HjT9JDr_S@bricha3-mobl1.ger.corp.intel.com>

17/09/2024 17:45, Bruce Richardson:
> On Tue, Sep 17, 2024 at 08:34:21AM -0700, Stephen Hemminger wrote:
> > The codespell dictionary has "stdio" in its bad word list,
> > but stdio.h is often used in DPDK code and creates bogus false
> > postitives from checkpatch.
> > 
> > Also add a check to the parameters to build-dict.sh so it
> > gives usage error if parameter is missing or does not point
> > to the codespell git clone.
> > 
> > Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> > ---
> >  devtools/build-dict.sh | 5 +++++
> >  1 file changed, 5 insertions(+)
> > 
> > diff --git a/devtools/build-dict.sh b/devtools/build-dict.sh
> > index a8cac49029..96786d2c53 100755
> > --- a/devtools/build-dict.sh
> > +++ b/devtools/build-dict.sh
> > @@ -6,6 +6,10 @@
> >  
> >  # path to local clone of https://github.com/codespell-project/codespell.git
> >  codespell_path=$1
> > +if [ ! -d "$codespell_path/codespell_lib/data" ]; then
> > +	echo "Usage: $0 <path_to_codespell_project>"
> > +	exit 1
> > +fi
> >  
> >  # concatenate codespell dictionaries, except GB/US one
> >  for suffix in .txt _code.txt _informal.txt _names.txt _rare.txt _usage.txt ; do
> > @@ -17,6 +21,7 @@ sed '/^..->/d' |
> >  sed '/^uint->/d' |
> >  sed "/^doesn'->/d" |
> >  sed '/^wasn->/d' |
> > +sed '/stdio->/d' |
> >  
> Seems a good idea. However, why use "stdio" alone rather than using the
> full "stdio.h" header name. Do we expect "stdio" to be used much in
> comments or otherwise?

The dictionary doesn't know stdio.h

You could start with a caret to mimic other entries.





  reply	other threads:[~2024-09-17 15:49 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-17 15:34 Stephen Hemminger
2024-09-17 15:45 ` Bruce Richardson
2024-09-17 15:49   ` Thomas Monjalon [this message]
2024-09-17 16:54   ` Stephen Hemminger
2024-09-17 16:56 ` [PATCH v2] " Stephen Hemminger

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=13789507.uLZWGnKmhe@thomas \
    --to=thomas@monjalon.net \
    --cc=bruce.richardson@intel.com \
    --cc=dev@dpdk.org \
    --cc=stephen@networkplumber.org \
    /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).