[PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map

Ankan Biswas posted 1 patch 2 months ago
include/drm/drm_gpuvm.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
Posted by Ankan Biswas 2 months ago
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
Re: [PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
Posted by Matt Coster 2 months ago
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
Re: [PATCH v3] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
Posted by Danilo Krummrich 2 months ago
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!