diff mbox series

drm/amd/display: DCN3.1: don't mark as kernel-doc

Message ID 20220326233726.14712-1-rdunlap@infradead.org (mailing list archive)
State New, archived
Headers show
Series drm/amd/display: DCN3.1: don't mark as kernel-doc | expand

Commit Message

Randy Dunlap March 26, 2022, 11:37 p.m. UTC
There is no need for this one static function to be marked as
kernel-doc notation.

Avoid this doc build warning:

warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Enable CRTC

Fixes: 110d3968fe95 ("drm/amd/display: Add DCN3.1 OPTC")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Nicholas Kazlauskas <nicholas.kazlauskas@amd.com>
Cc: amd-gfx@lists.freedesktop.org
Cc: Christian König <christian.koenig@amd.com>
Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
Cc: Harry Wentland <harry.wentland@amd.com>
Cc: Leo Li <sunpeng.li@amd.com>
Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
---
 drivers/gpu/drm/amd/display/dc/dcn31/dcn31_optc.c |    3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

Comments

Alex Deucher March 28, 2022, 3:09 p.m. UTC | #1
Applied.  Thanks!

Alex

On Sat, Mar 26, 2022 at 7:37 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> There is no need for this one static function to be marked as
> kernel-doc notation.
>
> Avoid this doc build warning:
>
> warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * Enable CRTC
>
> Fixes: 110d3968fe95 ("drm/amd/display: Add DCN3.1 OPTC")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: Nicholas Kazlauskas <nicholas.kazlauskas@amd.com>
> Cc: amd-gfx@lists.freedesktop.org
> Cc: Christian König <christian.koenig@amd.com>
> Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
> Cc: Harry Wentland <harry.wentland@amd.com>
> Cc: Leo Li <sunpeng.li@amd.com>
> Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> ---
>  drivers/gpu/drm/amd/display/dc/dcn31/dcn31_optc.c |    3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> --- linux-next-20220325.orig/drivers/gpu/drm/amd/display/dc/dcn31/dcn31_optc.c
> +++ linux-next-20220325/drivers/gpu/drm/amd/display/dc/dcn31/dcn31_optc.c
> @@ -91,8 +91,7 @@ static void optc31_set_odm_combine(struc
>         optc1->opp_count = opp_cnt;
>  }
>
> -/**
> - * Enable CRTC
> +/*
>   * Enable CRTC - call ASIC Control Object to enable Timing generator.
>   */
>  static bool optc31_enable_crtc(struct timing_generator *optc)
diff mbox series

Patch

--- linux-next-20220325.orig/drivers/gpu/drm/amd/display/dc/dcn31/dcn31_optc.c
+++ linux-next-20220325/drivers/gpu/drm/amd/display/dc/dcn31/dcn31_optc.c
@@ -91,8 +91,7 @@  static void optc31_set_odm_combine(struc
 	optc1->opp_count = opp_cnt;
 }
 
-/**
- * Enable CRTC
+/*
  * Enable CRTC - call ASIC Control Object to enable Timing generator.
  */
 static bool optc31_enable_crtc(struct timing_generator *optc)