linux-kernel - Re: [PATCH 2/2] drm: fix kernel-doc struct tag for `drm_modeset

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <704edc3cae07cf09f27ff476ff11ca5dd2779520@intel.com>
Date: Mon, 25 Aug 2025 11:00:33 +0300
From: Jani Nikula <jani.nikula@...ux.intel.com>
To: Javier Garcia <rampxxxx@...il.com>, maarten.lankhorst@...ux.intel.com,
 mripard@...nel.org, tzimmermann@...e.de, airlied@...il.com,
 simona@...ll.ch
Cc: dri-devel@...ts.freedesktop.org, linux-kernel@...r.kernel.org, Javier
 Garcia <rampxxxx@...il.com>
Subject: Re: [PATCH 2/2] drm: fix kernel-doc struct tag for `drm_modeset_lock`.

On Sat, 23 Aug 2025, Javier Garcia <rampxxxx@...il.com> wrote:
> - Add needed "@" to avoid warn messages about duplicated symbols
> as there is function and struct with the same name.
> - The fixed warning is:
>
> 	./Documentation/gpu/drm-kms:476: ./drivers/gpu/drm/drm_modeset_lock.c:377: WARNING: Duplicate C declaration, also defined at gpu/drm-kms:48.
> 	Declaration is '.. c:function:: int drm_modeset_lock (struct drm_modeset_lock *lock, struct drm_modeset_acquire_ctx *ctx)'. [duplicate_declaration.c]

Please look into why adding @ here appear to fix the issue.

The problem is deeper than what this patch makes it seem, and this
papers over the issue in a way that sets the wrong example for the
future.

BR,
Jani.

>
> Fixes: f3a808817fdb ("drm: fix drm_modeset_lock.h kernel-doc notation")
> Signed-off-by: Javier Garcia <rampxxxx@...il.com>
> ---
>  include/drm/drm_modeset_lock.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/drm/drm_modeset_lock.h b/include/drm/drm_modeset_lock.h
> index ec4f543c3d95..0de7046dc653 100644
> --- a/include/drm/drm_modeset_lock.h
> +++ b/include/drm/drm_modeset_lock.h
> @@ -75,7 +75,7 @@ struct drm_modeset_acquire_ctx {
>  };
>  
>  /**
> - * struct drm_modeset_lock - used for locking modeset resources.
> + * @struct drm_modeset_lock - used for locking modeset resources.
>   * @mutex: resource locking
>   * @head: used to hold its place on &drm_atomi_state.locked list when
>   *    part of an atomic update

-- 
Jani Nikula, Intel