Re: [PATCH] kernel-doc: add a warning prefix option

From: Matthew Wilcox
Date: Tue Sep 19 2023 - 00:09:11 EST


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".