staging/android: improve documentation for sync_file

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

Signed-off-by: Gustavo Padovan <gustavo.padovan@collabora.co.uk>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/drivers/staging/android/sync_file.c b/drivers/staging/android/sync_file.c
index 2c724ec0004cbe4f8f805c3854904583cc31d4a5..d9da3a4ff30cd4c2273fc345c195b10f2e2c5fdf 100644 (file)
--- 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 8a1b546fd3b3fc91e93af2bdabeab16472b7505e..c6ffe8b0725c63a9931ea60c9ec65383100ed257 100644 (file)
--- 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