From: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Randy Dunlap <rdunlap@infradead.org>
Subject: Re: [PATCH] scripts/kernel-doc: optionally treat warnings as errors
Date: Mon, 27 Jul 2020 18:18:29 -0500 [thread overview]
Message-ID: <2656144b-2420-de8f-9e4a-9a2306924622@linux.intel.com> (raw)
In-Reply-To: <20200727171506.1e05a50a@lwn.net>
On 7/27/20 6:15 PM, Jonathan Corbet wrote:
> On Mon, 27 Jul 2020 18:09:21 -0500
> Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> wrote:
>
>> Both points were covered by the sentence "A command-line option is
>> provided to the kernel-doc script, as well as a check on environment
>> variables to turn this optional behavior on".
>
>
> Making that more prominent would be good, but a changelog like this should
> say *which* command-line option was provided, and *which* environment
> variables are checked. Don't make people go digging through the patch to
> figure it out. See what I'm getting at?
ok. I tried to avoid duplicating what's in the code, since it's
relatively minimal and self-explanatory but I see your point. Will send
a v2.
prev parent reply other threads:[~2020-07-27 23:18 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-24 23:01 [PATCH] scripts/kernel-doc: optionally treat warnings as errors Pierre-Louis Bossart
2020-07-27 22:28 ` Jonathan Corbet
2020-07-27 23:09 ` Pierre-Louis Bossart
2020-07-27 23:15 ` Jonathan Corbet
2020-07-27 23:18 ` Pierre-Louis Bossart [this message]
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=2656144b-2420-de8f-9e4a-9a2306924622@linux.intel.com \
--to=pierre-louis.bossart@linux.intel.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
/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).