2021-01-11 08:50:19

by Lukas Bulwahn

[permalink] [raw]
Subject: [PATCH -next] drm/amd/display: tweak the kerneldoc for active_vblank_irq_count

Commit 71338cb4a7c2 ("drm/amd/display: enable idle optimizations for linux
(MALL stutter)") adds active_vblank_irq_count to amdgpu_display_manager
in ./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h.

The kerneldoc is incorrectly formatted, and make htmldocs warns:

./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:
340: warning: Incorrect use of kernel-doc format: * @active_vblank_irq_count
379: warning: Function parameter or member 'active_vblank_irq_count' not described in 'amdgpu_display_manager'

Tweak the kerneldoc for active_vblank_irq_count.

Signed-off-by: Lukas Bulwahn <[email protected]>
---
applies on amdgpu's -next and next-20210111

Bhawanpreet, Nick, please review and ack.

Alex, Christian, please pick on top of the commit above.

drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
index f084e2fc9569..5ee1b766884e 100644
--- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
+++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
@@ -337,7 +337,7 @@ struct amdgpu_display_manager {
const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;

/**
- * @active_vblank_irq_count
+ * @active_vblank_irq_count:
*
* number of currently active vblank irqs
*/
--
2.17.1


2021-01-11 16:10:42

by Alex Deucher

[permalink] [raw]
Subject: Re: [PATCH -next] drm/amd/display: tweak the kerneldoc for active_vblank_irq_count

Applied. Thanks!

Alex

On Mon, Jan 11, 2021 at 10:54 AM Lakha, Bhawanpreet
<[email protected]> wrote:
>
> [AMD Official Use Only - Internal Distribution Only]
>
>
> Thanks,
>
> Reviewed-by: Bhawanpreet Lakha <[email protected]>
> ________________________________
> From: Lukas Bulwahn <[email protected]>
> Sent: January 11, 2021 3:46 AM
> To: Lakha, Bhawanpreet <[email protected]>; Kazlauskas, Nicholas <[email protected]>; Deucher, Alexander <[email protected]>; Koenig, Christian <[email protected]>; [email protected] <[email protected]>
> Cc: [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>; [email protected] <[email protected]>; Lukas Bulwahn <[email protected]>
> Subject: [PATCH -next] drm/amd/display: tweak the kerneldoc for active_vblank_irq_count
>
> Commit 71338cb4a7c2 ("drm/amd/display: enable idle optimizations for linux
> (MALL stutter)") adds active_vblank_irq_count to amdgpu_display_manager
> in ./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h.
>
> The kerneldoc is incorrectly formatted, and make htmldocs warns:
>
> ./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:
> 340: warning: Incorrect use of kernel-doc format: * @active_vblank_irq_count
> 379: warning: Function parameter or member 'active_vblank_irq_count' not described in 'amdgpu_display_manager'
>
> Tweak the kerneldoc for active_vblank_irq_count.
>
> Signed-off-by: Lukas Bulwahn <[email protected]>
> ---
> applies on amdgpu's -next and next-20210111
>
> Bhawanpreet, Nick, please review and ack.
>
> Alex, Christian, please pick on top of the commit above.
>
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> index f084e2fc9569..5ee1b766884e 100644
> --- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> +++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> @@ -337,7 +337,7 @@ struct amdgpu_display_manager {
> const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
>
> /**
> - * @active_vblank_irq_count
> + * @active_vblank_irq_count:
> *
> * number of currently active vblank irqs
> */
> --
> 2.17.1
>
> _______________________________________________
> amd-gfx mailing list
> [email protected]
> https://lists.freedesktop.org/mailman/listinfo/amd-gfx