2021-05-19 10:18:37

by Tiezhu Yang

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

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 <[email protected]>
---
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.
EOM

exit($exitcode);
--
2.1.0

2021-05-19 11:24:33

by Joe Perches

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

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 <[email protected]>
> ---
> ?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);

2021-05-19 11:24:36

by Tiezhu Yang

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

On 05/18/2021 10:22 AM, Joe Perches wrote:
> 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 <[email protected]>
>> ---
>> 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.

This commit adds
"When FILE is -, or absent, checkpatch reads from standard input."
and delete
"When FILE is - read standard input."

>
>> EOM
>>
>>
>> exit($exitcode);