Re: [PATCH 0/5] drm/xe/uapi: Update xe_drm.h documentation

["Wang, X" <x.wang@intel.com>]

On 3/31/2026 10:20, Shuicheng Lin wrote:
> This series fixes various documentation issues in the Xe DRM
> UAPI header (xe_drm.h). All changes are doc-comment-only with
> no functional impact.
>
> The fixes are split into 5 patches by category:
>
> Patch 1: Typos and spelling errors (7 fixes)
>    Basic misspellings like creaed, mmaping, 0xdeadbeaf, and
>    incorrect names like MONOTONIC_CLOCK (should be
>    CLOCK_MONOTONIC).
>
> Patch 2: Grammar errors (11 fixes)
>    Missing words, wrong articles, subject-verb agreement,
>    e.g. "should only ever used", "must qword aligned",
>    "the users responsibility".
>
> Patch 3: Wrong names and references (12 fixes)
>    Incorrect field names, struct names, ioctl names, and
>    kernel-doc cross-reference prefixes. For example,
>    referencing non-existent probed_size instead of
>    @cpu_visible_size, wrong ioctl name
>    DRM_IOCTL_XE_VM_QUERY_MEM_RANGES_ATTRS, and using &
>    instead of % for constant references.
>
> Patch 4: Code examples (4 fixes)
>    Outdated field names in struct initializer examples
>    (.num_bb_per_exec -> .width, .num_eng_per_bb ->
>    .num_placements), wrong nested field access
>    (.atomic_val -> .atomic.val), and unnecessary backslash
>    escaping in UUID format string.
>
> Patch 5: Formatting and completeness (4 fixes)
>    Missing entries in the IOCTL overview list and device
>    query doc list, a formatting issue with a closing */,
>    and ioctl's -> ioctls.
>
> Shuicheng Lin (5):
>    drm/xe/uapi: Fix typos and spelling errors in xe_drm.h documentation
>    drm/xe/uapi: Fix grammar errors in xe_drm.h documentation
>    drm/xe/uapi: Fix wrong names and references in xe_drm.h
>    drm/xe/uapi: Fix code examples in xe_drm.h documentation
>    drm/xe/uapi: Fix doc formatting and completeness in xe_drm.h
>
>   include/uapi/drm/xe_drm.h | 86 ++++++++++++++++++++-------------------
>   1 file changed, 44 insertions(+), 42 deletions(-)

I think we need another patch to fix the  @  -> %  @ -> & usage like

- * @DRM_XE_OBSERVATION_IOCTL_CONFIG observation stream fd ioctl, though 
only a
+ * &DRM_XE_OBSERVATION_IOCTL_CONFIG observation stream fd ioctl, though 
only a


- * is equal to @DRM_XE_DEVICE_QUERY_EU_STALL, then the reply uses
+ * is equal to %DRM_XE_DEVICE_QUERY_EU_STALL, then the reply uses