linux-kernel - [PATCH] vfs: fix documentation of touch

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <1468931878-9016-1-git-send-email-luisbg@osg.samsung.com>
Date:	Tue, 19 Jul 2016 13:37:58 +0100
From:	Luis de Bethencourt <luisbg@....samsung.com>
To:	linux-kernel@...r.kernel.org, mszeredi@...hat.com
Cc:	viro@...iv.linux.org.uk, linux-fsdevel@...r.kernel.org,
	Luis de Bethencourt <luisbg@....samsung.com>
Subject: [PATCH] vfs: fix documentation of touch_atime()

The documentation of touch_atime() doesn't match the location of the
definition and list of parameters anymore. Updating it.

Fixes: e8d2e3f31127 ("vfs: update ovl inode before relatime check")

Signed-off-by: Luis de Bethencourt <luisbg@....samsung.com>
---
Hi,

This patch is based on Miklos' overlayfs-next branch [0]. When building the
docs with the latest changes in that branch you get the following warning:

.//fs/inode.c:1637: warning: No description found for parameter 'rcu'

Problem is that the documentation generator takes the parameter list of
__atime_needs_update for the description of touch_atime() due to the comments
being just above __atime_needs_update().
Moving down the comments to match the location of touch_atime and removing
the explanation of @inode since that parameter isn't there anymore.

Originally the comments were just above atime_needs_update(), should I keep
them above this function instead? Not sure since the comments say touch_atime.

Thanks,
Luis



[0] https://git.kernel.org/cgit/linux/kernel/git/mszeredi/vfs.git/log/?h=overlayfs-next

 fs/inode.c | 17 ++++++++---------
 1 file changed, 8 insertions(+), 9 deletions(-)

diff --git a/fs/inode.c b/fs/inode.c
index 6a2d447..43a8ca4 100644
--- a/fs/inode.c
+++ b/fs/inode.c
@@ -1621,15 +1621,6 @@ static int update_time(struct inode *inode, struct timespec *time, int flags)
 	return update_time(inode, time, flags);
 }
 
-/**
- *	touch_atime	-	update the access time
- *	@path: the &struct path to update
- *	@inode: inode to update
- *
- *	Update the accessed time on an inode and mark it for writeback.
- *	This function automatically handles read only file systems and media,
- *	as well as the "noatime" flag and inode specific "noatime" markers.
- */
 static bool __atime_needs_update(const struct path *path, struct inode *inode,
 				 bool rcu)
 {
@@ -1664,6 +1655,14 @@ bool atime_needs_update(const struct path *path, struct inode *inode)
 	return __atime_needs_update(path, inode, true);
 }
 
+/**
+ *	touch_atime	-	update the access time
+ *	@path: the &struct path to update
+ *
+ *	Update the accessed time on an a path's inode and mark it for writeback.
+ *	This function automatically handles read only file systems and media,
+ *	as well as the "noatime" flag and inode specific "noatime" markers.
+ */
 void touch_atime(const struct path *path)
 {
 	struct vfsmount *mnt = path->mnt;
-- 
2.6.4