Re: [PATCH] PM / suspend: fix kernel-doc markup

From: "Rafael J. Wysocki" <rafael@kernel.org>
To: Alex Shi <alex.shi@linux.alibaba.com>
Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>,
	Len Brown <len.brown@intel.com>, Pavel Machek <pavel@ucw.cz>,
	Linux PM <linux-pm@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH] PM / suspend: fix kernel-doc markup
Date: Mon, 23 Nov 2020 18:26:36 +0100	[thread overview]
Message-ID: <CAJZ5v0iUfvn0=HbuowX=j0zxpiiEmBTb=QyQknViqGrc8WDW2w@mail.gmail.com> (raw)
In-Reply-To: <1605257895-5536-1-git-send-email-alex.shi@linux.alibaba.com>

On Fri, Nov 13, 2020 at 9:58 AM Alex Shi <alex.shi@linux.alibaba.com> wrote:
>
> Add parameter explanation to fix kernel-doc marks:
>
> kernel/power/suspend.c:233: warning: Function parameter or member
> 'state' not described in 'suspend_valid_only_mem'
> kernel/power/suspend.c:344: warning: Function parameter or member
> 'state' not described in 'suspend_prepare'
>
> Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
> Cc: "Rafael J. Wysocki" <rjw@rjwysocki.net>
> Cc: Len Brown <len.brown@intel.com>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: linux-pm@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> ---
>  kernel/power/suspend.c | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/kernel/power/suspend.c b/kernel/power/suspend.c
> index 32391acc806b..502d86ed99c7 100644
> --- a/kernel/power/suspend.c
> +++ b/kernel/power/suspend.c
> @@ -224,6 +224,7 @@ EXPORT_SYMBOL_GPL(suspend_set_ops);
>
>  /**
>   * suspend_valid_only_mem - Generic memory-only valid callback.
> + * @state: Suspend state to be set
>   *
>   * Platform drivers that implement mem suspend only and only need to check for
>   * that in their .valid() callback can use this instead of rolling their own
> @@ -335,6 +336,7 @@ static int suspend_test(int level)
>
>  /**
>   * suspend_prepare - Prepare for entering system sleep state.
> + * @state: suspend state which sleep from
>   *
>   * Common code run for every system sleep state that can be entered (except for
>   * hibernation).  Run suspend notifiers, allocate the "suspend" console and
> --

Applied as 5.11 material, but I've changed the originally proposed
parameter descriptions into "Target system sleep state" in both cases.

Thanks!