From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCH v2 1/2] Enable codespell by default. Can be disabled from config file. Date: Fri, 01 Mar 2019 00:01:57 +0100 Message-ID: <1841609.ZLcW5ieq3c@xps> References: <20190213190813.12702-1-msantana@redhat.com> <4146661.2v2ioqZAr6@xps> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7Bit Cc: dev@dpdk.org, Van Haaren Harry , ramirose@gmail.com, Bruce Richardson To: msantana@redhat.com Return-path: Received: from out2-smtp.messagingengine.com (out2-smtp.messagingengine.com [66.111.4.26]) by dpdk.org (Postfix) with ESMTP id 072284C91 for ; Fri, 1 Mar 2019 00:02:04 +0100 (CET) In-Reply-To: List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 28/02/2019 23:09, Michael Santana Francisco: > On 2/28/19 6:21 AM, Thomas Monjalon wrote: > > 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? > codespell has a larger dictionary, about 15000 word fixes whereas > spelling.txt has about 1000. > That's really the only big difference OK > >> 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 > V2 sets DPDK_CHECKPATCH_CODESPELL=enable at the beginning of > checkpatches, right before reading in the config files. > If DPDK_CHECKPATCH_CODESPELL is set in one of the config files it > overwrites the enabled by default. > This way a user can disable it via a config file OK I missed it. > >> 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. > I like your thinking. We can use `if [ -f ]` to see if the path > given is an existing file. > so, if DPDK_CHECKPATCH_CODESPELL is set to enable, then enable it with > default path (the way it is right now) > if DPDK_CHECKPATCH_CODESPELL is set to a valid path to a file then > enable codespell and set --codespellfile to said file > otherwise if it's not set to enable or set to a valid path file, then > assume it's disabled. > Missed anything? Well described. Would be nice to see in v3. Thanks