[PATCH v2 08/13] staging/android: improve documentation for sync_file

From: Gustavo Padovan
Date: Thu Apr 28 2016 - 09:49:27 EST


From: Gustavo Padovan <gustavo.padovan@xxxxxxxxxxxxxxx>

num_fences was missing a colon mark and sync_file_create() now have
better description.

Signed-off-by: Gustavo Padovan <gustavo.padovan@xxxxxxxxxxxxxxx>
Reviewed-by: Daniel Vetter <daniel.vetter@xxxxxxxx>
---
drivers/staging/android/sync_file.c | 5 +++--
drivers/staging/android/sync_file.h | 2 +-
2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/drivers/staging/android/sync_file.c b/drivers/staging/android/sync_file.c
index 2c724ec..d9da3a4 100644
--- a/drivers/staging/android/sync_file.c
+++ b/drivers/staging/android/sync_file.c
@@ -65,11 +65,12 @@ static void fence_check_cb_func(struct fence *f, struct fence_cb *cb)
}

/**
- * sync_fence_create() - creates a sync fence
+ * sync_file_create() - creates a sync file
* @fence: fence to add to the sync_fence
*
* Creates a sync_file containg @fence. Once this is called, the sync_file
- * takes ownership of @fence.
+ * takes ownership of @fence. The sync_file can be released with
+ * fput(sync_file->file). Returns the sync_file or NULL in case of error.
*/
struct sync_file *sync_file_create(struct fence *fence)
{
diff --git a/drivers/staging/android/sync_file.h b/drivers/staging/android/sync_file.h
index 8a1b546..c6ffe8b 100644
--- a/drivers/staging/android/sync_file.h
+++ b/drivers/staging/android/sync_file.h
@@ -32,7 +32,7 @@ struct sync_file_cb {
* @kref: reference count on fence.
* @name: name of sync_file. Useful for debugging
* @sync_file_list: membership in global file list
- * @num_fences number of sync_pts in the fence
+ * @num_fences: number of sync_pts in the fence
* @wq: wait queue for fence signaling
* @status: 0: signaled, >0:active, <0: error
* @cbs: sync_pts callback information
--
2.5.5