From: Tiezhu Yang <yangtiezhu@loongson.cn>
To: Jonathan Corbet <corbet@lwn.net>, Joe Perches <joe@perches.com>,
Dwaipayan Ray <dwaipayanray1@gmail.com>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH] Documentation: checkpatch: add description if no filenames are given
Date: Mon, 17 May 2021 12:00:36 +0800 [thread overview]
Message-ID: <1621224036-32092-1-git-send-email-yangtiezhu@loongson.cn> (raw)
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, it is a bit confusing whether the script hangs, I do not quite
know what to do next util I understand the code logic.
At the beginning, I want to print some info if no filenames are given [1],
but as Joe Perches said, this is unnecessary. It's like trying to make cat
without command line arguments emit something.
So as Lukas Bulwahn suggested, add description for somebody that actually
reads the available kernel documentation on checkpatch.
[1] https://lore.kernel.org/patchwork/patch/1429026/
Signed-off-by: Tiezhu Yang <yangtiezhu@loongson.cn>
---
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..181b95e 100644
--- a/Documentation/dev-tools/checkpatch.rst
+++ b/Documentation/dev-tools/checkpatch.rst
@@ -210,6 +210,8 @@ Available options:
Display the help text.
+When FILE is -, or no filenames are given, read standard input.
+
Message Levels
==============
--
2.1.0
next reply other threads:[~2021-05-17 4:00 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-17 4:00 Tiezhu Yang [this message]
2021-05-17 6:21 ` [PATCH] Documentation: checkpatch: add description if no filenames are given Dwaipayan Ray
2021-05-17 7:12 ` Lukas Bulwahn
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1621224036-32092-1-git-send-email-yangtiezhu@loongson.cn \
--to=yangtiezhu@loongson.cn \
--cc=corbet@lwn.net \
--cc=dwaipayanray1@gmail.com \
--cc=joe@perches.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).