Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Tiezhu Yang <yangtiezhu@loongson.cn>
To:     Andy Whitcroft <apw@canonical.com>, Joe Perches <joe@perches.com>,
        Dwaipayan Ray <dwaipayanray1@gmail.com>,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc:     linux-kernel@vger.kernel.org
Subject: [PATCH] checkpatch: add help info if no filenames are given
Date:   Tue, 18 May 2021 09:25:01 +0800
Message-Id: <1621301101-10650-1-git-send-email-yangtiezhu@loongson.cn>
Precedence: bulk

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.
 EOM
 
 	exit($exitcode);
-- 
2.1.0