From: Matthew Wilcox <willy@infradead.org>
To: Carlos Bilbao <carlos.bilbao@amd.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>,
Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Avadhut Naik <Avadhut.Naik@amd.com>,
Miguel Ojeda <ojeda@kernel.org>,
Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [RFC] Proposal to relax warnings of htmldocs
Date: Wed, 16 Aug 2023 16:57:40 +0100 [thread overview]
Message-ID: <ZNzx9IAtsqP3KC/P@casper.infradead.org> (raw)
In-Reply-To: <16011802-fb29-da56-a1b9-8cc1182dd449@amd.com>
On Wed, Aug 16, 2023 at 10:21:07AM -0500, Carlos Bilbao wrote:
> On 8/16/23 10:15, Matthew Wilcox wrote:
> > I wasn't proposing making W=1 builds the default; I was proposing
> > running kernel-doc -none at all levels.
>
> More strict warning level, right? My concern is the same.
The problem you're seeing with kernel-doc warning about undocumented
fields / parameters is due to people not running kernel-doc -none.
So I'm proposing this:
diff --git a/scripts/Makefile.build b/scripts/Makefile.build
index 82e3fb19fdaf..52f57c0c5227 100644
--- a/scripts/Makefile.build
+++ b/scripts/Makefile.build
@@ -100,11 +100,9 @@ else ifeq ($(KBUILD_CHECKSRC),2)
cmd_force_checksrc = $(CHECK) $(CHECKFLAGS) $(c_flags) $<
endif
-ifneq ($(KBUILD_EXTRA_WARN),)
- cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $(KDOCFLAGS) \
+cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $(KDOCFLAGS) \
$(if $(findstring 2, $(KBUILD_EXTRA_WARN)), -Wall) \
$<
-endif
# Compile C sources (.c)
# ---------------------------------------------------------------------------
Now everybody runs kernel-doc -none on every build and you don't get to
see that problem any more.
next prev parent reply other threads:[~2023-08-16 15:58 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-08-15 18:15 [RFC] Proposal to relax warnings of htmldocs Carlos Bilbao
2023-08-15 18:23 ` Jonathan Corbet
2023-08-15 18:35 ` Miguel Ojeda
2023-08-15 18:41 ` Matthew Wilcox
2023-08-15 18:48 ` Carlos Bilbao
2023-08-16 11:01 ` Jani Nikula
2023-08-16 15:12 ` Carlos Bilbao
2023-08-16 15:15 ` Matthew Wilcox
2023-08-16 15:21 ` Carlos Bilbao
2023-08-16 15:57 ` Matthew Wilcox [this message]
2023-08-16 16:47 ` Carlos Bilbao
2023-08-16 14:54 ` Carlos Bilbao
2023-08-16 15:04 ` Jonathan Corbet
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=ZNzx9IAtsqP3KC/P@casper.infradead.org \
--to=willy@infradead.org \
--cc=Avadhut.Naik@amd.com \
--cc=akiyks@gmail.com \
--cc=carlos.bilbao@amd.com \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=miguel.ojeda.sandonis@gmail.com \
--cc=ojeda@kernel.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).