Skip to contentSkip to conversation

dma-buf: Fix kerneldoc comment for struct dma_fence_array

PATCH In review Jonathan Corbet 2 participants 2 messages Jan 16, 2019 – Jan 17, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dma-buf: Fix kerneldoc comment for struct dma_fence_array

The kerneldoc comment for struct dma_fence_array lacks a description of the "work" member, leading to this docs-build warning:

./include/linux/dma-fence-array.h:54: warning: Function parameter or member 'work' not described in 'dma_fence_array'

Add a description and make the warning go away.

---
Hopefully I've sent this to the right place; perhaps this file needs to be added to the MAINTAINERS entry?

 include/linux/dma-fence-array.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/dma-fence-array.h +1 -0
index bc8940ca280d..c0ff417b4770 100644
@@ -40,6 +40,7 @@ struct dma_fence_array_cb {
  * @num_fences: number of fences in the array
  * @num_pending: fences in the array still pending
  * @fences: array of the fences
+ * @work: internal irq_work function
  */
 struct dma_fence_array {
 	struct dma_fence base;
Signature · 1 line
2.20.1
#1 lore raw
Quoted 8 lines · Jonathan Corbet

The kerneldoc comment for struct dma_fence_array lacks a description of the "work" member, leading to this docs-build warning:

./include/linux/dma-fence-array.h:54: warning: Function parameter or member 'work' not described in 'dma_fence_array'

Add a description and make the warning go away.

Applied for 5.1, thanks for your patch.
-Daniel

Quoted 26 lines

---
Hopefully I've sent this to the right place; perhaps this file needs to be added to the MAINTAINERS entry?

 include/linux/dma-fence-array.h | 1 +
 1 file changed, 1 insertion(+)
include/linux/dma-fence-array.h +1 -0
index bc8940ca280d..c0ff417b4770 100644
@@ -40,6 +40,7 @@ struct dma_fence_array_cb {
  * @num_fences: number of fences in the array
  * @num_pending: fences in the array still pending
  * @fences: array of the fences
+ * @work: internal irq_work function
  */
 struct dma_fence_array {
 	struct dma_fence base;
Signature · 6 lines
2.20.1

_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Signature · 7 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel