linux-kernel - Re: [PATCH 1/1] drm/amd: Fix malformed kerneldoc comment

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_OB=HLZ+ArqhDQtafFyc2a034jqEN5JsbN36Q0fUdk3qw@mail.gmail.com>
Date: Mon, 28 Apr 2025 13:38:21 -0400
From: Alex Deucher <alexdeucher@...il.com>
To: Brahmajit Das <brahmajit.xyz@...il.com>
Cc: Alex Deucher <alexander.deucher@....com>, 
	Christian König <christian.koenig@....com>, 
	David Airlie <airlied@...il.com>, Simona Vetter <simona@...ll.ch>, Sunil Khatri <sunil.khatri@....com>, 
	Mario Limonciello <mario.limonciello@....com>, Aurabindo Pillai <aurabindo.pillai@....com>, 
	Boyuan Zhang <boyuan.zhang@....com>, Leo Li <sunpeng.li@....com>, 
	Dominik Kaszewski <dominik.kaszewski@....com>, amd-gfx@...ts.freedesktop.org, 
	dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 1/1] drm/amd: Fix malformed kerneldoc comment

Thanks for the patch.  This was already fixed.

Alex

On Mon, Apr 28, 2025 at 8:53 AM Brahmajit Das <brahmajit.xyz@...il.com> wrote:
>
> One kerneldoc commets in amd_shared.h failed to adhere to required
> format, resulting in these doc-build warnings:
>
> ./drivers/gpu/drm/amd/include/amd_shared.h:369: warning: Incorrect use of kernel-doc format:          * @DC_HDCP_LC_ENABLE_SW_FALLBACK If set, upon HDCP Locality Check FW
> ./drivers/gpu/drm/amd/include/amd_shared.h:369: warning: Incorrect use of kernel-doc format:          * @DC_HDCP_LC_ENABLE_SW_FALLBACK If set, upon HDCP Locality Check FW
> ./drivers/gpu/drm/amd/include/amd_shared.h:373: warning: Enum value 'DC_HDCP_LC_ENABLE_SW_FALLBACK' not described in enum 'DC_DEBUG_MASK'
>
> Adding missing colon symbol and making kernel doc happy :)
>
> Signed-off-by: Brahmajit Das <listout@...tout.xyz>
> ---
>  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.49.0
>