[PATCH] fs: add kernel-doc entry for function argument

From: Tobin C. Harding
Date: Tue Dec 19 2017 - 01:29:08 EST


Building kernel docs causes SPHINX to emit

warning: No description found for parameter 'rcu'

Add kernel-doc description for parameter 'rcu'

Signed-off-by: Tobin C. Harding <me@xxxxxxxx>
---

Description taken from comments in update_ovl_inode_times()

/*
* Nothing to do if in rcu or if non-overlayfs
*/

fs/inode.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/fs/inode.c b/fs/inode.c
index 03102d6ef044..0530b5b5e76f 100644
--- a/fs/inode.c
+++ b/fs/inode.c
@@ -1669,6 +1669,7 @@ static int update_time(struct inode *inode, struct timespec *time, int flags)
* touch_atime - update the access time
* @path: the &struct path to update
* @inode: inode to update
+ * @rcu: true if in rcu
*
* Update the accessed time on an inode and mark it for writeback.
* This function automatically handles read only file systems and media,
--
2.7.4