[PATCH] dma-buf: docs: remove invalid struct member

[PATCH] dma-buf: docs: remove invalid struct member

[Nicolás Antinori]

In the structs dma_fence_array and dma_fence_chain, the field 'lock'
has been removed, but its documentation comment remained. Remove the
stale descriptions to clear up the following kernel-doc warnings:

WARNING: ./include/linux/dma-fence-array.h:47 Excess struct member 'lock' description in 'dma_fence_array'
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:48 Excess struct member 'lock' description in 'dma_fence_chain'

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: Nicolás Antinori <nico.antinori.7@gmail.com>
---
 include/linux/dma-fence-array.h | 1 -
 include/linux/dma-fence-chain.h | 1 -
 2 files changed, 2 deletions(-)

diff --git a/include/linux/dma-fence-array.h b/include/linux/dma-fence-array.h
index 1b1d87579c38..0c49d7ccefb6 100644
--- a/include/linux/dma-fence-array.h
+++ b/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
diff --git a/include/linux/dma-fence-chain.h b/include/linux/dma-fence-chain.h
index df3beadf1515..42289f505164 100644
--- a/include/linux/dma-fence-chain.h
+++ b/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;
--
2.47.3

Re: [PATCH] dma-buf: docs: remove invalid struct member

[Christian König]

On 7/2/26 19:12, Nicolás Antinori wrote:
> In the structs dma_fence_array and dma_fence_chain, the field 'lock'
> has been removed, but its documentation comment remained. Remove the
> stale descriptions to clear up the following kernel-doc warnings:
> 
> WARNING: ./include/linux/dma-fence-array.h:47 Excess struct member 'lock' description in 'dma_fence_array'
> 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:48 Excess struct member 'lock' description in 'dma_fence_chain'
> 
> 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: Nicolás Antinori <nico.antinori.7@gmail.com>

Reviewed-by: Christian König <christian.koenig@amd.com>

Going to push that to drm-misc-next later today.

Regards,
Christian.

> ---
>  include/linux/dma-fence-array.h | 1 -
>  include/linux/dma-fence-chain.h | 1 -
>  2 files changed, 2 deletions(-)
> 
> diff --git a/include/linux/dma-fence-array.h b/include/linux/dma-fence-array.h
> index 1b1d87579c38..0c49d7ccefb6 100644
> --- a/include/linux/dma-fence-array.h
> +++ b/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
> diff --git a/include/linux/dma-fence-chain.h b/include/linux/dma-fence-chain.h
> index df3beadf1515..42289f505164 100644
> --- a/include/linux/dma-fence-chain.h
> +++ b/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;
> --
> 2.47.3
>