All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
@ 2025-10-15 15:20 Ankan Biswas
  2025-10-15 16:39 ` Danilo Krummrich
  2025-10-15 16:41 ` Matt Coster
  0 siblings, 2 replies; 3+ messages in thread
From: Ankan Biswas @ 2025-10-15 15:20 UTC (permalink / raw)
  To: bbrezillon, himal.prasad.ghimiray, dakr, matt.coster, robin.clark,
	matthew.brost, aliceryhl, thomas.hellstrom
  Cc: maarten.lankhorst, mripard, tzimmermann, simona, skhan, khalid,
	david.hunter.linux, linux-kernel, linux-kernel-mentees, dri-devel,
	Ankan Biswas, Stephen Rothwell

The kernel-doc for struct drm_gpuvm_map_req.map was added as '@op_map'
instead of '@map', leading to this warning during htmldocs build:

WARNING: include/drm/drm_gpuvm.h:1083 struct member 'map' not described in 'drm_gpuvm_map_req'

Fixes: 000a45dce7ad ("drm/gpuvm: Pass map arguments through a struct")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/all/20250821133539.03aa298e@canb.auug.org.au/
Signed-off-by: Ankan Biswas <spyjetfayed@gmail.com>
---
Changes in v3:
-  Addled Closes tag in log

Changes in v2:
- typos fixed 'map_ops' -> '@op_map', 'map' -> '@map'

 include/drm/drm_gpuvm.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/drm/drm_gpuvm.h b/include/drm/drm_gpuvm.h
index 8890ded1d907..476990e761f8 100644
--- a/include/drm/drm_gpuvm.h
+++ b/include/drm/drm_gpuvm.h
@@ -1078,7 +1078,7 @@ struct drm_gpuva_ops {
  */
 struct drm_gpuvm_map_req {
 	/**
-	 * @op_map: struct drm_gpuva_op_map
+	 * @map: struct drm_gpuva_op_map
 	 */
 	struct drm_gpuva_op_map map;
 };
-- 
2.51.0


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

* Re: [PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
  2025-10-15 15:20 [PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map Ankan Biswas
@ 2025-10-15 16:39 ` Danilo Krummrich
  2025-10-15 16:41 ` Matt Coster
  1 sibling, 0 replies; 3+ messages in thread
From: Danilo Krummrich @ 2025-10-15 16:39 UTC (permalink / raw)
  To: Ankan Biswas
  Cc: bbrezillon, himal.prasad.ghimiray, matt.coster, robin.clark,
	matthew.brost, aliceryhl, thomas.hellstrom, maarten.lankhorst,
	mripard, tzimmermann, simona, skhan, khalid, david.hunter.linux,
	linux-kernel, linux-kernel-mentees, dri-devel, Stephen Rothwell

On Wed Oct 15, 2025 at 5:20 PM CEST, Ankan Biswas wrote:
> The kernel-doc for struct drm_gpuvm_map_req.map was added as '@op_map'
> instead of '@map', leading to this warning during htmldocs build:
>
> WARNING: include/drm/drm_gpuvm.h:1083 struct member 'map' not described in 'drm_gpuvm_map_req'
>
> Fixes: 000a45dce7ad ("drm/gpuvm: Pass map arguments through a struct")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/all/20250821133539.03aa298e@canb.auug.org.au/
> Signed-off-by: Ankan Biswas <spyjetfayed@gmail.com>

Applied to drm-misc-fixes, thanks!

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

* Re: [PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
  2025-10-15 15:20 [PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map Ankan Biswas
  2025-10-15 16:39 ` Danilo Krummrich
@ 2025-10-15 16:41 ` Matt Coster
  1 sibling, 0 replies; 3+ messages in thread
From: Matt Coster @ 2025-10-15 16:41 UTC (permalink / raw)
  To: Ankan Biswas
  Cc: bbrezillon@kernel.org, himal.prasad.ghimiray@intel.com,
	dakr@kernel.org, robin.clark@oss.qualcomm.com,
	matthew.brost@intel.com, aliceryhl@google.com,
	thomas.hellstrom@linux.intel.com,
	maarten.lankhorst@linux.intel.com, mripard@kernel.org,
	tzimmermann@suse.de, simona@ffwll.ch, skhan@linuxfoundation.org,
	khalid@kernel.org, david.hunter.linux@gmail.com,
	linux-kernel@vger.kernel.org,
	linux-kernel-mentees@lists.linux.dev,
	dri-devel@lists.freedesktop.org, Stephen Rothwell


[-- Attachment #1.1: Type: text/plain, Size: 1516 bytes --]

On 15/10/2025 16:20, Ankan Biswas wrote:
> The kernel-doc for struct drm_gpuvm_map_req.map was added as '@op_map'
> instead of '@map', leading to this warning during htmldocs build:
> 
> WARNING: include/drm/drm_gpuvm.h:1083 struct member 'map' not described in 'drm_gpuvm_map_req'
> 
> Fixes: 000a45dce7ad ("drm/gpuvm: Pass map arguments through a struct")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/all/20250821133539.03aa298e@canb.auug.org.au/ 
> Signed-off-by: Ankan Biswas <spyjetfayed@gmail.com>

Hi Ankan,

Thanks for the updated patch! All looks good to me, so:

Reviewed-by: Matt Coster <matt.coster@imgtec.com>

No need to send a v4 adding my tag, it'll get picked up when I apply to
drm-misc-fixes on Friday (assuming nobody has any objections).

Cheers,
Matt

> ---
> Changes in v3:
> -  Addled Closes tag in log
> 
> Changes in v2:
> - typos fixed 'map_ops' -> '@op_map', 'map' -> '@map'
> 
>  include/drm/drm_gpuvm.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/drm/drm_gpuvm.h b/include/drm/drm_gpuvm.h
> index 8890ded1d907..476990e761f8 100644
> --- a/include/drm/drm_gpuvm.h
> +++ b/include/drm/drm_gpuvm.h
> @@ -1078,7 +1078,7 @@ struct drm_gpuva_ops {
>   */
>  struct drm_gpuvm_map_req {
>  	/**
> -	 * @op_map: struct drm_gpuva_op_map
> +	 * @map: struct drm_gpuva_op_map
>  	 */
>  	struct drm_gpuva_op_map map;
>  };

-- 
Matt Coster
E: matt.coster@imgtec.com

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 236 bytes --]

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

end of thread, other threads:[~2025-10-15 16:42 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-15 15:20 [PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map Ankan Biswas
2025-10-15 16:39 ` Danilo Krummrich
2025-10-15 16:41 ` Matt Coster

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.