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: <1621052131-16309-1-git-send-email-yangtiezhu@loongson.cn> <68e897fec0e6258b2a964908af650d8608189454.camel@perches.com>
In-Reply-To: <68e897fec0e6258b2a964908af650d8608189454.camel@perches.com>
From:   Lukas Bulwahn <lukas.bulwahn@gmail.com>
Date:   Sun, 16 May 2021 10:49:21 +0200
Message-ID: <CAKXUXMw-XGs2s0tvx8JULddWhG8=i3wJk2=efpdZC5z2ah6kVg@mail.gmail.com>
Subject: Re: [PATCH] checkpatch: Print some info if no filenames are given
To:     Tiezhu Yang <yangtiezhu@loongson.cn>
Cc:     Andy Whitcroft <apw@canonical.com>,
        Dwaipayan Ray <dwaipayanray1@gmail.com>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
        Joe Perches <joe@perches.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

On Sat, May 15, 2021 at 6:26 AM Joe Perches <joe@perches.com> wrote:
>
> On Sat, 2021-05-15 at 12:15 +0800, Tiezhu Yang 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 better to print some info about what to do next, otherwise
> > it is a bit confusing whether the script hangs.
>
> I think this is unnecessary.
> It's like trying to make cat without command line arguments emit something.
>

Tiezhu, if you think this behaviour of checkpatch needs a description
and explanation that the informed users* of checkpatch would value,
you may submit a patch to the kernel's checkpatch documentation,
./Documentation/dev-tools/checkpatch.rst (or to see a rendered
version, e.g., https://www.kernel.org/doc/html/latest/dev-tools/checkpatch.html).
You might want to add a few example invocations of checkpatch and then
explain with an example that checkpatch consumes stdin, if no patch
file is given as argument.

Looking forward to your patch to the documentation...

*informed user = "somebody that actually reads the available kernel
documentation on checkpatch"

Lukas