2021-06-05 06:27:25

by Baokun Li

[permalink] [raw]
Subject: [PATCH -next] capability: fix doc warnings in capability.c

Fixes the following W=1 kernel build warning(s):

kernel/capability.c:490: warning: Function parameter or
member 'mnt_userns' not described in 'privileged_wrt_inode_uidgid'
kernel/capability.c:506: warning: Function parameter or
member 'mnt_userns' not described in 'capable_wrt_inode_uidgid'

Signed-off-by: Baokun Li <[email protected]>
---
kernel/capability.c | 2 ++
1 file changed, 2 insertions(+)

diff --git a/kernel/capability.c b/kernel/capability.c
index 46a361dde042..27a959aa897f 100644
--- a/kernel/capability.c
+++ b/kernel/capability.c
@@ -480,6 +480,7 @@ EXPORT_SYMBOL(file_ns_capable);
/**
* privileged_wrt_inode_uidgid - Do capabilities in the namespace work over the inode?
* @ns: The user namespace in question
+ * @mnt_userns: User namespace of the mount the inode was found from
* @inode: The inode in question
*
* Return true if the inode uid and gid are within the namespace.
@@ -495,6 +496,7 @@ bool privileged_wrt_inode_uidgid(struct user_namespace *ns,
/**
* capable_wrt_inode_uidgid - Check nsown_capable and uid and gid mapped
* @inode: The inode in question
+ * @mnt_userns: User namespace of the mount the inode was found from
* @cap: The capability in question
*
* Return true if the current task has the given capability targeted at
--
2.31.1


2021-06-07 23:11:19

by Serge E. Hallyn

[permalink] [raw]
Subject: Re: [PATCH -next] capability: fix doc warnings in capability.c

On Sat, Jun 05, 2021 at 02:26:02PM +0800, Baokun Li wrote:
> Fixes the following W=1 kernel build warning(s):
>
> kernel/capability.c:490: warning: Function parameter or
> member 'mnt_userns' not described in 'privileged_wrt_inode_uidgid'
> kernel/capability.c:506: warning: Function parameter or
> member 'mnt_userns' not described in 'capable_wrt_inode_uidgid'
>
> Signed-off-by: Baokun Li <[email protected]>
> ---
> kernel/capability.c | 2 ++
> 1 file changed, 2 insertions(+)
>
> diff --git a/kernel/capability.c b/kernel/capability.c
> index 46a361dde042..27a959aa897f 100644
> --- a/kernel/capability.c
> +++ b/kernel/capability.c
> @@ -480,6 +480,7 @@ EXPORT_SYMBOL(file_ns_capable);
> /**
> * privileged_wrt_inode_uidgid - Do capabilities in the namespace work over the inode?
> * @ns: The user namespace in question
> + * @mnt_userns: User namespace of the mount the inode was found from
> * @inode: The inode in question
> *
> * Return true if the inode uid and gid are within the namespace.
> @@ -495,6 +496,7 @@ bool privileged_wrt_inode_uidgid(struct user_namespace *ns,
> /**
> * capable_wrt_inode_uidgid - Check nsown_capable and uid and gid mapped
> * @inode: The inode in question
> + * @mnt_userns: User namespace of the mount the inode was found from

The mnt_userns comes before the inode in this fn.

> * @cap: The capability in question
> *
> * Return true if the current task has the given capability targeted at
> --
> 2.31.1

2021-06-08 01:17:48

by Baokun Li

[permalink] [raw]
Subject: Re: [PATCH -next] capability: fix doc warnings in capability.c

Thank you for your advice.

I didn't notice the order of the parameters.

I'm about to send a patch v2 with the changes suggested by you.

?? 2021/6/8 7:09, Serge E. Hallyn ะด??:
> On Sat, Jun 05, 2021 at 02:26:02PM +0800, Baokun Li wrote:
>> Fixes the following W=1 kernel build warning(s):
>>
>> kernel/capability.c:490: warning: Function parameter or
>> member 'mnt_userns' not described in 'privileged_wrt_inode_uidgid'
>> kernel/capability.c:506: warning: Function parameter or
>> member 'mnt_userns' not described in 'capable_wrt_inode_uidgid'
>>
>> Signed-off-by: Baokun Li <[email protected]>
>> ---
>> kernel/capability.c | 2 ++
>> 1 file changed, 2 insertions(+)
>>
>> diff --git a/kernel/capability.c b/kernel/capability.c
>> index 46a361dde042..27a959aa897f 100644
>> --- a/kernel/capability.c
>> +++ b/kernel/capability.c
>> @@ -480,6 +480,7 @@ EXPORT_SYMBOL(file_ns_capable);
>> /**
>> * privileged_wrt_inode_uidgid - Do capabilities in the namespace work over the inode?
>> * @ns: The user namespace in question
>> + * @mnt_userns: User namespace of the mount the inode was found from
>> * @inode: The inode in question
>> *
>> * Return true if the inode uid and gid are within the namespace.
>> @@ -495,6 +496,7 @@ bool privileged_wrt_inode_uidgid(struct user_namespace *ns,
>> /**
>> * capable_wrt_inode_uidgid - Check nsown_capable and uid and gid mapped
>> * @inode: The inode in question
>> + * @mnt_userns: User namespace of the mount the inode was found from
> The mnt_userns comes before the inode in this fn.
>
>> * @cap: The capability in question
>> *
>> * Return true if the current task has the given capability targeted at
>> --
>> 2.31.1
> .