[PATCH] docs: drm/gpuvm: Describe map member in drm_gpuvm_map_req

Nirbhay Sharma posted 1 patch 2 weeks, 1 day ago
include/drm/drm_gpuvm.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] docs: drm/gpuvm: Describe map member in drm_gpuvm_map_req
Posted by Nirbhay Sharma 2 weeks, 1 day ago
The kernel doc build (makedocs) threw a warning because the @op_map comment
did not match the 'map' member name in the struct.

Fix this by correcting the member name in the comment from @op_map to @map.
While at it, improve the description from simply repeating the data
type to explaining the member's purpose.

Signed-off-by: Nirbhay Sharma <nirbhay.lkd@gmail.com>
---
 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..1c851c3f778e 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: The GPUVA map operation and its arguments
 	 */
 	struct drm_gpuva_op_map map;
 };
-- 
2.51.0