2022-06-28 09:48:44

by Mauro Carvalho Chehab

Subject: [PATCH 06/22] fs: attr: update vfs uid/gid parameters at kernel-doc

The vfs uid/gid parameters have a different name at the function
prototype causing kernel-doc warnings. Update them for the parameters
to match, fixing those warnings:

fs/attr.c:36: warning: Function parameter or member 'ia_vfsuid' not described in 'chown_ok'
fs/attr.c:36: warning: Excess function parameter 'uid' description in 'chown_ok'
fs/attr.c:63: warning: Function parameter or member 'ia_vfsgid' not described in 'chgrp_ok'
fs/attr.c:63: warning: Excess function parameter 'gid' description in 'chgrp_ok'

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/22] at: https://lore.kernel.org/all/[email protected]/

fs/attr.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/fs/attr.c b/fs/attr.c
index 1ba7ddef537f..b5b8835ddf15 100644
--- a/fs/attr.c
+++ b/fs/attr.c
@@ -22,7 +22,7 @@
* chown_ok - verify permissions to chown inode
* @mnt_userns: user namespace of the mount @inode was found from
* @inode: inode to check permissions on
- * @uid: uid to chown @inode to
+ * @ia_vfsuid: uid to chown @inode to
*
* If the inode has been found through an idmapped mount the user namespace of
* the vfsmount must be passed through @mnt_userns. This function will then
@@ -49,7 +49,7 @@ static bool chown_ok(struct user_namespace *mnt_userns,
* chgrp_ok - verify permissions to chgrp inode
* @mnt_userns: user namespace of the mount @inode was found from
* @inode: inode to check permissions on
- * @gid: gid to chown @inode to
+ * @ia_vfsgid: gid to chown @inode to
*
* If the inode has been found through an idmapped mount the user namespace of
* the vfsmount must be passed through @mnt_userns. This function will then
--
2.36.1

2022-06-28 10:32:57

by Christian Brauner

Subject: Re: [PATCH 06/22] fs: attr: update vfs uid/gid parameters at kernel-doc

On Tue, Jun 28, 2022 at 10:46:10AM +0100, Mauro Carvalho Chehab wrote:
> The vfs uid/gid parameters have a different name at the function
> prototype causing kernel-doc warnings. Update them for the parameters
> to match, fixing those warnings:
>
> fs/attr.c:36: warning: Function parameter or member 'ia_vfsuid' not described in 'chown_ok'
> fs/attr.c:36: warning: Excess function parameter 'uid' description in 'chown_ok'
> fs/attr.c:63: warning: Function parameter or member 'ia_vfsgid' not described in 'chgrp_ok'
> fs/attr.c:63: warning: Excess function parameter 'gid' description in 'chgrp_ok'
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---

This is already fixed in my tree and in -next as
81a1807d80dd26cdf8a357cf55f556ade90c7fda

So you can drop this.

Thanks!
Christian