mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Tobin C. Harding" <me@tobin.cc>
To: Alexander Viro <viro@zeniv.linux.org.uk>
Cc: "Tobin C. Harding" <me@tobin.cc>,
	linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH] fs: add kernel-doc entry for function argument
Date: Tue, 19 Dec 2017 17:28:51 +1100	[thread overview]
Message-ID: <1513664931-31714-1-git-send-email-me@tobin.cc> (raw)

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@tobin.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

                 reply	other threads:[~2017-12-19  6:29 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1513664931-31714-1-git-send-email-me@tobin.cc \
    --to=me@tobin.cc \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=viro@zeniv.linux.org.uk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®