lkml.org 
[lkml]   [2019]   [Mar]   [27]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH v3 03/24] fs: Update function docstring for dio_complete()
Date
Sphinx throws a warning when parsing fs/direct_io.c, the warning
illuminates the fact that the docstring for function dio_complete() has
become stale.

Update the function docstring for dio_complete() documenting all current
function parameters.

Signed-off-by: Tobin C. Harding <tobin@kernel.org>
---
fs/direct-io.c | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/fs/direct-io.c b/fs/direct-io.c
index dbc1a1f080ce..ce5fd5f8603c 100644
--- a/fs/direct-io.c
+++ b/fs/direct-io.c
@@ -242,7 +242,9 @@ void dio_warn_stale_pagecache(struct file *filp)

/**
* dio_complete() - called when all DIO BIO I/O has been completed
- * @offset: the byte offset in the file of the completed operation
+ * @dio: The dio we are working on.
+ * @ret: Error code passed through from do_blockdev_direct_IO().
+ * @flags: DIO complete flags.
*
* This drops i_dio_count, lets interested parties know that a DIO operation
* has completed, and calculates the resulting return code for the operation.
--
2.21.0
\
 
 \ /
  Last update: 2019-03-27 06:21    [W:0.164 / U:4.452 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site