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

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: <1513664931-31714-1-git-send-email-me@tobin.cc>
Date:   Tue, 19 Dec 2017 17:28:51 +1100
From:   "Tobin C. Harding" <me@...in.cc>
To:     Alexander Viro <viro@...iv.linux.org.uk>
Cc:     "Tobin C. Harding" <me@...in.cc>, linux-fsdevel@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: [PATCH] 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'

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

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