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

[Hamza Mahfooz]

On 3/17/23 04:17, Lee Jones 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 
Cc: Leo Li 
Cc: Rodrigo Siqueira 
Cc: Alex Deucher 
Cc: "Christian König" 
Cc: "Pan, Xinhui" 
Cc: David Airlie 
Cc: Daniel Vetter 
Cc: Mustapha Ghaddar 
Cc: Nicholas Kazlauskas 
Cc: Jasdeep Dhillon 
Cc: amd-gfx@lists.freedesktop.org
Cc: dri-de...@lists.freedesktop.org
Signed-off-by: Lee Jones 


Applied, thanks!


---
  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 @@
   */
  
  /**

- *
- *  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)
  {


--
Hamza

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

[Lee Jones]

On Mon, 20 Mar 2023, Harry Wentland wrote:

>
>
> On 3/20/23 04:19, Lee Jones wrote:
> > On Fri, 17 Mar 2023, Alex Deucher wrote:
> >
> >> On Fri, Mar 17, 2023 at 4:23 AM Lee Jones  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 
> >>> Cc: Leo Li 
> >>> Cc: Rodrigo Siqueira 
> >>> Cc: Alex Deucher 
> >>> Cc: "Christian König" 
> >>> Cc: "Pan, Xinhui" 
> >>> Cc: David Airlie 
> >>> Cc: Daniel Vetter 
> >>> Cc: Mustapha Ghaddar 
> >>> Cc: Nicholas Kazlauskas 
> >>> Cc: Jasdeep Dhillon 
> >>> Cc: amd-gfx@lists.freedesktop.org
> >>> Cc: dri-de...@lists.freedesktop.org
> >>> Signed-off-by: Lee Jones 
> >>> ---
> >>>  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.
> >
>
> There's no reason they are formatted the way they are. Converting them to
> kerneldoc is fine.
>
> Reviewed-by: Harry Wentland 

Thanks for confirming Harry.

--
Lee Jones [李琼斯]

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

[Harry Wentland]

On 3/20/23 04:19, Lee Jones wrote:
> On Fri, 17 Mar 2023, Alex Deucher wrote:
> 
>> On Fri, Mar 17, 2023 at 4:23 AM Lee Jones  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 
>>> Cc: Leo Li 
>>> Cc: Rodrigo Siqueira 
>>> Cc: Alex Deucher 
>>> Cc: "Christian König" 
>>> Cc: "Pan, Xinhui" 
>>> Cc: David Airlie 
>>> Cc: Daniel Vetter 
>>> Cc: Mustapha Ghaddar 
>>> Cc: Nicholas Kazlauskas 
>>> Cc: Jasdeep Dhillon 
>>> Cc: amd-gfx@lists.freedesktop.org
>>> Cc: dri-de...@lists.freedesktop.org
>>> Signed-off-by: Lee Jones 
>>> ---
>>>  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.
> 

There's no reason they are formatted the way they are. Converting them to
kerneldoc is fine.

Reviewed-by: Harry Wentland 

Harry

>>> - 
>>> *
>>> - *  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 [李琼斯]

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

[Lee Jones]

On Fri, 17 Mar 2023, Alex Deucher wrote:

> On Fri, Mar 17, 2023 at 4:23 AM Lee Jones  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 
> > Cc: Leo Li 
> > Cc: Rodrigo Siqueira 
> > Cc: Alex Deucher 
> > Cc: "Christian König" 
> > Cc: "Pan, Xinhui" 
> > Cc: David Airlie 
> > Cc: Daniel Vetter 
> > Cc: Mustapha Ghaddar 
> > Cc: Nicholas Kazlauskas 
> > Cc: Jasdeep Dhillon 
> > Cc: amd-gfx@lists.freedesktop.org
> > Cc: dri-de...@lists.freedesktop.org
> > Signed-off-by: Lee Jones 
> > ---
> >  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 [李琼斯]

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

[Alex Deucher]

On Fri, Mar 17, 2023 at 4:23 AM Lee Jones  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 
> Cc: Leo Li 
> Cc: Rodrigo Siqueira 
> Cc: Alex Deucher 
> Cc: "Christian König" 
> Cc: "Pan, Xinhui" 
> Cc: David Airlie 
> Cc: Daniel Vetter 
> Cc: Mustapha Ghaddar 
> Cc: Nicholas Kazlauskas 
> Cc: Jasdeep Dhillon 
> Cc: amd-gfx@lists.freedesktop.org
> Cc: dri-de...@lists.freedesktop.org
> Signed-off-by: Lee Jones 
> ---
>  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 ?

Alex

> - 
> *
> - *  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
>