linux-kernel - [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-next>] [day] [month] [year] [list]

Message-Id: <1621243800-27702-1-git-send-email-yangtiezhu@loongson.cn>
Date:   Mon, 17 May 2021 17:30:00 +0800
From:   Tiezhu Yang <yangtiezhu@...ngson.cn>
To:     Dwaipayan Ray <dwaipayanray1@...il.com>,
        Lukas Bulwahn <lukas.bulwahn@...il.com>,
        Joe Perches <joe@...ches.com>, Jonathan Corbet <corbet@....net>
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: [PATCH v3] Documentation: checkpatch: add description 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 basic documentation on this behaviour of checkpatch to lower
the confusion.

Signed-off-by: Tiezhu Yang <yangtiezhu@...ngson.cn>
---

v3: Update the commit message, thank you Lukas.

 Documentation/dev-tools/checkpatch.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/dev-tools/checkpatch.rst b/Documentation/dev-tools/checkpatch.rst
index 51fed1b..3eb9ead 100644
--- 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:
 
  - -q,  --quiet
-- 
2.1.0