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: <1621243800-27702-1-git-send-email-yangtiezhu@loongson.cn>
In-Reply-To: <1621243800-27702-1-git-send-email-yangtiezhu@loongson.cn>
From:   Lukas Bulwahn <lukas.bulwahn@gmail.com>
Date:   Mon, 17 May 2021 11:43:39 +0200
Message-ID: <CAKXUXMyVSf_HsjKhD2FeZzyz6pbA7JN=KkWrvdRswkba60OXww@mail.gmail.com>
Subject: Re: [PATCH v3] Documentation: checkpatch: add description if no
 filenames are given
To:     Tiezhu Yang <yangtiezhu@loongson.cn>
Cc:     Dwaipayan Ray <dwaipayanray1@gmail.com>,
        Joe Perches <joe@perches.com>,
        Jonathan Corbet <corbet@lwn.net>,
        "open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Mon, May 17, 2021 at 11: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. 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.
>

Thanks.

Acked-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>

Dwaipayan, can you acknowledge this as well?

Jonathan, I assume you will pick this up in your doc tree once
Dwaipayan ack is there, right?

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
>