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.
Signed-off-by: Jonathan Corbet <[email protected]>
---
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(+)
diff --git a/include/linux/dma-fence-array.h b/include/linux/dma-fence-array.h
index bc8940ca280d..c0ff417b4770 100644
--- a/include/linux/dma-fence-array.h
+++ b/include/linux/dma-fence-array.h
@@ -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;
--
2.20.1
On Wed, Jan 16, 2019 at 03:34:36PM -0700, Jonathan Corbet wrote:
> 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.
>
> Signed-off-by: Jonathan Corbet <[email protected]>
Applied for 5.1, thanks for your patch.
-Daniel
> ---
> 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(+)
>
> diff --git a/include/linux/dma-fence-array.h b/include/linux/dma-fence-array.h
> index bc8940ca280d..c0ff417b4770 100644
> --- a/include/linux/dma-fence-array.h
> +++ b/include/linux/dma-fence-array.h
> @@ -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;
> --
> 2.20.1
>
> _______________________________________________
> dri-devel mailing list
> [email protected]
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch