Re: [PATCH] drm/xe: Fix typos and improve kernel-doc comments in xe_gt

[Jani Nikula <jani.nikula@linux.intel.com>]

On Fri, 03 Oct 2025, Shuicheng Lin <shuicheng.lin@intel.com> wrote:
> 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;
>  };
>  
> -/*
> +/**

enum xe_steering_type comments has no kernel-doc formatting, so it
shouldn't have /** either.

>   * 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;

-- 
Jani Nikula, Intel