[1/2] Enable codespell from config file.
Checks
Commit Message
Enable turning on codespell from any of the config files for
checkpatches.sh. codespell is a feature by checkpatch.pl that
checks for common spelling mistakes in comments in patches.
This feature is disabled by default. To enable it one must add
the '--codespell' flag to the $options variable in
checkpatches.sh. With this change the user can decide to turn
on codespell from a config file rather than directly modifying
checkpatches.sh
Signed-off-by: Michael Santana <msantana@redhat.com>
---
devtools/checkpatches.sh | 4 ++++
1 file changed, 4 insertions(+)
Comments
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Michael Santana
> Sent: Wednesday, February 13, 2019 7:08 PM
> To: dev@dpdk.org
> Cc: Thomas Monjalon <thomas@monjalon.net>
> Subject: [dpdk-dev] [PATCH 1/2] Enable codespell from config file.
>
> Enable turning on codespell from any of the config files for
> checkpatches.sh. codespell is a feature by checkpatch.pl that
> checks for common spelling mistakes in comments in patches.
>
> This feature is disabled by default. To enable it one must add
> the '--codespell' flag to the $options variable in
> checkpatches.sh. With this change the user can decide to turn
> on codespell from a config file rather than directly modifying
> checkpatches.sh
>
> Signed-off-by: Michael Santana <msantana@redhat.com>
Oh nice, I didn't know checkpatch had a spell check available.
Would it make sense to turn on automatically if the required spelling program is available?
(Perhaps provide an explicit disable if certain people hate the idea..)
I'm a +1 for tools just doing the right thing by default :)
-H
+1
Reviewed-by: Rami Rosen <ramirose@gmail.com>
>
On Wed, Feb 13, 2019 at 07:16:24PM +0000, Van Haaren, Harry wrote:
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Michael Santana
> > Sent: Wednesday, February 13, 2019 7:08 PM
> > To: dev@dpdk.org
> > Cc: Thomas Monjalon <thomas@monjalon.net>
> > Subject: [dpdk-dev] [PATCH 1/2] Enable codespell from config file.
> >
> > Enable turning on codespell from any of the config files for
> > checkpatches.sh. codespell is a feature by checkpatch.pl that
> > checks for common spelling mistakes in comments in patches.
> >
> > This feature is disabled by default. To enable it one must add
> > the '--codespell' flag to the $options variable in
> > checkpatches.sh. With this change the user can decide to turn
> > on codespell from a config file rather than directly modifying
> > checkpatches.sh
> >
> > Signed-off-by: Michael Santana <msantana@redhat.com>
>
> Oh nice, I didn't know checkpatch had a spell check available.
>
> Would it make sense to turn on automatically if the required spelling program is available?
>
> (Perhaps provide an explicit disable if certain people hate the idea..)
>
> I'm a +1 for tools just doing the right thing by default :)
>
+1 for on by default.
@@ -5,6 +5,7 @@
# Load config options:
# - DPDK_CHECKPATCH_PATH
# - DPDK_CHECKPATCH_LINE_LENGTH
+# - DPDK_CHECKPATCH_CODESPELL
. $(dirname $(readlink -e $0))/load-devel-config
VALIDATE_NEW_API=$(dirname $(readlink -e $0))/check-symbol-change.sh
@@ -13,6 +14,9 @@ length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
# override default Linux options
options="--no-tree"
+if [ "$DPDK_CHECKPATCH_CODESPELL" == "enable" ]; then
+ options="$options --codespell"
+fi
options="$options --max-line-length=$length"
options="$options --show-types"
options="$options --ignore=LINUX_VERSION_CODE,\