linux-kernel - Re: [PATCH v5] kernel.h: add comments for enum 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] [day] [month] [year] [list]

Message-ID: <4ce38a55-fb12-4dd7-9754-4fb394e4df80@infradead.org>
Date: Sat, 6 Sep 2025 10:14:24 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: linux-kernel@...r.kernel.org, "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>, Jani Nikula <jani.nikula@...ux.intel.com>,
 linux-doc@...r.kernel.org, Mauro Carvalho Chehab <mchehab@...nel.org>,
 "James E.J. Bottomley" <James.Bottomley@...senPartnership.com>
Subject: Re: [PATCH v5] kernel.h: add comments for enum system_states



On 9/6/25 1:58 AM, Mauro Carvalho Chehab wrote:
> Em Fri,  5 Sep 2025 22:27:58 -0700
> Randy Dunlap <rdunlap@...radead.org> escreveu:
> 
>> Provide some basic comments about the system_states and what they imply.
>> Also convert the comments to kernel-doc format.
>>
>> Split the enum declaration from the definition of the system_state
>> variable so that kernel-doc notation works cleanly with it.
>> This is picked up by Documentation/driver-api/basics.rst so it
>> does not need further inclusion in the kernel docbooks.
>>
>> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
>> Acked-by: Rafael J. Wysocki <rafael@...nel.org> # v1
>> ---
>> v2: add Rafael's Ack.
>> v3: add Andrew
>> v4: add DOC: so that this DOC: block can be used in Documentation/
>>     add Greg K-H
>>     add Jon Corbet, Mauro Chehab, & linux-doc
>> v5: split enum declaration and definition (Jani Nikula)
>>     drop the DOC: block since it is no longer needed
>>
>> Cc: Andrew Morton <akpm@...ux-foundation.org>
>> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
>> Cc: "Rafael J. Wysocki" <rafael@...nel.org>
>> Cc: Pavel Machek <pavel@....cz>
>> Cc: Len Brown <len.brown@...el.com>
>> Cc: linux-pm@...r.kernel.org
>> Cc: Jonathan Corbet <corbet@....net>
>> Cc: Jani Nikula <jani.nikula@...ux.intel.com>
>> Cc: linux-doc@...r.kernel.org
>> Cc: Mauro Carvalho Chehab <mchehab@...nel.org>
>> Cc: "James E.J. Bottomley" <James.Bottomley@...senPartnership.com>
>> ---
>>  include/linux/kernel.h |   21 +++++++++++++++++----
>>  1 file changed, 17 insertions(+), 4 deletions(-)
>>
>> --- linux-next-20250819.orig/include/linux/kernel.h
>> +++ linux-next-20250819/include/linux/kernel.h
>> @@ -164,11 +164,23 @@ extern int root_mountflags;
>>  
>>  extern bool early_boot_irqs_disabled;
>>  
>> -/*
>> - * Values used for system_state. Ordering of the states must not be changed
>> +/**
>> + * enum system_states - Values used for system_state.
>> + *
> 
>> + * * @SYSTEM_BOOTING:	%0, no init needed
>> + * * @SYSTEM_SCHEDULING: system is ready for scheduling; OK to use RCU
>> + * * @SYSTEM_FREEING_INITMEM: system is freeing all of initmem; almost running
>> + * * @SYSTEM_RUNNING:	system is up and running
>> + * * @SYSTEM_HALT:	system entered clean system halt state
>> + * * @SYSTEM_POWER_OFF:	system entered shutdown/clean power off state
>> + * * @SYSTEM_RESTART:	system entered emergency power off or normal restart
>> + * * @SYSTEM_SUSPEND:	system entered suspend or hibernate state
> 
> You forgot to drop the extra asterisk at the above. definitions.

Oops, thanks for catching that. Will fix.

-- 
~Randy