linux-kernel - Re: [PATCH 22/34] drm/amd/display/dc/core/dc: Convert function headers to kernel-doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Thu, 27 May 2021 00:26:33 -0400
From:   Alex Deucher <alexdeucher@...il.com>
To:     Lee Jones <lee.jones@...aro.org>
Cc:     Leo Li <sunpeng.li@....com>, LKML <linux-kernel@...r.kernel.org>,
        amd-gfx list <amd-gfx@...ts.freedesktop.org>,
        David Airlie <airlied@...ux.ie>,
        Maling list - DRI developers 
        <dri-devel@...ts.freedesktop.org>,
        Alex Deucher <alexander.deucher@....com>,
        Christian König <christian.koenig@....com>
Subject: Re: [PATCH 22/34] drm/amd/display/dc/core/dc: Convert function
 headers to kernel-doc

Applied.  Thanks!

On Wed, May 26, 2021 at 4:48 AM Lee Jones <lee.jones@...aro.org> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:3324: warning: Cannot understand  *****************************************************************************
>  drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:3344: warning: Cannot understand  *****************************************************************************
>  drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc.c:3417: warning: Cannot understand  *****************************************************************************
>
> Cc: Harry Wentland <harry.wentland@....com>
> Cc: Leo Li <sunpeng.li@....com>
> Cc: Alex Deucher <alexander.deucher@....com>
> Cc: "Christian König" <christian.koenig@....com>
> Cc: David Airlie <airlied@...ux.ie>
> Cc: Daniel Vetter <daniel@...ll.ch>
> Cc: amd-gfx@...ts.freedesktop.org
> Cc: dri-devel@...ts.freedesktop.org
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
> ---
>  drivers/gpu/drm/amd/display/dc/core/dc.c | 46 ++++++------------------
>  1 file changed, 11 insertions(+), 35 deletions(-)
>
> diff --git a/drivers/gpu/drm/amd/display/dc/core/dc.c b/drivers/gpu/drm/amd/display/dc/core/dc.c
> index ef157b83bacd2..34c207f92df98 100644
> --- a/drivers/gpu/drm/amd/display/dc/core/dc.c
> +++ b/drivers/gpu/drm/amd/display/dc/core/dc.c
> @@ -3335,18 +3335,10 @@ void dc_hardware_release(struct dc *dc)
>  #endif
>
>  /**
> - *****************************************************************************
> - *  Function: dc_enable_dmub_notifications
> + * dc_enable_dmub_notifications - Returns whether dmub notification can be enabled
> + * @dc: dc structure
>   *
> - *  @brief
> - *             Returns whether dmub notification can be enabled
> - *
> - *  @param
> - *             [in] dc: dc structure
> - *
> - *     @return
> - *             True to enable dmub notifications, False otherwise
> - *****************************************************************************
> + * Returns: True to enable dmub notifications, False otherwise
>   */
>  bool dc_enable_dmub_notifications(struct dc *dc)
>  {
> @@ -3355,21 +3347,13 @@ bool dc_enable_dmub_notifications(struct dc *dc)
>  }
>
>  /**
> - *****************************************************************************
> - *  Function: dc_process_dmub_aux_transfer_async
> - *
> - *  @brief
> - *             Submits aux command to dmub via inbox message
> - *             Sets port index appropriately for legacy DDC
> - *
> - *  @param
> - *             [in] dc: dc structure
> - *             [in] link_index: link index
> - *             [in] payload: aux payload
> + * dc_process_dmub_aux_transfer_async - Submits aux command to dmub via inbox message
> + *                                      Sets port index appropriately for legacy DDC
> + * @dc: dc structure
> + * @link_index: link index
> + * @payload: aux payload
>   *
> - *     @return
> - *             True if successful, False if failure
> - *****************************************************************************
> + * Returns: True if successful, False if failure
>   */
>  bool dc_process_dmub_aux_transfer_async(struct dc *dc,
>                                 uint32_t link_index,
> @@ -3428,16 +3412,8 @@ bool dc_process_dmub_aux_transfer_async(struct dc *dc,
>  }
>
>  /**
> - *****************************************************************************
> - *  Function: dc_disable_accelerated_mode
> - *
> - *  @brief
> - *             disable accelerated mode
> - *
> - *  @param
> - *             [in] dc: dc structure
> - *
> - *****************************************************************************
> + * dc_disable_accelerated_mode - disable accelerated mode
> + * @dc: dc structure
>   */
>  void dc_disable_accelerated_mode(struct dc *dc)
>  {
> --
> 2.31.1
>