public inbox for intel-xe@lists.freedesktop.org
 help / color / mirror / Atom feed
* [PATCH 0/5] drm/xe/uapi: Update xe_drm.h documentation
@ 2026-03-31 17:20 Shuicheng Lin
  2026-03-31 17:20 ` [PATCH 1/5] drm/xe/uapi: Fix typos and spelling errors in " Shuicheng Lin
                   ` (9 more replies)
  0 siblings, 10 replies; 16+ messages in thread
From: Shuicheng Lin @ 2026-03-31 17:20 UTC (permalink / raw)
  To: intel-xe; +Cc: Shuicheng Lin

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(-)

-- 
2.43.0


^ permalink raw reply	[flat|nested] 16+ messages in thread

end of thread, other threads:[~2026-04-07  0:20 UTC | newest]

Thread overview: 16+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-03-31 17:20 [PATCH 0/5] drm/xe/uapi: Update xe_drm.h documentation Shuicheng Lin
2026-03-31 17:20 ` [PATCH 1/5] drm/xe/uapi: Fix typos and spelling errors in " Shuicheng Lin
2026-04-06 20:49   ` Wang, X
2026-03-31 17:20 ` [PATCH 2/5] drm/xe/uapi: Fix grammar " Shuicheng Lin
2026-04-06 20:51   ` Wang, X
2026-03-31 17:20 ` [PATCH 3/5] drm/xe/uapi: Fix wrong names and references in xe_drm.h Shuicheng Lin
2026-04-07  0:07   ` Wang, X
2026-03-31 17:20 ` [PATCH 4/5] drm/xe/uapi: Fix code examples in xe_drm.h documentation Shuicheng Lin
2026-04-07  0:11   ` Wang, X
2026-03-31 17:20 ` [PATCH 5/5] drm/xe/uapi: Fix doc formatting and completeness in xe_drm.h Shuicheng Lin
2026-04-07  0:15   ` Wang, X
2026-03-31 18:53 ` ✗ CI.checkpatch: warning for drm/xe/uapi: Update xe_drm.h documentation (rev2) Patchwork
2026-03-31 18:54 ` ✓ CI.KUnit: success " Patchwork
2026-03-31 19:28 ` ✓ Xe.CI.BAT: " Patchwork
2026-04-01  1:40 ` ✗ Xe.CI.FULL: failure " Patchwork
2026-04-07  0:20 ` [PATCH 0/5] drm/xe/uapi: Update xe_drm.h documentation Wang, X

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