diff mbox

dma-buf/sw_sync: Fix kerneldoc warnings

Message ID 20180208113816.8288-1-chris@chris-wilson.co.uk (mailing list archive)
State New, archived
Headers show

Commit Message

Chris Wilson Feb. 8, 2018, 11:38 a.m. UTC
drivers/dma-buf/sw_sync.c:248: warning: No description found for parameter 'obj'
drivers/dma-buf/sw_sync.c:248: warning: No description found for parameter 'value'
drivers/dma-buf/sw_sync.c:248: warning: Excess function parameter 'parent' description in 'sync_pt_create'
drivers/dma-buf/sw_sync.c:248: warning: Excess function parameter 'inc' description in 'sync_pt_create'

Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>
---
 drivers/dma-buf/sw_sync.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Daniel Vetter Feb. 19, 2018, 9:51 a.m. UTC | #1
On Thu, Feb 08, 2018 at 11:38:16AM +0000, Chris Wilson wrote:
> drivers/dma-buf/sw_sync.c:248: warning: No description found for parameter 'obj'
> drivers/dma-buf/sw_sync.c:248: warning: No description found for parameter 'value'
> drivers/dma-buf/sw_sync.c:248: warning: Excess function parameter 'parent' description in 'sync_pt_create'
> drivers/dma-buf/sw_sync.c:248: warning: Excess function parameter 'inc' description in 'sync_pt_create'
> 
> Signed-off-by: Chris Wilson <chris@chris-wilson.co.uk>

Applied, thanks.
-Daniel

> ---
>  drivers/dma-buf/sw_sync.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/dma-buf/sw_sync.c b/drivers/dma-buf/sw_sync.c
> index 7779bdbd18d1..3d78ca89a605 100644
> --- a/drivers/dma-buf/sw_sync.c
> +++ b/drivers/dma-buf/sw_sync.c
> @@ -235,10 +235,10 @@ static void sync_timeline_signal(struct sync_timeline *obj, unsigned int inc)
>  
>  /**
>   * sync_pt_create() - creates a sync pt
> - * @parent:	fence's parent sync_timeline
> - * @inc:	value of the fence
> + * @obj:	parent sync_timeline
> + * @value:	value of the fence
>   *
> - * Creates a new sync_pt as a child of @parent.  @size bytes will be
> + * Creates a new sync_pt (fence) as a child of @parent.  @size bytes will be
>   * allocated allowing for implementation specific data to be kept after
>   * the generic sync_timeline struct. Returns the sync_pt object or
>   * NULL in case of error.
> -- 
> 2.16.1
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel
diff mbox

Patch

diff --git a/drivers/dma-buf/sw_sync.c b/drivers/dma-buf/sw_sync.c
index 7779bdbd18d1..3d78ca89a605 100644
--- a/drivers/dma-buf/sw_sync.c
+++ b/drivers/dma-buf/sw_sync.c
@@ -235,10 +235,10 @@  static void sync_timeline_signal(struct sync_timeline *obj, unsigned int inc)
 
 /**
  * sync_pt_create() - creates a sync pt
- * @parent:	fence's parent sync_timeline
- * @inc:	value of the fence
+ * @obj:	parent sync_timeline
+ * @value:	value of the fence
  *
- * Creates a new sync_pt as a child of @parent.  @size bytes will be
+ * Creates a new sync_pt (fence) as a child of @parent.  @size bytes will be
  * allocated allowing for implementation specific data to be kept after
  * the generic sync_timeline struct. Returns the sync_pt object or
  * NULL in case of error.