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;
MIME-Version: 1.0
References: <1621224036-32092-1-git-send-email-yangtiezhu@loongson.cn>
In-Reply-To: <1621224036-32092-1-git-send-email-yangtiezhu@loongson.cn>
From:   Dwaipayan Ray <dwaipayanray1@gmail.com>
Date:   Mon, 17 May 2021 11:51:05 +0530
Message-ID: <CABJPP5DRw3pNs0da4HdCLXVHSa6sE88xJOO6C3c_oBESLoWq3A@mail.gmail.com>
Subject: Re: [PATCH] Documentation: checkpatch: add description if no
 filenames are given
To:     Tiezhu Yang <yangtiezhu@loongson.cn>
Cc:     Jonathan Corbet <corbet@lwn.net>, Joe Perches <joe@perches.com>,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>,
        linux-kernel <linux-kernel@vger.kernel.org>,
        linux-doc@vger.kernel.org
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

Hey,

On Mon, May 17, 2021 at 9:30 AM Tiezhu Yang <yangtiezhu@loongson.cn> 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, it is a bit confusing whether the script hangs, I do not quite
> know what to do next util I understand the code logic.

util -> until
>
> 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.
> +

The addition is reasonable but the position of the text is a bit weird.
Let's have it after the Usage:: text:

-----------
diff --git a/Documentation/dev-tools/checkpatch.rst
b/Documentation/dev-tools/checkpatch.rst
index d4bb55723a86..7bf1e48207ce 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
@@ -210,7 +212,6 @@ Available options:

   Display the help text.

-When FILE is -, or no filenames are given, read standard input.

Message Levels
==============
-------------

Thanks,
Dwaipayan.