From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Christian Brauner <christian.brauner@ubuntu.com>,
linux-fsdevel@vger.kernel.org
Cc: Alexander Viro <viro@zeniv.linux.org.uk>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-doc@vger.kernel.org, kernel-janitors@vger.kernel.org,
linux-kernel@vger.kernel.org,
Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: [PATCH 5/5] fs: update kernel-doc for new mnt_userns argument
Date: Thu, 4 Feb 2021 19:00:59 +0100 [thread overview]
Message-ID: <20210204180059.28360-6-lukas.bulwahn@gmail.com> (raw)
In-Reply-To: <20210204180059.28360-1-lukas.bulwahn@gmail.com>
Commit 549c7297717c ("fs: make helpers idmap mount aware") and commit
c7c7a1a18af4 ("xattr: handle idmapped mounts") refactor the inode methods
with mount-user-namespace arguments, but did not adjust the kernel-doc of
some functions.
Hence, make htmldocs warns:
./fs/libfs.c:498: warning: Function parameter or member 'mnt_userns' not described in 'simple_setattr'
./fs/xattr.c:257: warning: Function parameter or member 'mnt_userns' not described in '__vfs_setxattr_locked'
./fs/xattr.c:485: warning: Function parameter or member 'mnt_userns' not described in '__vfs_removexattr_locked'
Copy the existing kernel-doc description for that new argument from
__vfs_setxattr_noperm() to the other functions as well.
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
fs/libfs.c | 1 +
fs/xattr.c | 2 ++
2 files changed, 3 insertions(+)
diff --git a/fs/libfs.c b/fs/libfs.c
index e2de5401abca..61c684014392 100644
--- a/fs/libfs.c
+++ b/fs/libfs.c
@@ -481,6 +481,7 @@ EXPORT_SYMBOL(simple_rename);
/**
* simple_setattr - setattr for simple filesystem
+ * @mnt_userns: user namespace of the mount the inode was found from
* @dentry: dentry
* @iattr: iattr structure
*
diff --git a/fs/xattr.c b/fs/xattr.c
index b3444e06cded..57f47f0caf22 100644
--- a/fs/xattr.c
+++ b/fs/xattr.c
@@ -242,6 +242,7 @@ int __vfs_setxattr_noperm(struct user_namespace *mnt_userns,
* __vfs_setxattr_locked - set an extended attribute while holding the inode
* lock
*
+ * @mnt_userns: user namespace of the mount the inode was found from
* @dentry: object to perform setxattr on
* @name: xattr name to set
* @value: value to set @name to
@@ -473,6 +474,7 @@ EXPORT_SYMBOL(__vfs_removexattr);
* __vfs_removexattr_locked - set an extended attribute while holding the inode
* lock
*
+ * @mnt_userns: user namespace of the mount the inode was found from
* @dentry: object to perform setxattr on
* @name: name of xattr to remove
* @delegated_inode: on return, will contain an inode pointer that
--
2.17.1
next prev parent reply other threads:[~2021-02-04 18:09 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-04 18:00 [PATCH 0/5] kernel-doc fixes to latest fs changes Lukas Bulwahn
2021-02-04 18:00 ` [PATCH 1/5] fs: turn some comments into kernel-doc Lukas Bulwahn
2021-02-04 18:00 ` [PATCH 2/5] fs: update kernel-doc for vfs_rename() Lukas Bulwahn
2021-02-04 18:00 ` [PATCH 3/5] fs: update kernel-doc for may_create_in_sticky() Lukas Bulwahn
2021-02-04 18:00 ` [PATCH 4/5] fs: update kernel-doc for vfs_tmpfile() Lukas Bulwahn
2021-02-04 18:00 ` Lukas Bulwahn [this message]
2021-03-01 12:51 ` [PATCH 0/5] kernel-doc fixes to latest fs changes Christian Brauner
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=20210204180059.28360-6-lukas.bulwahn@gmail.com \
--to=lukas.bulwahn@gmail.com \
--cc=christian.brauner@ubuntu.com \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@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;
as well as URLs for NNTP newsgroup(s).