* [PATCH -next] powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function
@ 2024-03-01 8:18 Yang Li
2024-03-01 19:24 ` Randy Dunlap
0 siblings, 1 reply; 3+ messages in thread
From: Yang Li @ 2024-03-01 8:18 UTC (permalink / raw)
To: daniel.lezcano, rafael; +Cc: linux-pm, linux-kernel, Yang Li
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>
---
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
--
2.20.1.7.g153144c
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH -next] powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function
2024-03-01 8:18 [PATCH -next] powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function Yang Li
@ 2024-03-01 19:24 ` Randy Dunlap
2024-03-01 20:41 ` Rafael J. Wysocki
0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2024-03-01 19:24 UTC (permalink / raw)
To: Yang Li, daniel.lezcano, rafael; +Cc: linux-pm, linux-kernel
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH -next] powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function
2024-03-01 19:24 ` Randy Dunlap
@ 2024-03-01 20:41 ` Rafael J. Wysocki
0 siblings, 0 replies; 3+ messages in thread
From: Rafael J. Wysocki @ 2024-03-01 20:41 UTC (permalink / raw)
To: Randy Dunlap, Yang Li; +Cc: daniel.lezcano, linux-pm, linux-kernel
On Fri, Mar 1, 2024 at 8:24 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
>
>
> 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>
Applied, thanks!
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2024-03-01 20:41 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-03-01 8:18 [PATCH -next] powercap: dtpm: Fix kernel-doc for dtpm_create_hierarchy function Yang Li
2024-03-01 19:24 ` Randy Dunlap
2024-03-01 20:41 ` Rafael J. Wysocki
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox