[PATCH] amdgpu: fix some kernel-doc markup

[PATCH] amdgpu: fix some kernel-doc markup

[Stylon Wang]

From: Yann Dirson <ydirson@free.fr>

commit 03f2abb07e54b3e0da54c52a656d9765b7e141c5 upstream.

Those are not today pulled by the sphinx doc, but better be ready.

Two lines of the cherry-picked patch is removed because they are being
refactored away from this file:
drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h

Signed-off-by: Yann Dirson <ydirson@free.fr>
Signed-off-by: Alex Deucher <alexander.deucher@amd.com>
Reported-by: kernel test robot <lkp@intel.com>
Link: https://lore.kernel.org/oe-kbuild-all/202302281017.9qcgLAZi-lkp@intel.com/
Cc: <stable@vger.kernel.org> # 5.15.x
(cherry picked from commit 03f2abb07e54b3e0da54c52a656d9765b7e141c5)
---
 drivers/gpu/drm/amd/amdgpu/amdgpu_device.c        | 6 +++---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
index b0d9c47cc381..a5cf672e79c5 100644
--- a/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
+++ b/drivers/gpu/drm/amd/amdgpu/amdgpu_device.c
@@ -557,11 +557,11 @@ void amdgpu_device_wreg(struct amdgpu_device *adev,
 	trace_amdgpu_device_wreg(adev->pdev->device, reg, v);
 }
 
-/*
+/**
  * amdgpu_mm_wreg_mmio_rlc -  write register either with mmio or with RLC path if in range
  *
  * this function is invoked only the debugfs register access
- * */
+ */
 void amdgpu_mm_wreg_mmio_rlc(struct amdgpu_device *adev,
 			     uint32_t reg, uint32_t v)
 {
@@ -1107,7 +1107,7 @@ static void amdgpu_device_wb_fini(struct amdgpu_device *adev)
 }
 
 /**
- * amdgpu_device_wb_init- Init Writeback driver info and allocate memory
+ * amdgpu_device_wb_init - Init Writeback driver info and allocate memory
  *
  * @adev: amdgpu_device pointer
  *
diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
index fa4f0a205127..81d033b99591 100644
--- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
+++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c
@@ -622,7 +622,7 @@ static void dm_dcn_vertical_interrupt0_high_irq(void *interrupt_params)
 #endif
 
 /**
- * dmub_aux_setconfig_reply_callback - Callback for AUX or SET_CONFIG command.
+ * dmub_aux_setconfig_callback - Callback for AUX or SET_CONFIG command.
  * @adev: amdgpu_device pointer
  * @notify: dmub notification structure
  *
-- 
2.40.0

Re: [PATCH] amdgpu: fix some kernel-doc markup

[Greg KH]

On Mon, May 22, 2023 at 08:04:13PM +0800, Stylon Wang wrote:
> From: Yann Dirson <ydirson@free.fr>
> 
> commit 03f2abb07e54b3e0da54c52a656d9765b7e141c5 upstream.
> 
> Those are not today pulled by the sphinx doc, but better be ready.
> 
> Two lines of the cherry-picked patch is removed because they are being
> refactored away from this file:
> drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> 
> Signed-off-by: Yann Dirson <ydirson@free.fr>
> Signed-off-by: Alex Deucher <alexander.deucher@amd.com>
> Reported-by: kernel test robot <lkp@intel.com>
> Link: https://lore.kernel.org/oe-kbuild-all/202302281017.9qcgLAZi-lkp@intel.com/
> Cc: <stable@vger.kernel.org> # 5.15.x
> (cherry picked from commit 03f2abb07e54b3e0da54c52a656d9765b7e141c5)

why is kernel doc issues stable material?  What real fix needs this?

thanks,

greg k-h

Re: [PATCH] amdgpu: fix some kernel-doc markup

[Philip Li]

On Tue, May 23, 2023 at 05:02:02AM +0000, Wang, Chao-kai (Stylon) wrote:
> [AMD Official Use Only - General]
> 
> Hi Greg,
> 
> To be honest, this is just to fix a build error/warning from a Linux kernel performance test:
> https://lore.kernel.org/oe-kbuild-all/202302281017.9qcgLAZi-lkp@intel.com/

Sorry about the confusing report. We will stop the documentation test on linux-stable.git.

> 
> No real bug/fix involved.
> 
> 
> Regards
> 
> Stylon Wang
> 
> MTS Software Development Eng.  |  AMD
> Display Solution Team
> 
> O +(886) 2-3789-3667 ext. 23667  C +(886) 921-897-142
> 
> ----------------------------------------------------------------------------------------------------------------------------------
> 
> 6F, 3, YuanCyu St (NanKang Software Park) Taipei, Taiwan
> 
> Facebook<https://www.facebook.com/AMD> |  Twitter<https://twitter.com/AMD> |  amd.com<http://www.amd.com/>
> 
> 
> 
> ________________________________
> From: Greg KH <gregkh@linuxfoundation.org>
> Sent: May 23, 2023 2:41 AM
> To: Wang, Chao-kai (Stylon) <Stylon.Wang@amd.com>
> Cc: stable@vger.kernel.org <stable@vger.kernel.org>; Shih, Jude <Jude.Shih@amd.com>; Yann Dirson <ydirson@free.fr>; Deucher, Alexander <Alexander.Deucher@amd.com>; kernel test robot <lkp@intel.com>
> Subject: Re: [PATCH] amdgpu: fix some kernel-doc markup
> 
> On Mon, May 22, 2023 at 08:04:13PM +0800, Stylon Wang wrote:
> > From: Yann Dirson <ydirson@free.fr>
> >
> > commit 03f2abb07e54b3e0da54c52a656d9765b7e141c5 upstream.
> >
> > Those are not today pulled by the sphinx doc, but better be ready.
> >
> > Two lines of the cherry-picked patch is removed because they are being
> > refactored away from this file:
> > drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
> >
> > Signed-off-by: Yann Dirson <ydirson@free.fr>
> > Signed-off-by: Alex Deucher <alexander.deucher@amd.com>
> > Reported-by: kernel test robot <lkp@intel.com>
> > Link: https://lore.kernel.org/oe-kbuild-all/202302281017.9qcgLAZi-lkp@intel.com/
> > Cc: <stable@vger.kernel.org> # 5.15.x
> > (cherry picked from commit 03f2abb07e54b3e0da54c52a656d9765b7e141c5)
> 
> why is kernel doc issues stable material?  What real fix needs this?
> 
> thanks,
> 
> greg k-h