From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas@monjalon.net>
Subject: Re: [PATCH v2 1/2] Enable codespell by default. Can be
	disabled from config file.
Date: Thu, 28 Feb 2019 12:21:58 +0100
Message-ID: <4146661.2v2ioqZAr6@xps>
References: <20190213190813.12702-1-msantana@redhat.com>
 <20190214193547.30783-1-msantana@redhat.com>
 <20190214193547.30783-2-msantana@redhat.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org, Van Haaren Harry <harry.van.haaren@intel.com>,
 ramirose@gmail.com, Bruce Richardson <bruce.richardson@intel.com>
To: Michael Santana <msantana@redhat.com>
Return-path: <dev-bounces@dpdk.org>
Received: from out2-smtp.messagingengine.com (out2-smtp.messagingengine.com
 [66.111.4.26]) by dpdk.org (Postfix) with ESMTP id B9D2B37AF
 for <dev@dpdk.org>; Thu, 28 Feb 2019 12:22:07 +0100 (CET)
In-Reply-To: <20190214193547.30783-2-msantana@redhat.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

14/02/2019 20:35, Michael Santana:
> Enable codespell by default.
> codespell is a feature by checkpatch.pl that
> checks for common spelling mistakes in patches.

What is the difference between codespell and spelling.txt included
with checkpatch?
Is it just a different dictionary?

> This feature is disabled by default. To enable it one must add
> the '--codespell' flag to the $options variable in
> checkpatches.sh.

We need also to specify the dictionary path if not in
/usr/share/codespell/dictionary.txt
In my case, it is in /usr/lib/python3.7/site-packages/codespell_lib/data/dictionary.txt

> With this change codespell is enabled by default.

It seems it is not enabled by default,
because we need DPDK_CHECKPATCH_CODESPELL=enable

> The user can decide to turn off codespell from a one of the config
> files read by checkpatches.sh.
[...]
>  # override default Linux options
>  options="--no-tree"
> +if [ "$DPDK_CHECKPATCH_CODESPELL" == "enable" ]; then

What about allowing either "enable" or a path?
If it is a path (have some slash), then we can add --codespellfile option.

> +    options="$options --codespell"
> +fi
>  options="$options --max-line-length=$length"
>  options="$options --show-types"
>  options="$options --ignore=LINUX_VERSION_CODE,\
>