Re: [PATCH] checkpatch: add help info if no filenames are given

From: Joe Perches <joe@perches.com>
To: Tiezhu Yang <yangtiezhu@loongson.cn>,
	Andy Whitcroft <apw@canonical.com>,
	Dwaipayan Ray <dwaipayanray1@gmail.com>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: linux-kernel@vger.kernel.org
Subject: Re: [PATCH] checkpatch: add help info if no filenames are given
Date: Mon, 17 May 2021 19:22:50 -0700	[thread overview]
Message-ID: <b09f7f17f07cf960c26ddb522558e3ab5187ba83.camel@perches.com> (raw)
In-Reply-To: <1621301101-10650-1-git-send-email-yangtiezhu@loongson.cn>

On Tue, 2021-05-18 at 09:25 +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 help info on this behaviour of checkpatch to lower the confusion.
> 
> Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn>
> ---
>  scripts/checkpatch.pl | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index 23697a6..825eb00 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -80,6 +80,8 @@ sub help {
>  Usage: $P [OPTION]... [FILE]...
>  Version: $V
>  
> 
> +When FILE is -, or absent, checkpatch reads from standard input.
> +
>  Options:
>    -q, --quiet                quiet
>    -v, --verbose              verbose mode
> @@ -138,8 +140,6 @@ Options:
>    --kconfig-prefix=WORD      use WORD as a prefix for Kconfig symbols (default
>                               ${CONFIG_})
>    -h, --help, --version      display this help and exit
> -
> -When FILE is - read standard input.

This line is redundant/unnecessary.

>  EOM
>  
> 
>  	exit($exitcode);