diff mbox series

drm: xlnx: zynqmp_dpsub: Fix kernel doc

Message ID 20241220-xilinx-dp-audio-doc-fix-v1-1-cc488996e463@ideasonboard.com (mailing list archive)
State New
Headers show
Series drm: xlnx: zynqmp_dpsub: Fix kernel doc | expand

Commit Message

Tomi Valkeinen Dec. 20, 2024, 7:29 a.m. UTC 
Fix two kernel doc warnings introduced by the recent DP audio patch:

- Add a doc line for the new "audio" field
- Remove a reference to zynqmp_dpsub.c from zynqmp.rst, as the .c file
  no longer has structured comments

Fixes: 3ec5c1579305 ("drm: xlnx: zynqmp_dpsub: Add DP audio support")
Closes: https://lore.kernel.org/all/20241220154208.720d990b@canb.auug.org.au/
Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
---
 Documentation/gpu/zynqmp.rst        | 2 --
 drivers/gpu/drm/xlnx/zynqmp_dpsub.h | 1 +
 2 files changed, 1 insertion(+), 2 deletions(-)


---
base-commit: 74ef9527bd87ead62deabe749a6d867af748d448
change-id: 20241220-xilinx-dp-audio-doc-fix-0651029616e7

Best regards,

Comments

Sagar, Vishal Dec. 20, 2024, 8:31 a.m. UTC | #1 
[AMD Official Use Only - AMD Internal Distribution Only]

Hi Tomi,

Thanks for the patch.

> -----Original Message-----
> From: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
> Sent: Friday, December 20, 2024 8:30 AM
> To: Laurent Pinchart <laurent.pinchart@ideasonboard.com>; Maarten Lankhorst
> <maarten.lankhorst@linux.intel.com>; Maxime Ripard <mripard@kernel.org>;
> Thomas Zimmermann <tzimmermann@suse.de>; David Airlie
> <airlied@gmail.com>; Simona Vetter <simona@ffwll.ch>; Jonathan Corbet
> <corbet@lwn.net>; Simek, Michal <michal.simek@amd.com>; Sagar, Vishal
> <vishal.sagar@amd.com>
> Cc: dri-devel@lists.freedesktop.org; linux-doc@vger.kernel.org; linux-arm-
> kernel@lists.infradead.org; linux-kernel@vger.kernel.org; Tomi Valkeinen
> <tomi.valkeinen@ideasonboard.com>
> Subject: [PATCH] drm: xlnx: zynqmp_dpsub: Fix kernel doc
>
> Fix two kernel doc warnings introduced by the recent DP audio patch:
>
> - Add a doc line for the new "audio" field
> - Remove a reference to zynqmp_dpsub.c from zynqmp.rst, as the .c file
>   no longer has structured comments
>
> Fixes: 3ec5c1579305 ("drm: xlnx: zynqmp_dpsub: Add DP audio support")
> Closes: https://lore.kernel.org/all/20241220154208.720d990b@canb.auug.org.au/
> Signed-off-by: Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>
> ---
>  Documentation/gpu/zynqmp.rst        | 2 --
>  drivers/gpu/drm/xlnx/zynqmp_dpsub.h | 1 +
>  2 files changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/Documentation/gpu/zynqmp.rst b/Documentation/gpu/zynqmp.rst
> index f57bfa0ad6ec..1a6f9193de22 100644
> --- a/Documentation/gpu/zynqmp.rst
> +++ b/Documentation/gpu/zynqmp.rst
> @@ -144,6 +144,4 @@ Internals
>
>  .. kernel-doc:: drivers/gpu/drm/xlnx/zynqmp_dp.c
>
> -.. kernel-doc:: drivers/gpu/drm/xlnx/zynqmp_dpsub.c
> -
>  .. kernel-doc:: drivers/gpu/drm/xlnx/zynqmp_kms.c
> diff --git a/drivers/gpu/drm/xlnx/zynqmp_dpsub.h
> b/drivers/gpu/drm/xlnx/zynqmp_dpsub.h
> index 49875529c2a4..d771b8b199e0 100644
> --- a/drivers/gpu/drm/xlnx/zynqmp_dpsub.h
> +++ b/drivers/gpu/drm/xlnx/zynqmp_dpsub.h
> @@ -60,6 +60,7 @@ struct zynqmp_dpsub_audio;
>   * @layers: Video and graphics layers
>   * @dp: The DisplayPort controller
>   * @dma_align: DMA alignment constraint (must be a power of 2)
> + * @audio: DP audio data
>   */
>  struct zynqmp_dpsub {
>       struct device *dev;
>
> ---
> base-commit: 74ef9527bd87ead62deabe749a6d867af748d448
> change-id: 20241220-xilinx-dp-audio-doc-fix-0651029616e7
>
> Best regards,
> --
> Tomi Valkeinen <tomi.valkeinen@ideasonboard.com>

This looks good to me. Apologies for missing this in my earlier review.

I tested this patch with
./scripts/kernel-doc -none drivers/gpu/drm/xlnx/zynqmp_dpsub.c
make htmldocs

Please feel free to add

Reviewed-by: Vishal Sagar <vishal.sagar@amd.com>

Regards
Vishal Sagar
diff mbox series

Patch

diff --git a/Documentation/gpu/zynqmp.rst b/Documentation/gpu/zynqmp.rst
index f57bfa0ad6ec..1a6f9193de22 100644
--- a/Documentation/gpu/zynqmp.rst
+++ b/Documentation/gpu/zynqmp.rst
@@ -144,6 +144,4 @@  Internals
 
 .. kernel-doc:: drivers/gpu/drm/xlnx/zynqmp_dp.c
 
-.. kernel-doc:: drivers/gpu/drm/xlnx/zynqmp_dpsub.c
-
 .. kernel-doc:: drivers/gpu/drm/xlnx/zynqmp_kms.c
diff --git a/drivers/gpu/drm/xlnx/zynqmp_dpsub.h b/drivers/gpu/drm/xlnx/zynqmp_dpsub.h
index 49875529c2a4..d771b8b199e0 100644
--- a/drivers/gpu/drm/xlnx/zynqmp_dpsub.h
+++ b/drivers/gpu/drm/xlnx/zynqmp_dpsub.h
@@ -60,6 +60,7 @@  struct zynqmp_dpsub_audio;
  * @layers: Video and graphics layers
  * @dp: The DisplayPort controller
  * @dma_align: DMA alignment constraint (must be a power of 2)
+ * @audio: DP audio data
  */
 struct zynqmp_dpsub {
 	struct device *dev;