linux-kernel - Re: [PATCH] kunit: tool: more descriptive metavars/--help output

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] [day] [month] [year] [list]

Date:   Sat, 26 Feb 2022 13:22:50 -0800
From:   Daniel Latypov <dlatypov@...gle.com>
To:     David Gow <davidgow@...gle.com>
Cc:     Brendan Higgins <brendanhiggins@...gle.com>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        KUnit Development <kunit-dev@...glegroups.com>,
        "open list:KERNEL SELFTEST FRAMEWORK" 
        <linux-kselftest@...r.kernel.org>,
        Shuah Khan <skhan@...uxfoundation.org>
Subject: Re: [PATCH] kunit: tool: more descriptive metavars/--help output

On Fri, Feb 25, 2022 at 8:29 PM David Gow <davidgow@...gle.com> wrote:
> > @@ -292,11 +290,11 @@ def add_common_opts(parser) -> None:
> >                              help='Path to Kconfig fragment that enables KUnit tests.'
> >                              ' If given a directory, (e.g. lib/kunit), "/.kunitconfig" '
> >                              'will get  automatically appended.',
> > -                            metavar='kunitconfig')
> > +                            metavar='KUNITCONFIG')
>
> Is it worth making this something like FILE or PATH instead.
> PATH_TO_KUNITCONFIG would be verbose, but this is a path being given,
> so just KUNITCONFIG is still a bit useless.

Here's what the complete help output looks like right now:
  --kunitconfig KUNITCONFIG
                        Path to Kconfig fragment that enables KUnit tests. If
                        given a directory, (e.g. lib/kunit), "/.kunitconfig"
                        will get automatically appended.

So I didn't think it mattered too much if we left it as-is.
But I like PATH (since users can use a dir, FILE felt potentially
misleading, even if  technically correct).

Will send a v2 with the typo in the commit fixed and this changed to PATH.