linux-kernel - Re: [PATCH] drm/amd: fix kernel-doc parameter tag 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] [day] [month] [year] [list]

Message-ID: <CADnq5_MAYSH0Cj6pfZFdPx8b_goJRFEeB61iW6bD_wON-GWxzg@mail.gmail.com>
Date: Wed, 14 May 2025 10:16:05 -0400
From: Alex Deucher <alexdeucher@...il.com>
To: Abdelrahman Fekry <abdelrahmanfekry375@...il.com>
Cc: alexander.deucher@....com, christian.koenig@....com, airlied@...il.com, 
	simona@...ll.ch, skhan@...uxfoundation.org, amd-gfx@...ts.freedesktop.org, 
	dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org, 
	linux-kernel-mentees@...ts.linux.dev
Subject: Re: [PATCH] drm/amd: fix kernel-doc parameter tag format

On Wed, May 14, 2025 at 3:31 AM Abdelrahman Fekry
<abdelrahmanfekry375@...il.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@...il.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
>