drm/xe/uapi: silence kernel-doc errors
authorMatthew Auld <matthew.auld@intel.com>
Mon, 26 Jun 2023 08:25:07 +0000 (09:25 +0100)
committerRodrigo Vivi <rodrigo.vivi@intel.com>
Thu, 21 Dec 2023 16:35:00 +0000 (11:35 -0500)
./include/uapi/drm/xe_drm.h:263: warning: Function parameter or member
'gts' not described in 'drm_xe_query_gts'

./include/uapi/drm/xe_drm.h:854: WARNING: Inline emphasis start-string
without end-string.

With the idea to also include the uapi file in the pre-merge CI hooks
when building the kernel-doc, so first make sure it's clean:

https://gitlab.freedesktop.org/drm/xe/ci/-/merge_requests/16

v2: (Francois)
  - It makes more sense to just fix the kernel-doc for 'gts'

Signed-off-by: Matthew Auld <matthew.auld@intel.com>
Cc: Francois Dugast <francois.dugast@intel.com>
Cc: Lucas De Marchi <lucas.demarchi@intel.com>
Reviewed-by: Francois Dugast <francois.dugast@intel.com>
Signed-off-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
include/uapi/drm/xe_drm.h

index 0808b21..8e7be15 100644 (file)
@@ -242,11 +242,13 @@ struct drm_xe_query_gts {
        /** @pad: MBZ */
        __u32 pad;
 
-       /*
+       /**
+        * @gts: The GTs returned for this device
+        *
+        * TODO: convert drm_xe_query_gt to proper kernel-doc.
         * TODO: Perhaps info about every mem region relative to this GT? e.g.
         * bandwidth between this GT and remote region?
         */
-
        struct drm_xe_query_gt {
 #define XE_QUERY_GT_TYPE_MAIN          0
 #define XE_QUERY_GT_TYPE_REMOTE                1
@@ -852,8 +854,9 @@ struct drm_xe_mmio {
  * struct drm_xe_wait_user_fence - wait user fence
  *
  * Wait on user fence, XE will wakeup on every HW engine interrupt in the
- * instances list and check if user fence is complete:
- * (*addr & MASK) OP (VALUE & MASK)
+ * instances list and check if user fence is complete::
+ *
+ *     (*addr & MASK) OP (VALUE & MASK)
  *
  * Returns to user on user fence completion or timeout.
  */