Intel-XE Archive on lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] drm/xe: Fix typos and improve kernel-doc comments in xe_gt
@ 2025-10-03 23:48 Shuicheng Lin
  2025-10-03 23:58 ` ✓ CI.KUnit: success for " Patchwork
                   ` (7 more replies)
  0 siblings, 8 replies; 10+ messages in thread
From: Shuicheng Lin @ 2025-10-03 23:48 UTC (permalink / raw)
  To: intel-xe; +Cc: Shuicheng Lin

Correct several spelling and grammar issues in xe_gt struct
documentation to improve readability:

- Use proper kernel-doc comment opener (`/**`).
- Fix "to not" -> "do not".
- Fix "mmigrations" -> "migrations".
- Fix "Multiple queues exists" -> "Multiple queues exist".
- Fix "are be processed" -> "to be processed".
- Fix "have being processed" -> "have been processed".

These changes are purely cosmetic and do not affect functionality.

Signed-off-by: Shuicheng Lin <shuicheng.lin@intel.com>
---
 drivers/gpu/drm/xe/xe_gt_types.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/drivers/gpu/drm/xe/xe_gt_types.h b/drivers/gpu/drm/xe/xe_gt_types.h
index 66158105aca5..8fb4ea1d90f5 100644
--- a/drivers/gpu/drm/xe/xe_gt_types.h
+++ b/drivers/gpu/drm/xe/xe_gt_types.h
@@ -50,7 +50,7 @@ struct xe_mmio_range {
 	u32 end;
 };
 
-/*
+/**
  * The hardware has multiple kinds of multicast register ranges that need
  * special register steering (and future platforms are expected to add
  * additional types).
@@ -202,14 +202,14 @@ struct xe_gt {
 		/**
 		 * @usm.bb_pool: Pool from which batchbuffers, for USM operations
 		 * (e.g. migrations, fixing page tables), are allocated.
-		 * Dedicated pool needed so USM operations to not get blocked
+		 * Dedicated pool needed so USM operations do not get blocked
 		 * behind any user operations which may have resulted in a
 		 * fault.
 		 */
 		struct xe_sa_manager *bb_pool;
 		/**
 		 * @usm.reserved_bcs_instance: reserved BCS instance used for USM
-		 * operations (e.g. mmigrations, fixing page tables)
+		 * operations (e.g. migrations, fixing page tables)
 		 */
 		u16 reserved_bcs_instance;
 		/** @usm.pf_wq: page fault work queue, unbound, high priority */
@@ -220,8 +220,8 @@ struct xe_gt {
 		 * @usm.pf_queue: Page fault queue used to sync faults so faults can
 		 * be processed not under the GuC CT lock. The queue is sized so
 		 * it can sync all possible faults (1 per physical engine).
-		 * Multiple queues exists for page faults from different VMs are
-		 * be processed in parallel.
+		 * Multiple queues exist for page faults from different VMs to be
+		 * processed in parallel.
 		 */
 		struct pf_queue {
 			/** @usm.pf_queue.gt: back pointer to GT */
@@ -387,7 +387,7 @@ struct xe_gt {
 		/**
 		 * @wa_active.oob_initialized: mark oob as initialized to help
 		 * detecting misuse of XE_GT_WA() - it can only be called on
-		 * initialization after OOB WAs have being processed
+		 * initialization after OOB WAs have been processed
 		 */
 		bool oob_initialized;
 	} wa_active;
-- 
2.49.0


^ permalink raw reply related	[flat|nested] 10+ messages in thread
end of thread, other threads:[~2025-10-06 20:13 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-03 23:48 [PATCH] drm/xe: Fix typos and improve kernel-doc comments in xe_gt Shuicheng Lin
2025-10-03 23:58 ` ✓ CI.KUnit: success for " Patchwork
2025-10-04  0:38 ` ✓ Xe.CI.BAT: " Patchwork
2025-10-04  1:45 ` ✓ Xe.CI.Full: " Patchwork
2025-10-06  7:26 ` [PATCH] " Jani Nikula
2025-10-06 15:13 ` [PATCH] drm/xe: Fix comments in xe_gt struct Shuicheng Lin
2025-10-06 18:46   ` Matthew Brost
2025-10-06 16:09 ` ✓ CI.KUnit: success for drm/xe: Fix typos and improve kernel-doc comments in xe_gt (rev2) Patchwork
2025-10-06 16:54 ` ✓ Xe.CI.BAT: " Patchwork
2025-10-06 20:13 ` ✓ Xe.CI.Full: " Patchwork

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox