Re: [PATCH] dma-buf/sync_file: Fix missing colon in kernel-doc for num_fences

From: Randy Dunlap
Date: Wed Jul 26 2023 - 21:44:02 EST


Hi--

On 7/26/23 18:19, David Reaver wrote:
> The struct sync_fence_info member num_fences was missing a colon in the
> kernel-doc, causing this warning when running make htmldocs:
>
> ./include/uapi/linux/sync_file.h:77: warning: Function parameter or member 'num_fences' not described in 'sync_file_info'
>
> num_fences was also clearly missing from
> https://docs.kernel.org/driver-api/dma-buf.html#c.sync_file_info before
> this patch.
>
> Signed-off-by: David Reaver <me@xxxxxxxxxxxxxxx>
> ---
> 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 7e42a5b7558b..b389a5495181 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


Same as https://lore.kernel.org/all/20230330142720.882045-1-robdclark@xxxxxxxxx/

Hopefully someone will merge/apply that one. Rob, can you make that happen?

thanks.
--
~Randy