linux-kernel - Re: [PATCH v4] kernel.h: add comments for system

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <491c3022-cef8-4860-a945-c9c4a3b63c09@infradead.org>
Date: Fri, 5 Sep 2025 15:00:38 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Jani Nikula <jani.nikula@...ux.intel.com>, linux-kernel@...r.kernel.org
Cc: "Rafael J. Wysocki" <rafael@...nel.org>,
 Andrew Morton <akpm@...ux-foundation.org>,
 Greg Kroah-Hartman <gregkh@...uxfoundation.org>, Pavel Machek
 <pavel@....cz>, Len Brown <len.brown@...el.com>, linux-pm@...r.kernel.org,
 Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
 Mauro Carvalho Chehab <mchehab@...nel.org>,
 "James E.J. Bottomley" <James.Bottomley@...senPartnership.com>
Subject: Re: [PATCH v4] kernel.h: add comments for system_states

On 9/5/25 2:02 AM, Jani Nikula wrote:
> On Wed, 03 Sep 2025, Randy Dunlap <rdunlap@...radead.org> wrote:
>> Provide some basic comments about the system_states and what they imply.
>> Also convert the comments to kernel-doc format.
>>
>> However, kernel-doc does not support kernel-doc notation on extern
>> struct/union/typedef/enum/etc. So I made this a DOC: block so that
>> I can use (insert) it into a Documentation (.rst) file and have it
>> look decent.
> 
> The simple workaround is to separate the enum type and the variable:
> 
> /**
>  * kernel-doc for the enum
>  */
> enum system_states {
> 	...
> };
> 
> /**
>  * kernel-doc for the variable
>  */
> extern enum system_states system_state;

Duh. Beautiful. Thanks.

@Andrew, please drop the v4 patch. I'll make another.

-- 
~Randy