Re: [PATCH 23/34] drm/amd/display/dmub/src/dmub_srv_stat: Convert function header to kernel-doc

From: Alex Deucher
Date: Thu May 27 2021 - 00:27:47 EST


Applied. Thanks!

On Wed, May 26, 2021 at 4:48 AM Lee Jones <lee.jones@xxxxxxxxxx> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/gpu/drm/amd/amdgpu/../display/dmub/src/dmub_srv_stat.c:38: warning: Cannot understand *****************************************************************************
>
> Cc: Harry Wentland <harry.wentland@xxxxxxx>
> Cc: Leo Li <sunpeng.li@xxxxxxx>
> Cc: Alex Deucher <alexander.deucher@xxxxxxx>
> Cc: "Christian König" <christian.koenig@xxxxxxx>
> Cc: David Airlie <airlied@xxxxxxxx>
> Cc: Daniel Vetter <daniel@xxxxxxxx>
> Cc: Jun Lei <Jun.Lei@xxxxxxx>
> Cc: Meenakshikumar Somasundaram <meenakshikumar.somasundaram@xxxxxxx>
> Cc: Rodrigo Siqueira <Rodrigo.Siqueira@xxxxxxx>
> Cc: amd-gfx@xxxxxxxxxxxxxxxxxxxxx
> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> ---
> .../drm/amd/display/dmub/src/dmub_srv_stat.c | 19 ++++++-------------
> 1 file changed, 6 insertions(+), 13 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/display/dmub/src/dmub_srv_stat.c b/drivers/gpu/drm/amd/display/dmub/src/dmub_srv_stat.c
> index e6f3bfab33d3e..70766d534c9c8 100644
> --- a/drivers/gpu/drm/amd/display/dmub/src/dmub_srv_stat.c
> +++ b/drivers/gpu/drm/amd/display/dmub/src/dmub_srv_stat.c
> @@ -35,20 +35,13 @@
> */
>
> /**
> - *****************************************************************************
> - * Function: dmub_srv_stat_get_notification
> + * dmub_srv_stat_get_notification - Retrieves a dmub outbox notification, set up dmub notification
> + * structure with message information. Also a pending bit if queue
> + * is having more notifications
> + * @dmub: dmub srv structure
> + * @notify: dmub notification structure to be filled up
> *
> - * @brief
> - * Retrieves a dmub outbox notification, set up dmub notification
> - * structure with message information. Also a pending bit if queue
> - * is having more notifications
> - *
> - * @param [in] dmub: dmub srv structure
> - * @param [out] pnotify: dmub notification structure to be filled up
> - *
> - * @return
> - * dmub_status
> - *****************************************************************************
> + * Returns: dmub_status
> */
> enum dmub_status dmub_srv_stat_get_notification(struct dmub_srv *dmub,
> struct dmub_notification *notify)
> --
> 2.31.1
>