linux-kernel - [PATCH] docs: drm/gpuvm: Describe map member in drm_gpuvm_map

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <20250917062420.69986-2-nirbhay.lkd@gmail.com>
Date: Wed, 17 Sep 2025 11:54:20 +0530
From: Nirbhay Sharma <nirbhay.lkd@...il.com>
To: dakr@...nel.org
Cc: Nirbhay Sharma <nirbhay.lkd@...il.com>,
	Matthew Brost <matthew.brost@...el.com>,
	Thomas Hellström <thomas.hellstrom@...ux.intel.com>,
	Alice Ryhl <aliceryhl@...gle.com>,
	Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>,
	Maxime Ripard <mripard@...nel.org>,
	Thomas Zimmermann <tzimmermann@...e.de>,
	David Airlie <airlied@...il.com>,
	Simona Vetter <simona@...ll.ch>,
	dri-devel@...ts.freedesktop.org,
	linux-kernel@...r.kernel.org
Subject: [PATCH] docs: drm/gpuvm: Describe map member in drm_gpuvm_map_req

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@...il.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