linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@linux.intel.com>
To: Matthew Wilcox <willy@infradead.org>,
	Masahiro Yamada <masahiroy@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, Carlos Bilbao <carlos.bilbao@amd.com>
Subject: Re: [PATCH] doc: Always check kernel-doc
Date: Mon, 09 Oct 2023 12:47:31 +0300	[thread overview]
Message-ID: <87fs2k6sb0.fsf@intel.com> (raw)
In-Reply-To: <ZSDXGgofqj+9l16e@casper.infradead.org>

On Sat, 07 Oct 2023, Matthew Wilcox <willy@infradead.org> wrote:
> Can we have a way to enable kernel-doc coverage on a per-directory basis?
> It will stop us from regressing.  I got mm/ down to zero warnings, and
> that promptly regressed.  If we force kernel-doc to run on files under
> mm/, developers will notice breakage quickly.

It's not exactly pretty, but we do this in i915. Unfortunately, it needs
to be done separately and in different ways for kernel-doc in .c and .h.

Check out drivers/gpu/drm/i915/Makefile for ideas.

BR,
Jani.

-- 
Jani Nikula, Intel

  reply	other threads:[~2023-10-09  9:47 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-08-17 14:41 [PATCH] doc: Always check kernel-doc Matthew Wilcox (Oracle)
2023-08-18 16:49 ` Jonathan Corbet
2023-08-18 17:14   ` Matthew Wilcox
2023-08-18 17:19     ` Jonathan Corbet
2023-08-19 22:48     ` Masahiro Yamada
2023-10-07  3:57       ` Matthew Wilcox
2023-10-09  9:47         ` Jani Nikula [this message]
2023-10-03 18:38 ` Jonathan Corbet
2023-10-04 15:15   ` Jani Nikula

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=87fs2k6sb0.fsf@intel.com \
    --to=jani.nikula@linux.intel.com \
    --cc=carlos.bilbao@amd.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=masahiroy@kernel.org \
    --cc=willy@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).