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

[Joe Perches]

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: