dri-devel.lists.freedesktop.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/2] drm: fix kernel-doc struct tag for `drm_format_info`.
@ 2025-08-23  7:51 Javier Garcia
  2025-08-23  7:51 ` [PATCH 2/2] drm: fix kernel-doc struct tag for `drm_modeset_lock` Javier Garcia
  0 siblings, 1 reply; 4+ messages in thread
From: Javier Garcia @ 2025-08-23  7:51 UTC (permalink / raw)
  To: maarten.lankhorst, mripard, tzimmermann, airlied, simona
  Cc: dri-devel, linux-kernel, Javier Garcia

- 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:360: ./drivers/gpu/drm/drm_fourcc.c:397: WARNING: Duplicate C declaration, also defined at gpu/drm-kms:35.
	Declaration is '.. c:function:: const struct drm_format_info * drm_format_info (u32 format)'. [duplicate_declaration.c]

Fixes: 84770cc24f3a ("drm: Centralize format information")
Signed-off-by: Javier Garcia <rampxxxx@gmail.com>
---
 include/drm/drm_fourcc.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/drm/drm_fourcc.h b/include/drm/drm_fourcc.h
index 471784426857..ba25beeb28cb 100644
--- a/include/drm/drm_fourcc.h
+++ b/include/drm/drm_fourcc.h
@@ -56,7 +56,7 @@
 struct drm_device;
 
 /**
- * struct drm_format_info - information about a DRM format
+ * @struct drm_format_info - information about a DRM format
  */
 struct drm_format_info {
 	/** @format: 4CC format identifier (DRM_FORMAT_*) */
-- 
2.50.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* [PATCH 2/2] drm: fix kernel-doc struct tag for `drm_modeset_lock`.
  2025-08-23  7:51 [PATCH 1/2] drm: fix kernel-doc struct tag for `drm_format_info` Javier Garcia
@ 2025-08-23  7:51 ` Javier Garcia
  2025-08-25  8:00   ` Jani Nikula
  0 siblings, 1 reply; 4+ messages in thread
From: Javier Garcia @ 2025-08-23  7:51 UTC (permalink / raw)
  To: maarten.lankhorst, mripard, tzimmermann, airlied, simona
  Cc: dri-devel, linux-kernel, Javier Garcia

- 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]

Fixes: f3a808817fdb ("drm: fix drm_modeset_lock.h kernel-doc notation")
Signed-off-by: Javier Garcia <rampxxxx@gmail.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
-- 
2.50.1


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH 2/2] drm: fix kernel-doc struct tag for `drm_modeset_lock`.
  2025-08-23  7:51 ` [PATCH 2/2] drm: fix kernel-doc struct tag for `drm_modeset_lock` Javier Garcia
@ 2025-08-25  8:00   ` Jani Nikula
  2025-08-25 18:01     ` Giant Sand Fans
  0 siblings, 1 reply; 4+ messages in thread
From: Jani Nikula @ 2025-08-25  8:00 UTC (permalink / raw)
  To: Javier Garcia, maarten.lankhorst, mripard, tzimmermann, airlied,
	simona
  Cc: dri-devel, linux-kernel, Javier Garcia

On Sat, 23 Aug 2025, Javier Garcia <rampxxxx@gmail.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@gmail.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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH 2/2] drm: fix kernel-doc struct tag for `drm_modeset_lock`.
  2025-08-25  8:00   ` Jani Nikula
@ 2025-08-25 18:01     ` Giant Sand Fans
  0 siblings, 0 replies; 4+ messages in thread
From: Giant Sand Fans @ 2025-08-25 18:01 UTC (permalink / raw)
  To: Jani Nikula
  Cc: maarten.lankhorst, mripard, tzimmermann, airlied, simona,
	dri-devel, linux-kernel

On Mon, 25 Aug 2025 at 10:00, Jani Nikula <jani.nikula@linux.intel.com> wrote:
>
> On Sat, 23 Aug 2025, Javier Garcia <rampxxxx@gmail.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.

Thank you for the comment, I'll look deeper into this.

>
>
> BR,
> Jani.
>
> >
> > Fixes: f3a808817fdb ("drm: fix drm_modeset_lock.h kernel-doc notation")
> > Signed-off-by: Javier Garcia <rampxxxx@gmail.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

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2025-08-25 18:01 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-23  7:51 [PATCH 1/2] drm: fix kernel-doc struct tag for `drm_format_info` Javier Garcia
2025-08-23  7:51 ` [PATCH 2/2] drm: fix kernel-doc struct tag for `drm_modeset_lock` Javier Garcia
2025-08-25  8:00   ` Jani Nikula
2025-08-25 18:01     ` Giant Sand Fans

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).