* Re: [PATCH v2] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
2025-10-15 11:31 [PATCH v2] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map Ankan Biswas
@ 2025-10-15 13:26 ` Matt Coster
2025-10-15 13:39 ` Danilo Krummrich
2025-10-15 15:36 ` Ankan Biswas
2 siblings, 0 replies; 4+ messages in thread
From: Matt Coster @ 2025-10-15 13:26 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, Alessio Belle,
Alexandru Dadu, Frank Binns
[-- Attachment #1.1: Type: text/plain, Size: 1466 bytes --]
On 15/10/2025 12:31, 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>
> Signed-off-by: Ankan Biswas <spyjetfayed@gmail.com>
Hi Ankan,
Thanks for the fix! Is there a public report from Stephen that you can
link to with a Closes: tag after the Reported-by: tag (see [1])?
Otherwise, this looks good to me and I'll be happy to R-b and take it
via drm-misc-fixes.
Cheers,
Matt
[1]: https://www.kernel.org/doc/html/latest/process/5.Posting.html#patch-formatting-and-changelogs
> ---
> 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] 4+ messages in thread* Re: [PATCH v2] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
2025-10-15 11:31 [PATCH v2] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map Ankan Biswas
2025-10-15 13:26 ` Matt Coster
@ 2025-10-15 13:39 ` Danilo Krummrich
2025-10-15 15:36 ` Ankan Biswas
2 siblings, 0 replies; 4+ messages in thread
From: Danilo Krummrich @ 2025-10-15 13: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 10/15/25 1:31 PM, 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>
Please add a Closes: tag, checkpatch.pl should warn about this.
Thanks,
Danilo
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH v2] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map
2025-10-15 11:31 [PATCH v2] drm/gpuvm: Fix kernel-doc warning for drm_gpuvm_map_req.map Ankan Biswas
2025-10-15 13:26 ` Matt Coster
2025-10-15 13:39 ` Danilo Krummrich
@ 2025-10-15 15:36 ` Ankan Biswas
2 siblings, 0 replies; 4+ messages in thread
From: Ankan Biswas @ 2025-10-15 15:36 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,
Stephen Rothwell
On 10/15/25 6:56 PM, Matt Coster wrote:
> On 15/10/2025 12:31, 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>
>> Signed-off-by: Ankan Biswas<spyjetfayed@gmail.com>
> Hi Ankan,
>
> Thanks for the fix! Is there a public report from Stephen that you can
> link to with a Closes: tag after the Reported-by: tag (see [1])?
Hi Matt
Thanks for pointing that out, I have added the Closes tag for v3.
And resent it.
>
> Otherwise, this looks good to me and I'll be happy to R-b and take it
> via drm-misc-fixes.
On 10/15/25 7:09 PM, Danilo Krummrich wrote:
> On 10/15/25 1:31 PM, 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>
> Please add a Closes: tag, checkpatch.pl should warn about this.
>
> Thanks,
> Danilo
Hi Danilo,
My bad, I did not use checkpatch.pl before sending, I didn't know
it also caught missing tags. Thanks for mentioning it.
Best Regards,
Ankan Biswas
^ permalink raw reply [flat|nested] 4+ messages in thread