From patchwork Tue Jul 19 12:37:58 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luis de Bethencourt X-Patchwork-Id: 9236929 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 18B24602F0 for ; Tue, 19 Jul 2016 12:39:15 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 0A53B1FF21 for ; Tue, 19 Jul 2016 12:39:15 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id F2FB7205AD; Tue, 19 Jul 2016 12:39:14 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id A46D226929 for ; Tue, 19 Jul 2016 12:39:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753351AbcGSMi4 (ORCPT ); Tue, 19 Jul 2016 08:38:56 -0400 Received: from lists.s-osg.org ([54.187.51.154]:59775 "EHLO lists.s-osg.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753168AbcGSMiy (ORCPT ); Tue, 19 Jul 2016 08:38:54 -0400 Received: from localhost.localdomain (unknown [212.250.200.210]) by lists.s-osg.org (Postfix) with ESMTPSA id 2DC68E268F; Tue, 19 Jul 2016 05:40:23 -0700 (PDT) From: Luis de Bethencourt To: linux-kernel@vger.kernel.org, mszeredi@redhat.com Cc: viro@zeniv.linux.org.uk, linux-fsdevel@vger.kernel.org, Luis de Bethencourt Subject: [PATCH] vfs: fix documentation of touch_atime() Date: Tue, 19 Jul 2016 13:37:58 +0100 Message-Id: <1468931878-9016-1-git-send-email-luisbg@osg.samsung.com> X-Mailer: git-send-email 2.6.4 Sender: linux-fsdevel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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 --- 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;