[PATCH v1 02/14] drm/xe/uapi: Add missing documentation for struct members

[Rodrigo Vivi]

On Thu, Dec 07, 2023 at 01:49:57PM +0000, Francois Dugast wrote:
> This removes the documentation build warnings below:
> 
> 	include/uapi/drm/xe_drm.h:828: warning: Function parameter or \
> 	member 'pad2' not described in 'drm_xe_vm_bind_op'
> 	include/uapi/drm/xe_drm.h:875: warning: Function parameter or \
> 	member 'pad2' not described in 'drm_xe_vm_bind'
> 	include/uapi/drm/xe_drm.h:1006: warning: Function parameter or \
> 	member 'handle' not described in 'drm_xe_sync'
> 	include/uapi/drm/xe_drm.h:1006: warning: Function parameter or \
> 	member 'timeline_value' not described in 'drm_xe_sync'
> 
> Signed-off-by: Francois Dugast <francois.dugast at intel.com>

Reviewed-by: Rodrigo Vivi <rodrigo.vivi at intel.com>

> ---
>  include/uapi/drm/xe_drm.h | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
> index be58cd641324..d6cd76385e2c 100644
> --- a/include/uapi/drm/xe_drm.h
> +++ b/include/uapi/drm/xe_drm.h
> @@ -820,7 +820,7 @@ struct drm_xe_vm_bind_op {
>  	 */
>  	__u32 prefetch_mem_region_instance;
>  
> -	/** @pad: MBZ */
> +	/** @pad2: MBZ */
>  	__u32 pad2;
>  
>  	/** @reserved: Reserved */
> @@ -861,7 +861,7 @@ struct drm_xe_vm_bind {
>  		__u64 vector_of_binds;
>  	};
>  
> -	/** @pad: MBZ */
> +	/** @pad2: MBZ */
>  	__u32 pad2;
>  
>  	/** @num_syncs: amount of syncs to wait on */
> @@ -986,6 +986,7 @@ struct drm_xe_sync {
>  	__u32 flags;
>  
>  	union {
> +		/** @handle: Handle for the object */
>  		__u32 handle;
>  
>  		/**
> @@ -999,6 +1000,7 @@ struct drm_xe_sync {
>  		__u64 addr;
>  	};
>  
> +	/** @timeline_value: Timeline point of the sync object */
>  	__u64 timeline_value;
>  
>  	/** @reserved: Reserved */
> -- 
> 2.34.1
>