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;
Message-ID: <da2750b272ce3fd5bc52572036a41c427196c11f.camel@perches.com>
Subject: Re: [PATCH v3] Documentation: checkpatch: add description if no
 filenames are given
From:   Joe Perches <joe@perches.com>
To:     Tiezhu Yang <yangtiezhu@loongson.cn>,
        Dwaipayan Ray <dwaipayanray1@gmail.com>,
        Lukas Bulwahn <lukas.bulwahn@gmail.com>,
        Jonathan Corbet <corbet@lwn.net>
Cc:     linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Date:   Mon, 17 May 2021 06:18:13 -0700
In-Reply-To: <1621243800-27702-1-git-send-email-yangtiezhu@loongson.cn>
References: <1621243800-27702-1-git-send-email-yangtiezhu@loongson.cn>
Content-Type: text/plain; charset="ISO-8859-1"
User-Agent: Evolution 3.38.1-1 
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

On Mon, 2021-05-17 at 17:30 +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. 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.

You might also consider adding something to the
checkpatch --help content in checkpatch itself.

> diff --git 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: