[Intel-xe] [PATCH v2 1/2] drm/xe/uapi: silence kernel-doc errors

[Francois Dugast]

On Mon, Jun 26, 2023 at 09:25:07AM +0100, Matthew Auld wrote:
> ./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 at intel.com>
> Cc: Francois Dugast <francois.dugast at intel.com>
> Cc: Lucas De Marchi <lucas.demarchi at intel.com>

Reviewed-by: Francois Dugast <francois.dugast at intel.com>

> ---
>  include/uapi/drm/xe_drm.h | 11 +++++++----
>  1 file changed, 7 insertions(+), 4 deletions(-)
> 
> diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
> index 432bd87ca401..965cd9527ff1 100644
> --- a/include/uapi/drm/xe_drm.h
> +++ b/include/uapi/drm/xe_drm.h
> @@ -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.
>   */
> -- 
> 2.41.0
>