linux-kernel - Re: [PATCH 28/37] drm/amd/display/dc/core/dc_stat: Convert a couple of doc headers to kerneldoc format

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]

Message-ID: <20230320081951.GI9667@google.com>
Date:   Mon, 20 Mar 2023 08:19:51 +0000
From:   Lee Jones <lee@...nel.org>
To:     Alex Deucher <alexdeucher@...il.com>
Cc:     "Wentland, Harry" <Harry.Wentland@....com>,
        dri-devel@...ts.freedesktop.org, Leo Li <sunpeng.li@....com>,
        "Pan, Xinhui" <Xinhui.Pan@....com>,
        Rodrigo Siqueira <Rodrigo.Siqueira@....com>,
        linux-kernel@...r.kernel.org, amd-gfx@...ts.freedesktop.org,
        Nicholas Kazlauskas <Nicholas.Kazlauskas@....com>,
        Jasdeep Dhillon <jdhillon@....com>,
        Alex Deucher <alexander.deucher@....com>,
        Christian König <christian.koenig@....com>,
        Mustapha Ghaddar <mghaddar@....com>
Subject: Re: [PATCH 28/37] drm/amd/display/dc/core/dc_stat: Convert a couple
 of doc headers to kerneldoc format

On Fri, 17 Mar 2023, Alex Deucher wrote:

> On Fri, Mar 17, 2023 at 4:23 AM Lee Jones <lee@...nel.org> wrote:
> >
> > Fixes the following W=1 kernel build warning(s):
> >
> >  drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc_stat.c:38: warning: Cannot understand  *****************************************************************************
> >  drivers/gpu/drm/amd/amdgpu/../display/dc/core/dc_stat.c:76: warning: Cannot understand  *****************************************************************************
> >
> > Cc: Harry Wentland <harry.wentland@....com>
> > Cc: Leo Li <sunpeng.li@....com>
> > Cc: Rodrigo Siqueira <Rodrigo.Siqueira@....com>
> > Cc: Alex Deucher <alexander.deucher@....com>
> > Cc: "Christian König" <christian.koenig@....com>
> > Cc: "Pan, Xinhui" <Xinhui.Pan@....com>
> > Cc: David Airlie <airlied@...il.com>
> > Cc: Daniel Vetter <daniel@...ll.ch>
> > Cc: Mustapha Ghaddar <mghaddar@....com>
> > Cc: Nicholas Kazlauskas <Nicholas.Kazlauskas@....com>
> > Cc: Jasdeep Dhillon <jdhillon@....com>
> > Cc: amd-gfx@...ts.freedesktop.org
> > Cc: dri-devel@...ts.freedesktop.org
> > Signed-off-by: Lee Jones <lee@...nel.org>
> > ---
> >  drivers/gpu/drm/amd/display/dc/core/dc_stat.c | 28 +++++++------------
> >  1 file changed, 10 insertions(+), 18 deletions(-)
> >
> > diff --git a/drivers/gpu/drm/amd/display/dc/core/dc_stat.c b/drivers/gpu/drm/amd/display/dc/core/dc_stat.c
> > index 6c06587dd88c2..5f6392ae31a66 100644
> > --- a/drivers/gpu/drm/amd/display/dc/core/dc_stat.c
> > +++ b/drivers/gpu/drm/amd/display/dc/core/dc_stat.c
> > @@ -35,19 +35,15 @@
> >   */
> >
> >  /**
>
> This looks like it follows some other documentation scheme.  Would
> probably be better to just remove the extra * and make it not kernel
> doc.  @Wentland, Harry @Siqueira, Rodrigo ?

Happy to wait for further input.

Either demoting from or converting to kerneldoc would be fine.

> > - *****************************************************************************
> > - *  Function: dc_stat_get_dmub_notification
> > + *  dc_stat_get_dmub_notification
> >   *
> > - *  @brief
> > - *             Calls dmub layer to retrieve dmub notification
> > + * Calls dmub layer to retrieve dmub notification
> >   *
> > - *  @param
> > - *             [in] dc: dc structure
> > - *             [in] notify: dmub notification structure
> > + * @dc: dc structure
> > + * @notify: dmub notification structure
> >   *
> > - *  @return
> > + * Returns
> >   *     None
> > - *****************************************************************************
> >   */
> >  void dc_stat_get_dmub_notification(const struct dc *dc, struct dmub_notification *notify)
> >  {
> > @@ -73,19 +69,15 @@ void dc_stat_get_dmub_notification(const struct dc *dc, struct dmub_notification
> >  }
> >
> >  /**
> > - *****************************************************************************
> > - *  Function: dc_stat_get_dmub_dataout
> > + * dc_stat_get_dmub_dataout
> >   *
> > - *  @brief
> > - *             Calls dmub layer to retrieve dmub gpint dataout
> > + * Calls dmub layer to retrieve dmub gpint dataout
> >   *
> > - *  @param
> > - *             [in] dc: dc structure
> > - *             [in] dataout: dmub gpint dataout
> > + * @dc: dc structure
> > + * @dataout: dmub gpint dataout
> >   *
> > - *  @return
> > + * Returns
> >   *     None
> > - *****************************************************************************
> >   */
> >  void dc_stat_get_dmub_dataout(const struct dc *dc, uint32_t *dataout)
> >  {
> > --
> > 2.40.0.rc1.284.g88254d51c5-goog
> >

--
Lee Jones [李琼斯]