diff mbox series

dma-buf: fix kernel-doc warning in dma-fence.c

Message ID 20200831041713.12571-1-rdunlap@infradead.org
State Accepted
Commit e44cd6bc95a145418442f91045828c8fc49112bd
Headers show
Series dma-buf: fix kernel-doc warning in dma-fence.c | expand

Commit Message

Randy Dunlap Aug. 31, 2020, 4:17 a.m. UTC
Add @cookie to dma_fence_end_signalling() to prevent kernel-doc
warning in drivers/dma-buf/dma-fence.c:

../drivers/dma-buf/dma-fence.c:291: warning: Function parameter or member 'cookie' not described in 'dma_fence_end_signalling'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Sumit Semwal <sumit.semwal@linaro.org>
Cc: Gustavo Padovan <gustavo@padovan.org>
Cc: Christian König <christian.koenig@amd.com>
Cc: linux-media@vger.kernel.org
Cc: dri-devel@lists.freedesktop.org
---
 drivers/dma-buf/dma-fence.c |    1 +
 1 file changed, 1 insertion(+)

Comments

Christian König Aug. 31, 2020, 10:02 a.m. UTC | #1
Am 31.08.20 um 06:17 schrieb Randy Dunlap:
> Add @cookie to dma_fence_end_signalling() to prevent kernel-doc
> warning in drivers/dma-buf/dma-fence.c:
>
> ../drivers/dma-buf/dma-fence.c:291: warning: Function parameter or member 'cookie' not described in 'dma_fence_end_signalling'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Sumit Semwal <sumit.semwal@linaro.org>
> Cc: Gustavo Padovan <gustavo@padovan.org>
> Cc: Christian König <christian.koenig@amd.com>
> Cc: linux-media@vger.kernel.org
> Cc: dri-devel@lists.freedesktop.org

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

> ---
>   drivers/dma-buf/dma-fence.c |    1 +
>   1 file changed, 1 insertion(+)
>
> --- lnx-59-rc3.orig/drivers/dma-buf/dma-fence.c
> +++ lnx-59-rc3/drivers/dma-buf/dma-fence.c
> @@ -283,6 +283,7 @@ EXPORT_SYMBOL(dma_fence_begin_signalling
>   
>   /**
>    * dma_fence_end_signalling - end a critical DMA fence signalling section
> + * @cookie: opaque cookie from dma_fence_begin_signalling()
>    *
>    * Closes a critical section annotation opened by dma_fence_begin_signalling().
>    */
Christian König Sept. 1, 2020, 1:37 p.m. UTC | #2
Am 01.09.20 um 15:32 schrieb Daniel Vetter:
> On Mon, Aug 31, 2020 at 12:02:03PM +0200, Christian König wrote:
>> Am 31.08.20 um 06:17 schrieb Randy Dunlap:
>>> Add @cookie to dma_fence_end_signalling() to prevent kernel-doc
>>> warning in drivers/dma-buf/dma-fence.c:
>>>
>>> ../drivers/dma-buf/dma-fence.c:291: warning: Function parameter or member 'cookie' not described in 'dma_fence_end_signalling'
>>>
>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>> Cc: Sumit Semwal <sumit.semwal@linaro.org>
>>> Cc: Gustavo Padovan <gustavo@padovan.org>
>>> Cc: Christian König <christian.koenig@amd.com>
>>> Cc: linux-media@vger.kernel.org
>>> Cc: dri-devel@lists.freedesktop.org
>> Acked-by: Christian König <christian.koenig@amd.com>
> Will you merge these two to drm-misc-fixes or should someone else?

I was wondering the same thing and just waiting for Randy to reply with 
please pick them up or I'm going to push them because I have commit access.

Regards,
Christian.

>
> Always a bit confusing when maintainers reply with acks/r-b but not what
> they'll do with the patch :-)
>
> Cheers, Daniel
>
>>> ---
>>>    drivers/dma-buf/dma-fence.c |    1 +
>>>    1 file changed, 1 insertion(+)
>>>
>>> --- lnx-59-rc3.orig/drivers/dma-buf/dma-fence.c
>>> +++ lnx-59-rc3/drivers/dma-buf/dma-fence.c
>>> @@ -283,6 +283,7 @@ EXPORT_SYMBOL(dma_fence_begin_signalling
>>>    /**
>>>     * dma_fence_end_signalling - end a critical DMA fence signalling section
>>> + * @cookie: opaque cookie from dma_fence_begin_signalling()
>>>     *
>>>     * Closes a critical section annotation opened by dma_fence_begin_signalling().
>>>     */
>> _______________________________________________
>> dri-devel mailing list
>> dri-devel@lists.freedesktop.org
>> https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Flists.freedesktop.org%2Fmailman%2Flistinfo%2Fdri-devel&amp;data=02%7C01%7Cchristian.koenig%40amd.com%7C4d8d43fbbb06475f964308d84e7b6a05%7C3dd8961fe4884e608e11a82d994e183d%7C0%7C0%7C637345639254630346&amp;sdata=hxraBxca4oxH%2BsvRJaDT44kFp%2BAXlun2GaLYY6L6LdA%3D&amp;reserved=0
diff mbox series

Patch

--- lnx-59-rc3.orig/drivers/dma-buf/dma-fence.c
+++ lnx-59-rc3/drivers/dma-buf/dma-fence.c
@@ -283,6 +283,7 @@  EXPORT_SYMBOL(dma_fence_begin_signalling
 
 /**
  * dma_fence_end_signalling - end a critical DMA fence signalling section
+ * @cookie: opaque cookie from dma_fence_begin_signalling()
  *
  * Closes a critical section annotation opened by dma_fence_begin_signalling().
  */