linux-kernel - Re: [PATCH v2 1/3] scripts: add spelling

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <YMr6nv1G+bq235nR@alley>
Date:   Thu, 17 Jun 2021 09:32:46 +0200
From:   Petr Mladek <pmladek@...e.com>
To:     "Leizhen (ThunderTown)" <thunder.leizhen@...wei.com>
Cc:     Jonathan Corbet <corbet@....net>, Joe Perches <joe@...ches.com>,
        Andrew Morton <akpm@...ux-foundation.org>,
        Nicolas Dichtel <nicolas.dichtel@...nd.com>,
        Jason Baron <jbaron@...mai.com>,
        Stefani Seibold <stefani@...bold.net>,
        Jacob Keller <jacob.e.keller@...el.com>,
        Thomas Graf <tgraf@...g.ch>,
        Herbert Xu <herbert@...dor.apana.org.au>,
        Jens Axboe <axboe@...nel.dk>,
        Sergey Senozhatsky <senozhatsky@...omium.org>,
        Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
        Rasmus Villemoes <linux@...musvillemoes.dk>,
        linux-kernel <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v2 1/3] scripts: add spelling_sanitizer.sh script

On Thu 2021-06-17 09:11:05, Leizhen (ThunderTown) wrote:
> 
> 
> On 2021/6/16 22:53, Jonathan Corbet wrote:
> > Zhen Lei <thunder.leizhen@...wei.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@...wei.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.

Best Regards,
Petr