Skip to contentSkip to conversation

selinux: Fix kernel-doc

PATCH Superseded Yang Li 2 participants 2 messages Jun 10, 2021 – Jun 11, 2021 SELinux security module

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 selinux: Fix kernel-doc

Fix function name in ss/services.c kernel-doc comment to remove a warning found by running make W=1 LLVM=1.

security/selinux/ss/services.c:2437: warning: expecting prototype for security_pkey_sid(). Prototype was for security_ib_pkey_sid() instead.

---
 security/selinux/ss/services.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
security/selinux/ss/services.c +1 -1
index 3658488..bb043bf 100644
@@ -2423,7 +2423,7 @@ int security_port_sid(struct selinux_state *state,
 }
 
 /**
- * security_pkey_sid - Obtain the SID for a pkey.
+ * security_ib_pkey_sid - Obtain the SID for a pkey.
  * @subnet_prefix: Subnet Prefix
  * @pkey_num: pkey number
  * @out_sid: security identifier
Signature · 1 line
1.8.3.1
maintainer
#1 lore raw
Quoted 18 lines · Yang Li

Fix function name in ss/services.c kernel-doc comment to remove a warning found by running make W=1 LLVM=1.

security/selinux/ss/services.c:2437: warning: expecting prototype for security_pkey_sid(). Prototype was for security_ib_pkey_sid() instead.

---
 security/selinux/ss/services.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
security/selinux/ss/services.c +0 -0
index 3658488..bb043bf 100644

security/selinux/ss/services.c int security_port_sid(struct selinux_state *state, · line 2429

Quoted 8 lines
security/selinux/ss/services.c +1 -1
@@ -2423,7 +2423,7 @@ int security_port_sid(struct selinux_state *state,
 }
 
 /**
- * security_pkey_sid - Obtain the SID for a pkey.
+ * security_ib_pkey_sid - Obtain the SID for a pkey.
  * @subnet_prefix: Subnet Prefix
  * @pkey_num: pkey number
  * @out_sid: security identifier

This kdoc function header block is also missing the selinux_state description. Would you mind adding something like the following and resubmitting your patch?

* @state: SELinux state

... I suspect there are a number of function header comments with similar problems in the SELinux code.

Signature · 2 lines
paul moore
www.paul-moore.com