Skip to contentSkip to conversation

capability: Add parameter description in kernel-doc comment

PATCH New Yang Li 1 participant 1 message Mar 16, 2022

Subsystems (2)
lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 capability: Add parameter description in kernel-doc comment

Add the description of @mnt_userns in privileged_wrt_inode_uidgid() and capable_wrt_inode_uidgid() kernel-doc comment to remove warnings found by running scripts/kernel-doc, which is caused by using 'make W=1'.

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

---
 kernel/capability.c | 2 ++
 1 file changed, 2 insertions(+)
kernel/capability.c +2 -0
index 765194f5d678..ab401d17574d 100644
@@ -481,6 +481,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: The user namespace of the capability to use
  * @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
+ * @mnt_userns: The user namespace of the capability to use
  * @inode: The inode in question
  * @cap: The capability in question
  *
Signature · 1 line
2.20.1.7.g153144c