linux-kernel - Re: [PATCH] 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] [day] [month] [year] [list]

Message-ID: <CAJZ5v0gnsFM7YcBqO8Mbkr72ipQxT8nJ=i94z74Q0XM1csnTYw@mail.gmail.com>
Date: Tue, 10 Dec 2024 19:55:25 +0100
From: "Rafael J. Wysocki" <rafael@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, "Rafael J. Wysocki" <rafael@...nel.org>, 
	Pavel Machek <pavel@....cz>, Len Brown <len.brown@...el.com>, linux-pm@...r.kernel.org, 
	"James E.J. Bottomley" <James.Bottomley@...senpartnership.com>
Subject: Re: [PATCH] kernel.h: add comments for system_states

On Fri, Nov 29, 2024 at 5:57 AM 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.
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.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: "James E.J. Bottomley" <James.Bottomley@...senPartnership.com>

Fine by me.

Acked-by: Rafael J. Wysocki <rafael@...nel.org>

> ---
>  include/linux/kernel.h |   14 ++++++++++++--
>  1 file changed, 12 insertions(+), 2 deletions(-)
>
> --- linux-next-20241125.orig/include/linux/kernel.h
> +++ linux-next-20241125/include/linux/kernel.h
> @@ -176,9 +176,19 @@ 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.
> + * Ordering of the states must not be changed
>   * as code checks for <, <=, >, >= 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
>   */
>  extern enum system_states {
>         SYSTEM_BOOTING,
>