2021-06-10 09:39:54

by Yang Li

Subject: [PATCH -next] 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.

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
security/selinux/ss/services.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/security/selinux/ss/services.c b/security/selinux/ss/services.c
index 3658488..bb043bf 100644
--- a/security/selinux/ss/services.c
+++ b/security/selinux/ss/services.c
@@ -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
--
1.8.3.1

2021-06-11 01:08:59

by Paul Moore

Subject: Re: [PATCH -next] selinux: Fix kernel-doc

On Thu, Jun 10, 2021 at 5:38 AM Yang Li <[email protected]> wrote:
>
> 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.
>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Yang Li <[email protected]>
> ---
> security/selinux/ss/services.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/security/selinux/ss/services.c b/security/selinux/ss/services.c
> index 3658488..bb043bf 100644
> --- a/security/selinux/ss/services.c
> +++ b/security/selinux/ss/services.c
> @@ -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.

--
paul moore
http://www.paul-moore.com