mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Yang Li <yang.lee@linux.alibaba.com>,
	daniel.lezcano@kernel.org, rafael@kernel.org
Cc: linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH -next] powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function
Date: Fri, 1 Mar 2024 11:24:33 -0800	[thread overview]
Message-ID: <df67c46b-26a3-44da-8404-1bf445cb6efb@infradead.org> (raw)
In-Reply-To: <20240301081802.114308-1-yang.lee@linux.alibaba.com>



On 3/1/24 00:18, Yang Li wrote:
> The existing comment block above the dtpm_create_hierarchy function
> does not conform to the kernel-doc standard. This patch fixes the
> documentation to match the expected kernel-doc format, which includes
> a structured documentation header with param and return value.
> 
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.

> ---
>  drivers/powercap/dtpm.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/powercap/dtpm.c b/drivers/powercap/dtpm.c
> index ce920f17f45f..f390665743c4 100644
> --- a/drivers/powercap/dtpm.c
> +++ b/drivers/powercap/dtpm.c
> @@ -522,7 +522,7 @@ static int dtpm_for_each_child(const struct dtpm_node *hierarchy,
>  
>  /**
>   * dtpm_create_hierarchy - Create the dtpm hierarchy
> - * @hierarchy: An array of struct dtpm_node describing the hierarchy
> + * @dtpm_match_table: Pointer to the array of device ID structures
>   *
>   * The function is called by the platform specific code with the
>   * description of the different node in the hierarchy. It creates the

-- 
#Randy

  reply	other threads:[~2024-03-01 19:24 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-01  8:18 Yang Li
2024-03-01 19:24 ` Randy Dunlap [this message]
2024-03-01 20:41   ` Rafael J. Wysocki

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=df67c46b-26a3-44da-8404-1bf445cb6efb@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=daniel.lezcano@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=rafael@kernel.org \
    --cc=yang.lee@linux.alibaba.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®