linux-kernel - Re: [PATCH -next] ACPI: Add kernel-doc comments for ACPI suspend and hibernation functions

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 for Android: free password hash cracker in your pocket

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

Message-ID: <691bd1ca-a199-474f-9b1c-1c91f21648ae@infradead.org>
Date: Fri, 8 Mar 2024 08:01:02 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Yang Li <yang.lee@...ux.alibaba.com>, rafael@...nel.org, lenb@...nel.org
Cc: linux-acpi@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH -next] ACPI: Add kernel-doc comments for ACPI suspend and
 hibernation functions

Hi--

On 3/7/24 23:20, Yang Li wrote:
> This patch enhances the documentation for the ACPI power management
> functions related to system suspend and hibernation. This includes the
> use of kernel-doc style comments which provide developers with clearer
> guidance on the usage and expectations of these functions.
> 
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
> ---
>  drivers/acpi/sleep.c | 24 ++++++++++++++----------
>  1 file changed, 14 insertions(+), 10 deletions(-)
> 
> diff --git a/drivers/acpi/sleep.c b/drivers/acpi/sleep.c
> index 728acfeb774d..5bc61f40c189 100644
> --- a/drivers/acpi/sleep.c
> +++ b/drivers/acpi/sleep.c
> @@ -502,6 +502,7 @@ static void acpi_pm_finish(void)
>  
>  /**
>   * acpi_pm_start - Start system PM transition.
> + * @acpi_state: The target ACPI power state to transition to.
>   */
>  static void acpi_pm_start(u32 acpi_state)
>  {
> @@ -540,8 +541,9 @@ static u32 acpi_suspend_states[] = {
>  };
>  
>  /**
> - *	acpi_suspend_begin - Set the target system sleep state to the state
> - *		associated with given @pm_state, if supported.
> + *acpi_suspend_begin - Set the target system sleep state to the state
> + *	associated with given @pm_state, if supported.
> + *@...state: The target system power management state.

Please use a space between '*' and function names, function parameters, etc.

>   */
>  static int acpi_suspend_begin(suspend_state_t pm_state)
>  {
> @@ -671,10 +673,11 @@ static const struct platform_suspend_ops acpi_suspend_ops = {
>  };
>  
>  /**
> - *	acpi_suspend_begin_old - Set the target system sleep state to the
> - *		state associated with given @pm_state, if supported, and
> - *		execute the _PTS control method.  This function is used if the
> - *		pre-ACPI 2.0 suspend ordering has been requested.
> + *acpi_suspend_begin_old - Set the target system sleep state to the
> + *	state associated with given @pm_state, if supported, and
> + *	execute the _PTS control method.  This function is used if the
> + *	pre-ACPI 2.0 suspend ordering has been requested.
> + *@...state: The target suspend state for the system.

Ditto.

>   */
>  static int acpi_suspend_begin_old(suspend_state_t pm_state)
>  {
> @@ -967,10 +970,11 @@ static const struct platform_hibernation_ops acpi_hibernation_ops = {
>  };
>  
>  /**
> - *	acpi_hibernation_begin_old - Set the target system sleep state to
> - *		ACPI_STATE_S4 and execute the _PTS control method.  This
> - *		function is used if the pre-ACPI 2.0 suspend ordering has been
> - *		requested.
> + *acpi_hibernation_begin_old - Set the target system sleep state to
> + *	ACPI_STATE_S4 and execute the _PTS control method.  This
> + *	function is used if the pre-ACPI 2.0 suspend ordering has been
> + *	requested.
> + *@...ge: The power management event message.

Ditto.

>   */
>  static int acpi_hibernation_begin_old(pm_message_t stage)
>  {

thanks.
-- 
#Randy