drm/amd/display: dmub_replay: don't use kernel-doc markers

Message ID 20230808232627.21168-1-rdunlap@infradead.org
State New
Headers
Series drm/amd/display: dmub_replay: don't use kernel-doc markers |

Commit Message

Randy Dunlap Aug. 8, 2023, 11:26 p.m. UTC
  These functions don't use kernel-doc notation for comments so
don't begin each comment block with the "/**" kernel-doc marker.

This prevents a bunch of kernel-doc warnings:

dmub_replay.c:37: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
dmub_replay.c:37: warning: missing initial short description on line:
 * Get Replay state from firmware.
dmub_replay.c:66: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
dmub_replay.c:66: warning: missing initial short description on line:
 * Enable/Disable Replay.
dmub_replay.c:116: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
dmub_replay.c:116: warning: missing initial short description on line:
 * Set REPLAY power optimization flags.
dmub_replay.c:134: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
dmub_replay.c:134: warning: missing initial short description on line:
 * Setup Replay by programming phy registers and sending replay hw context values to firmware.
and 10 more similar warnings.

Fixes: c7ddc0a800bc ("drm/amd/display: Add Functions to enable Freesync Panel Replay")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Link: lore.kernel.org/r/202308081459.US5rLYAY-lkp@intel.com
Cc: Bhawanpreet Lakha <Bhawanpreet.Lakha@amd.com>
Cc: Harry Wentland <harry.wentland@amd.com>
Cc: Alex Deucher <alexander.deucher@amd.com>
Cc: Leo Li <sunpeng.li@amd.com>
Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
Cc: amd-gfx@lists.freedesktop.org
Cc: Christian König <christian.koenig@amd.com>
Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
Cc: dri-devel@lists.freedesktop.org
---
 drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c |   18 ++++++-------
 1 file changed, 9 insertions(+), 9 deletions(-)
  

Comments

Alex Deucher Aug. 9, 2023, 1:05 p.m. UTC | #1
Applied.  Thanks!

On Tue, Aug 8, 2023 at 7:26 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> These functions don't use kernel-doc notation for comments so
> don't begin each comment block with the "/**" kernel-doc marker.
>
> This prevents a bunch of kernel-doc warnings:
>
> dmub_replay.c:37: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> dmub_replay.c:37: warning: missing initial short description on line:
>  * Get Replay state from firmware.
> dmub_replay.c:66: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> dmub_replay.c:66: warning: missing initial short description on line:
>  * Enable/Disable Replay.
> dmub_replay.c:116: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> dmub_replay.c:116: warning: missing initial short description on line:
>  * Set REPLAY power optimization flags.
> dmub_replay.c:134: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> dmub_replay.c:134: warning: missing initial short description on line:
>  * Setup Replay by programming phy registers and sending replay hw context values to firmware.
> and 10 more similar warnings.
>
> Fixes: c7ddc0a800bc ("drm/amd/display: Add Functions to enable Freesync Panel Replay")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Link: lore.kernel.org/r/202308081459.US5rLYAY-lkp@intel.com
> Cc: Bhawanpreet Lakha <Bhawanpreet.Lakha@amd.com>
> Cc: Harry Wentland <harry.wentland@amd.com>
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: Leo Li <sunpeng.li@amd.com>
> Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> Cc: amd-gfx@lists.freedesktop.org
> Cc: Christian König <christian.koenig@amd.com>
> Cc: "Pan, Xinhui" <Xinhui.Pan@amd.com>
> Cc: dri-devel@lists.freedesktop.org
> ---
>  drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c |   18 ++++++-------
>  1 file changed, 9 insertions(+), 9 deletions(-)
>
> diff -- a/drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c b/drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c
> --- a/drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c
> +++ b/drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c
> @@ -33,7 +33,7 @@
>
>  #define MAX_PIPES 6
>
> -/**
> +/*
>   * Get Replay state from firmware.
>   */
>  static void dmub_replay_get_state(struct dmub_replay *dmub, enum replay_state *state, uint8_t panel_inst)
> @@ -62,7 +62,7 @@ static void dmub_replay_get_state(struct
>         }
>  }
>
> -/**
> +/*
>   * Enable/Disable Replay.
>   */
>  static void dmub_replay_enable(struct dmub_replay *dmub, bool enable, bool wait, uint8_t panel_inst)
> @@ -112,7 +112,7 @@ static void dmub_replay_enable(struct dm
>
>  }
>
> -/**
> +/*
>   * Set REPLAY power optimization flags.
>   */
>  static void dmub_replay_set_power_opt(struct dmub_replay *dmub, unsigned int power_opt, uint8_t panel_inst)
> @@ -130,7 +130,7 @@ static void dmub_replay_set_power_opt(st
>         dm_execute_dmub_cmd(dc, &cmd, DM_DMUB_WAIT_TYPE_WAIT);
>  }
>
> -/**
> +/*
>   * Setup Replay by programming phy registers and sending replay hw context values to firmware.
>   */
>  static bool dmub_replay_copy_settings(struct dmub_replay *dmub,
> @@ -215,7 +215,7 @@ static bool dmub_replay_copy_settings(st
>         return true;
>  }
>
> -/**
> +/*
>   * Set coasting vtotal.
>   */
>  static void dmub_replay_set_coasting_vtotal(struct dmub_replay *dmub,
> @@ -234,7 +234,7 @@ static void dmub_replay_set_coasting_vto
>         dm_execute_dmub_cmd(dc, &cmd, DM_DMUB_WAIT_TYPE_WAIT);
>  }
>
> -/**
> +/*
>   * Get Replay residency from firmware.
>   */
>  static void dmub_replay_residency(struct dmub_replay *dmub, uint8_t panel_inst,
> @@ -267,7 +267,7 @@ static const struct dmub_replay_funcs re
>         .replay_residency               = dmub_replay_residency,
>  };
>
> -/**
> +/*
>   * Construct Replay object.
>   */
>  static void dmub_replay_construct(struct dmub_replay *replay, struct dc_context *ctx)
> @@ -276,7 +276,7 @@ static void dmub_replay_construct(struct
>         replay->funcs = &replay_funcs;
>  }
>
> -/**
> +/*
>   * Allocate and initialize Replay object.
>   */
>  struct dmub_replay *dmub_replay_create(struct dc_context *ctx)
> @@ -293,7 +293,7 @@ struct dmub_replay *dmub_replay_create(s
>         return replay;
>  }
>
> -/**
> +/*
>   * Deallocate Replay object.
>   */
>  void dmub_replay_destroy(struct dmub_replay **dmub)
  

Patch

diff -- a/drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c b/drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c
--- a/drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c
+++ b/drivers/gpu/drm/amd/display/dc/dce/dmub_replay.c
@@ -33,7 +33,7 @@ 
 
 #define MAX_PIPES 6
 
-/**
+/*
  * Get Replay state from firmware.
  */
 static void dmub_replay_get_state(struct dmub_replay *dmub, enum replay_state *state, uint8_t panel_inst)
@@ -62,7 +62,7 @@  static void dmub_replay_get_state(struct
 	}
 }
 
-/**
+/*
  * Enable/Disable Replay.
  */
 static void dmub_replay_enable(struct dmub_replay *dmub, bool enable, bool wait, uint8_t panel_inst)
@@ -112,7 +112,7 @@  static void dmub_replay_enable(struct dm
 
 }
 
-/**
+/*
  * Set REPLAY power optimization flags.
  */
 static void dmub_replay_set_power_opt(struct dmub_replay *dmub, unsigned int power_opt, uint8_t panel_inst)
@@ -130,7 +130,7 @@  static void dmub_replay_set_power_opt(st
 	dm_execute_dmub_cmd(dc, &cmd, DM_DMUB_WAIT_TYPE_WAIT);
 }
 
-/**
+/*
  * Setup Replay by programming phy registers and sending replay hw context values to firmware.
  */
 static bool dmub_replay_copy_settings(struct dmub_replay *dmub,
@@ -215,7 +215,7 @@  static bool dmub_replay_copy_settings(st
 	return true;
 }
 
-/**
+/*
  * Set coasting vtotal.
  */
 static void dmub_replay_set_coasting_vtotal(struct dmub_replay *dmub,
@@ -234,7 +234,7 @@  static void dmub_replay_set_coasting_vto
 	dm_execute_dmub_cmd(dc, &cmd, DM_DMUB_WAIT_TYPE_WAIT);
 }
 
-/**
+/*
  * Get Replay residency from firmware.
  */
 static void dmub_replay_residency(struct dmub_replay *dmub, uint8_t panel_inst,
@@ -267,7 +267,7 @@  static const struct dmub_replay_funcs re
 	.replay_residency		= dmub_replay_residency,
 };
 
-/**
+/*
  * Construct Replay object.
  */
 static void dmub_replay_construct(struct dmub_replay *replay, struct dc_context *ctx)
@@ -276,7 +276,7 @@  static void dmub_replay_construct(struct
 	replay->funcs = &replay_funcs;
 }
 
-/**
+/*
  * Allocate and initialize Replay object.
  */
 struct dmub_replay *dmub_replay_create(struct dc_context *ctx)
@@ -293,7 +293,7 @@  struct dmub_replay *dmub_replay_create(s
 	return replay;
 }
 
-/**
+/*
  * Deallocate Replay object.
  */
 void dmub_replay_destroy(struct dmub_replay **dmub)