Skip to contentSkip to conversation

fs: add kernel-doc entry for function argument

PATCH New Tobin C. Harding 1 participant 1 message Dec 19, 2017 VFS

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 fs: add kernel-doc entry for function argument

Building kernel docs causes SPHINX to emit

warning: No description found for parameter 'rcu'

Add kernel-doc description for parameter 'rcu'

---

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(+)
fs/inode.c +1 -0
index 03102d6ef044..0530b5b5e76f 100644
@@ -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,
Signature · 1 line
2.7.4