[PATCH] devtools: fix false positive from checkpatch

[PATCH] devtools: fix false positive from checkpatch

[Stephen Hemminger]

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' |
 
 # print to stdout
 cat
-- 
2.45.2

Re: [PATCH] devtools: fix false positive from checkpatch

[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?

/Bruce

Re: [PATCH] devtools: fix false positive from checkpatch

[Thomas Monjalon]

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.

Re: [PATCH] devtools: fix false positive from checkpatch

[Stephen Hemminger]

On Tue, 17 Sep 2024 16:45:35 +0100
Bruce Richardson <bruce.richardson@intel.com> wrote:

> >  # 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?
> 
> /Bruce

This script removes entries from the codespell dictionary.
So we are removing this line:
	stdio->studio
Which causes:
WARNING:TYPO_SPELLING: 'stdio' may be misspelled - perhaps 'studio'?

[PATCH v2] devtools: fix false positive from checkpatch

[Stephen Hemminger]

The codespell dictionary has "stdio" in its bad word list,
but stdio.h is often used in DPDK code and creates bogus false
positives 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..f2fedd534a 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' |
 
 # print to stdout
 cat
-- 
2.45.2

Re: [PATCH v2] devtools: fix false positive from checkpatch

[Thomas Monjalon]

17/09/2024 18:56, Stephen Hemminger:
> The codespell dictionary has "stdio" in its bad word list,
> but stdio.h is often used in DPDK code and creates bogus false
> positives 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>

Redirected error message to stderr,
and saved the dict path in a variable to avoid redundancy,
and applied, thanks.