From: Tiezhu Yang <yangtiezhu@loongson.cn>
To: Dwaipayan Ray <dwaipayanray1@gmail.com>,
Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Joe Perches <joe@perches.com>, Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v3] Documentation: checkpatch: add description if no filenames are given
Date: Mon, 17 May 2021 17:30:00 +0800 [thread overview]
Message-ID: <1621243800-27702-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. 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@loongson.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
next reply other threads:[~2021-05-17 9:30 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-17 9:30 Tiezhu Yang [this message]
2021-05-17 9:43 ` [PATCH v3] Documentation: checkpatch: add description if no filenames are given Lukas Bulwahn
2021-05-17 9:52 ` Dwaipayan Ray
2021-05-17 13:18 ` Joe Perches
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=1621243800-27702-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).