mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Matthew Wilcox <willy@infradead.org>
Cc: linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH] kernel-doc: add a warning prefix option
Date: Mon, 18 Sep 2023 21:30:43 -0700	[thread overview]
Message-ID: <6d36de0a-5ab4-4862-abcc-c7946e6f80b1@infradead.org> (raw)
In-Reply-To: <ZQke26HX9Am3k2sh@casper.infradead.org>



On 9/18/23 21:08, Matthew Wilcox wrote:
> On Mon, Sep 18, 2023 at 07:34:15PM -0700, Randy Dunlap wrote:
>> Add an environment variable ("KDOC_LABEL") for use by scripts/kernel-doc.
>> This variable instructs kernel-doc to label each "warning:" line with
>> a prefix of the KDOC_LABEL value. E.g., using
>>   KDOC_LABEL="doc" ./scripts/kernel-doc -none -Wall kernel/panic.c
>> causes kernel-doc warnings to be emitted as "doc warning:", like this:
>>   kernel/panic.c:497: doc warning: No description found for return value of 'print_tainted'
>>
>> This can aid either in finding or eliminating kernel-doc warnings.
> 
> I worry this will lead to people saying "Oh, it's just a doc warning,
> so I ignored it".

Yeah, that's a fair comment.

I'll find some other way to do what I want to do.

Thanks.
-- 
~Randy

      reply	other threads:[~2023-09-19  4:30 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-19  2:34 Randy Dunlap
2023-09-19  4:08 ` Matthew Wilcox
2023-09-19  4:30   ` Randy Dunlap [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=6d36de0a-5ab4-4862-abcc-c7946e6f80b1@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.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

all inboxes | Powered by JetHome®