2022-05-03 01:31:21

by Christian Göttsche

[permalink] [raw]
Subject: [PATCH] selinux: update parameter documentation

security/selinux/include/audit.h:54: warning: Function parameter or member 'krule' not described in 'selinux_audit_rule_known'
security/selinux/include/audit.h:54: warning: Excess function parameter 'rule' description in 'selinux_audit_rule_known'
security/selinux/include/avc.h:130: warning: Function parameter or member 'state' not described in 'avc_audit'

This also bring the parameter name of selinux_audit_rule_known() in sync
between declaration and definition.

Signed-off-by: Christian Göttsche <[email protected]>
---
security/selinux/include/audit.h | 2 +-
security/selinux/include/avc.h | 1 +
2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/security/selinux/include/audit.h b/security/selinux/include/audit.h
index 073a3d34a0d2..549a382fe6e7 100644
--- a/security/selinux/include/audit.h
+++ b/security/selinux/include/audit.h
@@ -51,7 +51,7 @@ int selinux_audit_rule_match(u32 sid, u32 field, u32 op, void *rule);
* @rule: rule to be checked
* Returns 1 if there are selinux fields specified in the rule, 0 otherwise.
*/
-int selinux_audit_rule_known(struct audit_krule *krule);
+int selinux_audit_rule_known(struct audit_krule *rule);

#endif /* _SELINUX_AUDIT_H */

diff --git a/security/selinux/include/avc.h b/security/selinux/include/avc.h
index 00f78be48283..2b372f98f2d7 100644
--- a/security/selinux/include/avc.h
+++ b/security/selinux/include/avc.h
@@ -104,6 +104,7 @@ int slow_avc_audit(struct selinux_state *state,

/**
* avc_audit - Audit the granting or denial of permissions.
+ * @state: SELinux state
* @ssid: source security identifier
* @tsid: target security identifier
* @tclass: target security class
--
2.36.0


2022-05-03 23:42:18

by Paul Moore

[permalink] [raw]
Subject: Re: [PATCH] selinux: update parameter documentation

On Mon, May 2, 2022 at 10:02 AM Christian Göttsche
<[email protected]> wrote:
>
> security/selinux/include/audit.h:54: warning: Function parameter or member 'krule' not described in 'selinux_audit_rule_known'
> security/selinux/include/audit.h:54: warning: Excess function parameter 'rule' description in 'selinux_audit_rule_known'
> security/selinux/include/avc.h:130: warning: Function parameter or member 'state' not described in 'avc_audit'
>
> This also bring the parameter name of selinux_audit_rule_known() in sync
> between declaration and definition.
>
> Signed-off-by: Christian Göttsche <[email protected]>
> ---
> security/selinux/include/audit.h | 2 +-
> security/selinux/include/avc.h | 1 +
> 2 files changed, 2 insertions(+), 1 deletion(-)

Merged into selinux/next, thanks!

--
paul-moore.com