[PATCH] dma-buf: Correct the documentation of name and exp_name symbols

[Christian König]

Am 22.11.23 um 17:05 schrieb Ramesh Errabolu:
> Fix the documentation of struct dma_buf members name and exp_name
> as to how these members are to be used and accessed.
>
> Signed-off-by: Ramesh Errabolu <Ramesh.Errabolu at amd.com>

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

> ---
>   include/linux/dma-buf.h | 11 +++++++----
>   1 file changed, 7 insertions(+), 4 deletions(-)
>
> diff --git a/include/linux/dma-buf.h b/include/linux/dma-buf.h
> index 3f31baa3293f..8ff4add71f88 100644
> --- a/include/linux/dma-buf.h
> +++ b/include/linux/dma-buf.h
> @@ -343,16 +343,19 @@ struct dma_buf {
>   	/**
>   	 * @exp_name:
>   	 *
> -	 * Name of the exporter; useful for debugging. See the
> -	 * DMA_BUF_SET_NAME IOCTL.
> +	 * Name of the exporter; useful for debugging. Must not be NULL
>   	 */
>   	const char *exp_name;
>   
>   	/**
>   	 * @name:
>   	 *
> -	 * Userspace-provided name; useful for accounting and debugging,
> -	 * protected by dma_resv_lock() on @resv and @name_lock for read access.
> +	 * Userspace-provided name. Default value is NULL. If not NULL,
> +	 * length cannot be longer than DMA_BUF_NAME_LEN, including NIL
> +	 * char. Useful for accounting and debugging. Read/Write accesses
> +	 * are protected by @name_lock
> +	 *
> +	 * See the IOCTLs DMA_BUF_SET_NAME or DMA_BUF_SET_NAME_A/B
>   	 */
>   	const char *name;
>