From: Matthew Wilcox <willy@infradead.org>
To: Masahiro Yamada <yamada.masahiro@socionext.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Michal Marek <mmarek@suse.com>,
Linux Kbuild mailing list <linux-kbuild@vger.kernel.org>,
Matthew Wilcox <mawilcox@microsoft.com>
Subject: Re: [PATCH] Check all .c files for bad kernel-doc comments
Date: Mon, 30 Oct 2017 06:40:07 -0700 [thread overview]
Message-ID: <20171030134007.GA2846@bombadil.infradead.org> (raw)
In-Reply-To: <CAK7LNATB+mJgMi4sfxb04zYwE5hfv2zONiBHXXtk7wq=No4DNw@mail.gmail.com>
On Mon, Oct 30, 2017 at 12:40:20PM +0900, Masahiro Yamada wrote:
> 2017-10-28 4:41 GMT+09:00 Matthew Wilcox <willy@infradead.org>:
> > Implement a '-none' output mode for kernel-doc which will only output
> > warning messages, and suppresses the warning message about there being
> > no kernel-doc in the file. Add it to the rule to build .o files from .c
> > files, so it will check all .c files that have been modified.
> >
> > Adds about 1300 warnings to my build, but will hopefully discourage
> > people from introducing more kerneldoc mistakes.
>
> Basically, I think this is good,
> but it is controversial to sprinkle warnings by default.
Yes, it is. I just got three nastygrams from 01.org ;-)
But if it's not turned on by default, then people aren't going to notice
when they introduce new warnings. I think it needs to be up to someone
like Andrew or Linus to decide when to add these warnings by default.
Maybe we should do something like you have below for now, then work on
cleaning up a few hundred of these warnings, then enable this by default?
Thanks for looking at this!
> Maybe,
>
> ifeq ($(KBUILD_ENABLE_EXTRA_GCC_CHECKS),)
> cmd_checkdoc = $(srctree)/scripts/kernel-doc -none $< ;
> endif
>
>
> so that this is checked only when W=... is given?
next prev parent reply other threads:[~2017-10-30 13:40 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-27 19:41 Matthew Wilcox
2017-10-29 20:22 ` kbuild test robot
2017-10-29 20:37 ` kbuild test robot
2017-10-30 3:40 ` Masahiro Yamada
2017-10-30 13:40 ` Matthew Wilcox [this message]
2017-10-30 15:12 ` Masahiro Yamada
2017-10-30 15:19 ` Jani Nikula
2017-10-30 20:51 ` Matthew Wilcox
2017-10-31 8:13 ` Jani Nikula
2017-11-20 18:40 ` Matthew Wilcox
2017-11-20 19:14 ` 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=20171030134007.GA2846@bombadil.infradead.org \
--to=willy@infradead.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mawilcox@microsoft.com \
--cc=mmarek@suse.com \
--cc=yamada.masahiro@socionext.com \
/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
all inboxes | Powered by JetHome®