dma-buf/sync_file: Fix doc build warning

Message ID 20230330142720.882045-1-robdclark@gmail.com
State New
Headers
Series dma-buf/sync_file: Fix doc build warning |

Commit Message

Rob Clark March 30, 2023, 2:27 p.m. UTC
  From: Rob Clark <robdclark@chromium.org>

Fixes warning:

  include/uapi/linux/sync_file.h:77: warning: Function parameter or member 'num_fences' not described in 'sync_file_info'

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Fixes: 2d75c88fefb2 ("staging/android: refactor SYNC IOCTLs")
Signed-off-by: Rob Clark <robdclark@chromium.org>
---
 include/uapi/linux/sync_file.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Randy Dunlap April 12, 2023, 11:07 p.m. UTC | #1
On 3/30/23 07:27, Rob Clark wrote:
> From: Rob Clark <robdclark@chromium.org>
> 
> Fixes warning:
> 
>   include/uapi/linux/sync_file.h:77: warning: Function parameter or member 'num_fences' not described in 'sync_file_info'
> 
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Fixes: 2d75c88fefb2 ("staging/android: refactor SYNC IOCTLs")
> Signed-off-by: Rob Clark <robdclark@chromium.org>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  include/uapi/linux/sync_file.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/uapi/linux/sync_file.h b/include/uapi/linux/sync_file.h
> index d61752dca4c6..ff1f38889dcf 100644
> --- a/include/uapi/linux/sync_file.h
> +++ b/include/uapi/linux/sync_file.h
> @@ -56,7 +56,7 @@ struct sync_fence_info {
>   * @name:	name of fence
>   * @status:	status of fence. 1: signaled 0:active <0:error
>   * @flags:	sync_file_info flags
> - * @num_fences	number of fences in the sync_file
> + * @num_fences:	number of fences in the sync_file
>   * @pad:	padding for 64-bit alignment, should always be zero
>   * @sync_fence_info: pointer to array of struct &sync_fence_info with all
>   *		 fences in the sync_file
  

Patch

diff --git a/include/uapi/linux/sync_file.h b/include/uapi/linux/sync_file.h
index d61752dca4c6..ff1f38889dcf 100644
--- a/include/uapi/linux/sync_file.h
+++ b/include/uapi/linux/sync_file.h
@@ -56,7 +56,7 @@  struct sync_fence_info {
  * @name:	name of fence
  * @status:	status of fence. 1: signaled 0:active <0:error
  * @flags:	sync_file_info flags
- * @num_fences	number of fences in the sync_file
+ * @num_fences:	number of fences in the sync_file
  * @pad:	padding for 64-bit alignment, should always be zero
  * @sync_fence_info: pointer to array of struct &sync_fence_info with all
  *		 fences in the sync_file