dma-buf: Correct the documentation of name and exp_name symbols
Subsystems (2)
PATCH 1/1 dma-buf: Correct the documentation of name and exp_name symbols
Fix the documentation of struct dma_buf members name and exp_name as to how these members are to be used and accessed.
--- include/linux/dma-buf.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-)
include/linux/dma-buf.h +7 -4
@@ -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;
Signature · 1 line
2.34.1
Am 22.11.23 um 17:05 schrieb Ramesh Errabolu:
Quoted 4 lines
Fix the documentation of struct
dma_bufmembers name andexp_nameas to how these members are to be used and accessed.Signed-off-by Ramesh Errabolu <[email protected]>
Quoted 32 lines
--- include/linux/dma-buf.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-)include/linux/dma-buf.h +7
-4@@ -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;
Quoted 8 lines · Christian König
Am 22.11.23 um 17:05 schrieb Ramesh Errabolu:
Quoted 4 lines
Fix the documentation of struct
dma_bufmembers name andexp_nameas to how these members are to be used and accessed.Signed-off-by Ramesh Errabolu <[email protected]>Reviewed-by Christian König <[email protected]>
Please apply this to drm-misc.
Alex
Quoted 37 lines
Quoted 23 lines
--- include/linux/dma-buf.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-)include/linux/dma-buf.h +1
-3@@ -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, include/linux/dma-buf.h struct dma_buf { · line 361
Quoted 10 lines
include/linux/dma-buf.h +6
-1-* 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;_______________________________________________
Linaro-mm-sig mailing list -- [email protected] To unsubscribe send an email to [email protected]
Am 29.11.23 um 22:18 schrieb Alex Deucher:
Quoted 9 lines
Quoted 6 lines · Christian König
Am 22.11.23 um 17:05 schrieb Ramesh Errabolu:
Quoted 4 lines
Fix the documentation of struct
dma_bufmembers name andexp_nameas to how these members are to be used and accessed.Signed-off-by Ramesh Errabolu <[email protected]>Reviewed-by Christian König <[email protected]>Please apply this to drm-misc.
Done, thanks for the reminder.
Christian.
Quoted 38 lines
Alex
Quoted 35 lines
Quoted 22 lines
--- include/linux/dma-buf.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-)include/linux/dma-buf.h +1
-3@@ -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, include/linux/dma-buf.h struct dma_buf { · line 361
Quoted 10 lines
include/linux/dma-buf.h +6
-1-* 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;_______________________________________________
Linaro-mm-sig mailing list -- [email protected] To unsubscribe send an email to [email protected]