Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [PATCH v2 1/3] scripts: add spelling_sanitizer.sh script
To:     Petr Mladek <pmladek@suse.com>
CC:     Jonathan Corbet <corbet@lwn.net>, Joe Perches <joe@perches.com>,
        "Andrew Morton" <akpm@linux-foundation.org>,
        Nicolas Dichtel <nicolas.dichtel@6wind.com>,
        Jason Baron <jbaron@akamai.com>,
        Stefani Seibold <stefani@seibold.net>,
        Jacob Keller <jacob.e.keller@intel.com>,
        Thomas Graf <tgraf@suug.ch>,
        Herbert Xu <herbert@gondor.apana.org.au>,
        Jens Axboe <axboe@kernel.dk>,
        Sergey Senozhatsky <senozhatsky@chromium.org>,
        "Andy Shevchenko" <andriy.shevchenko@linux.intel.com>,
        Rasmus Villemoes <linux@rasmusvillemoes.dk>,
        linux-kernel <linux-kernel@vger.kernel.org>
References: <20210616122507.896-1-thunder.leizhen@huawei.com>
 <20210616122507.896-2-thunder.leizhen@huawei.com>
 <87bl85yi68.fsf@meer.lwn.net>
 <4c8ca535-398c-0d19-5242-27ed1d3905ec@huawei.com> <YMr6nv1G+bq235nR@alley>
From:   "Leizhen (ThunderTown)" <thunder.leizhen@huawei.com>
Message-ID: <2dd756b6-a02b-0bad-4161-1b3dbc223d84@huawei.com>
Date:   Fri, 18 Jun 2021 10:51:14 +0800
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:60.0) Gecko/20100101
 Thunderbird/60.7.0
MIME-Version: 1.0
In-Reply-To: <YMr6nv1G+bq235nR@alley>
Content-Type: text/plain; charset="utf-8"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Precedence: bulk


On 2021/6/17 15:32, Petr Mladek wrote:
> On Thu 2021-06-17 09:11:05, Leizhen (ThunderTown) wrote:
>>
>>
>> On 2021/6/16 22:53, Jonathan Corbet wrote:
>>> Zhen Lei <thunder.leizhen@huawei.com> writes:
>>>
>>>> The file scripts/spelling.txt recorded a large number of spelling
>>>> "mistake||correction" pairs. These entries are currently maintained in
>>>> order, but the results are not strict. In addition, when someone wants to
>>>> add some new pairs, he either sort them manually or write a script, which
>>>> is clearly a waste of labor. So add this script. For all spelling
>>>> "mistake||correction" pairs, sort based on "correction", then on "mistake",
>>>> and remove duplicates. Sorting based on "mistake" first is not chosen
>>>> because it is uncontrollable.
>>>>
>>>> Signed-off-by: Zhen Lei <thunder.leizhen@huawei.com>
>>>> ---
>>>>  scripts/spelling_sanitizer.sh | 27 +++++++++++++++++++++++++++
>>>>  1 file changed, 27 insertions(+)
>>>>  create mode 100755 scripts/spelling_sanitizer.sh
>>>>
>>>> diff --git a/scripts/spelling_sanitizer.sh b/scripts/spelling_sanitizer.sh
>>>> new file mode 100755
>>>> index 000000000000..603bb7e0e66b
>>>> --- /dev/null
>>>> +++ b/scripts/spelling_sanitizer.sh
>>>> @@ -0,0 +1,27 @@
>>>> +#!/bin/sh -efu
>>>> +# SPDX-License-Identifier: GPL-2.0
>>>> +
>>>> +# To get the traditional sort order that uses native byte values
>>>
>>> So I am of the naive opinion that everything we drop into scripts/
>>> should start with a comment saying why it exists and how to use it.
>>> Otherwise how are people going to benefit from it?
>>
>> Rigth, I will add the description, thanks.
> 
> Ideally, please add also some -h/--help option that would print a short
> description and usage.

OK, I will add it.

> 
> Best Regards,
> Petr
> 
> .
>