linux-kernel - Re: [PATCH v3] Documentation: checkpatch: add description if no filenames are given

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:   Mon, 17 May 2021 06:18:13 -0700
From:   Joe Perches <joe@...ches.com>
To:     Tiezhu Yang <yangtiezhu@...ngson.cn>,
        Dwaipayan Ray <dwaipayanray1@...il.com>,
        Lukas Bulwahn <lukas.bulwahn@...il.com>,
        Jonathan Corbet <corbet@....net>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3] Documentation: checkpatch: add description if no
 filenames are given

On Mon, 2021-05-17 at 17:30 +0800, Tiezhu Yang wrote:
> After commit 45107ff6d526 ("checkpatch: if no filenames then read stdin"),
> if no filenames are given, it will read patch from stdin rather than exit
> directly. This means the script waits for input indefinitely, which
> confuses new checkpatch users at first.
> 
> Add some basic documentation on this behaviour of checkpatch to lower
> the confusion.

You might also consider adding something to the
checkpatch --help content in checkpatch itself.

> diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
[]
> @@ -22,6 +22,8 @@ Usage::
>  
>    ./scripts/checkpatch.pl [OPTION]... [FILE]...
> 
> +When FILE is -, or absent, checkpatch reads from standard input.
> +
>  Available options: