[PATCH] drm/amd: fix kernel-doc parameter tag format

Abdelrahman Fekry posted 1 patch 8 months, 4 weeks ago
drivers/gpu/drm/amd/include/amd_shared.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] drm/amd: fix kernel-doc parameter tag format
Posted by Abdelrahman Fekry 8 months, 4 weeks ago
The DC_HDCP_LC_ENABLE_SW_FALLBACK enum comment was missing the required
colon after the parameter name in its kernel-doc tag:

  * @DC_HDCP_LC_ENABLE_SW_FALLBACK If set, ...

Kernel-doc insists on the form @name: description. Adding the colon
eliminates the warning and ensures consistent extraction into Sphinx
documentation. No functional changes are made.

Signed-off-by: Abdelrahman Fekry <Abdelrahmanfekry375@gmail.com>
---
 drivers/gpu/drm/amd/include/amd_shared.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/gpu/drm/amd/include/amd_shared.h b/drivers/gpu/drm/amd/include/amd_shared.h
index 4c95b885d1d0..c8eccee9b023 100644
--- a/drivers/gpu/drm/amd/include/amd_shared.h
+++ b/drivers/gpu/drm/amd/include/amd_shared.h
@@ -366,7 +366,7 @@ enum DC_DEBUG_MASK {
 	DC_HDCP_LC_FORCE_FW_ENABLE = 0x80000,
 
 	/**
-	 * @DC_HDCP_LC_ENABLE_SW_FALLBACK If set, upon HDCP Locality Check FW
+	 * @DC_HDCP_LC_ENABLE_SW_FALLBACK: If set, upon HDCP Locality Check FW
 	 * path failure, retry using legacy SW path.
 	 */
 	DC_HDCP_LC_ENABLE_SW_FALLBACK = 0x100000,
-- 
2.25.1
Re: [PATCH] drm/amd: fix kernel-doc parameter tag format
Posted by Alex Deucher 8 months, 4 weeks ago
On Wed, May 14, 2025 at 3:31 AM Abdelrahman Fekry
<abdelrahmanfekry375@gmail.com> wrote:
>
> The DC_HDCP_LC_ENABLE_SW_FALLBACK enum comment was missing the required
> colon after the parameter name in its kernel-doc tag:
>
>   * @DC_HDCP_LC_ENABLE_SW_FALLBACK If set, ...
>
> Kernel-doc insists on the form @name: description. Adding the colon
> eliminates the warning and ensures consistent extraction into Sphinx
> documentation. No functional changes are made.
>
> Signed-off-by: Abdelrahman Fekry <Abdelrahmanfekry375@gmail.com>

Thanks for the patch, but this was already fixed.

Alex

> ---
>  drivers/gpu/drm/amd/include/amd_shared.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/amd/include/amd_shared.h b/drivers/gpu/drm/amd/include/amd_shared.h
> index 4c95b885d1d0..c8eccee9b023 100644
> --- a/drivers/gpu/drm/amd/include/amd_shared.h
> +++ b/drivers/gpu/drm/amd/include/amd_shared.h
> @@ -366,7 +366,7 @@ enum DC_DEBUG_MASK {
>         DC_HDCP_LC_FORCE_FW_ENABLE = 0x80000,
>
>         /**
> -        * @DC_HDCP_LC_ENABLE_SW_FALLBACK If set, upon HDCP Locality Check FW
> +        * @DC_HDCP_LC_ENABLE_SW_FALLBACK: If set, upon HDCP Locality Check FW
>          * path failure, retry using legacy SW path.
>          */
>         DC_HDCP_LC_ENABLE_SW_FALLBACK = 0x100000,
> --
> 2.25.1
>