Re: [PATCH v2] dma-buf: fix some kernel-doc warnings
From: Christian König
Date: Mon Aug 31 2026 - 05:37:45 EST
On 8/31/26 05:19, Randy Dunlap wrote:
> - drop Excess description of @lock from kernel-doc
> - add missing function/macro short descriptions
>
> WARNING: include/linux/dma-fence-array.h:47 Excess struct member 'lock' description in 'dma_fence_array'
> WARNING: include/linux/dma-fence-chain.h:48 Excess struct member 'lock' description in 'dma_fence_chain'
> Warning: include/linux/dma-fence-chain.h:82 missing initial short description on line:
> * dma_fence_chain_alloc
> Warning: include/linux/dma-fence-chain.h:94 missing initial short description on line:
> * dma_fence_chain_free
>
> Fixes: 5943243914b9 ("dma-buf: use inline lock for the dma-fence-array")
> Fixes: a408c0ca0c41 ("dma-buf: use inline lock for the dma-fence-chain")
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Reviewed and pushed to drm-misc-fixes.
Thanks,
Christian.
> ---
> v2: rebase & resend; add Andrew to Cc: list
>
> Cc: Sumit Semwal <sumit.semwal@xxxxxxxxxx>
> Cc: linux-media@xxxxxxxxxxxxxxx
> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
> Cc: Christian König <christian.koenig@xxxxxxx>
> Cc: stable@xxxxxxxxxxxxxxx
> Cc: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
>
> include/linux/dma-fence-array.h | 1 -
> include/linux/dma-fence-chain.h | 9 ++++-----
> 2 files changed, 4 insertions(+), 6 deletions(-)
>
> --- linux-next-20260828.orig/include/linux/dma-fence-array.h
> +++ linux-next-20260828/include/linux/dma-fence-array.h
> @@ -28,7 +28,6 @@ struct dma_fence_array_cb {
> /**
> * struct dma_fence_array - fence to represent an array of fences
> * @base: fence base class
> - * @lock: spinlock for fence handling
> * @num_fences: number of fences in the array
> * @num_pending: fences in the array still pending
> * @fences: array of the fences
> --- linux-next-20260828.orig/include/linux/dma-fence-chain.h
> +++ linux-next-20260828/include/linux/dma-fence-chain.h
> @@ -20,7 +20,6 @@
> * @prev: previous fence of the chain
> * @prev_seqno: original previous seqno before garbage collection
> * @fence: encapsulated fence
> - * @lock: spinlock for fence handling
> */
> struct dma_fence_chain {
> struct dma_fence base;
> @@ -81,9 +80,8 @@ dma_fence_chain_contained(struct dma_fen
> }
>
> /**
> - * dma_fence_chain_alloc
> - *
> - * Returns a new struct dma_fence_chain object or NULL on failure.
> + * dma_fence_chain_alloc - Returns a new &struct dma_fence_chain object or
> + * %NULL on failure.
> *
> * This specialized allocator has to be a macro for its allocations to be
> * accounted separately (to have a separate alloc_tag). The typecast is
> @@ -93,7 +91,8 @@ dma_fence_chain_contained(struct dma_fen
> kmalloc_obj(struct dma_fence_chain)
>
> /**
> - * dma_fence_chain_free
> + * dma_fence_chain_free - Frees an allocated but not used
> + * &struct dma_fence_chain object.
> * @chain: chain node to free
> *
> * Frees up an allocated but not used struct dma_fence_chain object. This