2021-12-10 05:57:19

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] lsm: Fix kernel-doc

Fix function name in lsm.c kernel-doc comment
to remove some warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.

security/apparmor/lsm.c:819: warning: expecting prototype for
apparmor_clone_security(). Prototype was for
apparmor_sk_clone_security() instead
security/apparmor/lsm.c:923: warning: expecting prototype for
apparmor_socket_list(). Prototype was for apparmor_socket_listen()
instead
security/apparmor/lsm.c:1028: warning: expecting prototype for
apparmor_getsockopt(). Prototype was for apparmor_socket_getsockopt()
instead
security/apparmor/lsm.c:1038: warning: expecting prototype for
apparmor_setsockopt(). Prototype was for apparmor_socket_setsockopt()
instead
ecurity/apparmor/lsm.c:1061: warning: expecting prototype for
apparmor_socket_sock_recv_skb(). Prototype was for
apparmor_socket_sock_rcv_skb() instead

Reported-by: Abaci Robot <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
security/apparmor/lsm.c | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/security/apparmor/lsm.c b/security/apparmor/lsm.c
index 4f0eecb67dde..ce7d96627810 100644
--- a/security/apparmor/lsm.c
+++ b/security/apparmor/lsm.c
@@ -812,7 +812,7 @@ static void apparmor_sk_free_security(struct sock *sk)
}

/**
- * apparmor_clone_security - clone the sk_security field
+ * apparmor_sk_clone_security - clone the sk_security field
*/
static void apparmor_sk_clone_security(const struct sock *sk,
struct sock *newsk)
@@ -917,7 +917,7 @@ static int apparmor_socket_connect(struct socket *sock,
}

/**
- * apparmor_socket_list - check perms before allowing listen
+ * apparmor_socket_listen - check perms before allowing listen
*/
static int apparmor_socket_listen(struct socket *sock, int backlog)
{
@@ -1021,7 +1021,7 @@ static int aa_sock_opt_perm(const char *op, u32 request, struct socket *sock,
}

/**
- * apparmor_getsockopt - check perms before getting socket options
+ * apparmor_socket_getsockopt - check perms before getting socket options
*/
static int apparmor_socket_getsockopt(struct socket *sock, int level,
int optname)
@@ -1031,7 +1031,7 @@ static int apparmor_socket_getsockopt(struct socket *sock, int level,
}

/**
- * apparmor_setsockopt - check perms before setting socket options
+ * apparmor_socket_setsockopt - check perms before setting socket options
*/
static int apparmor_socket_setsockopt(struct socket *sock, int level,
int optname)
@@ -1050,7 +1050,7 @@ static int apparmor_socket_shutdown(struct socket *sock, int how)

#ifdef CONFIG_NETWORK_SECMARK
/**
- * apparmor_socket_sock_recv_skb - check perms before associating skb to sk
+ * apparmor_socket_sock_rcv_skb - check perms before associating skb to sk
*
* Note: can not sleep may be called with locks held
*
--
2.20.1.7.g153144c



2021-12-15 21:06:26

by John Johansen

[permalink] [raw]
Subject: Re: [PATCH -next] lsm: Fix kernel-doc

On 12/9/21 9:57 PM, Yang Li wrote:
> Fix function name in lsm.c kernel-doc comment
> to remove some warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
>
> security/apparmor/lsm.c:819: warning: expecting prototype for
> apparmor_clone_security(). Prototype was for
> apparmor_sk_clone_security() instead
> security/apparmor/lsm.c:923: warning: expecting prototype for
> apparmor_socket_list(). Prototype was for apparmor_socket_listen()
> instead
> security/apparmor/lsm.c:1028: warning: expecting prototype for
> apparmor_getsockopt(). Prototype was for apparmor_socket_getsockopt()
> instead
> security/apparmor/lsm.c:1038: warning: expecting prototype for
> apparmor_setsockopt(). Prototype was for apparmor_socket_setsockopt()
> instead
> ecurity/apparmor/lsm.c:1061: warning: expecting prototype for
> apparmor_socket_sock_recv_skb(). Prototype was for
> apparmor_socket_sock_rcv_skb() instead
>
> Reported-by: Abaci Robot <[email protected]>
> Signed-off-by: Yang Li <[email protected]>
Acked-by: John Johansen <[email protected]>

I have pulled this into my tree

> ---
> security/apparmor/lsm.c | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/security/apparmor/lsm.c b/security/apparmor/lsm.c
> index 4f0eecb67dde..ce7d96627810 100644
> --- a/security/apparmor/lsm.c
> +++ b/security/apparmor/lsm.c
> @@ -812,7 +812,7 @@ static void apparmor_sk_free_security(struct sock *sk)
> }
>
> /**
> - * apparmor_clone_security - clone the sk_security field
> + * apparmor_sk_clone_security - clone the sk_security field
> */
> static void apparmor_sk_clone_security(const struct sock *sk,
> struct sock *newsk)
> @@ -917,7 +917,7 @@ static int apparmor_socket_connect(struct socket *sock,
> }
>
> /**
> - * apparmor_socket_list - check perms before allowing listen
> + * apparmor_socket_listen - check perms before allowing listen
> */
> static int apparmor_socket_listen(struct socket *sock, int backlog)
> {
> @@ -1021,7 +1021,7 @@ static int aa_sock_opt_perm(const char *op, u32 request, struct socket *sock,
> }
>
> /**
> - * apparmor_getsockopt - check perms before getting socket options
> + * apparmor_socket_getsockopt - check perms before getting socket options
> */
> static int apparmor_socket_getsockopt(struct socket *sock, int level,
> int optname)
> @@ -1031,7 +1031,7 @@ static int apparmor_socket_getsockopt(struct socket *sock, int level,
> }
>
> /**
> - * apparmor_setsockopt - check perms before setting socket options
> + * apparmor_socket_setsockopt - check perms before setting socket options
> */
> static int apparmor_socket_setsockopt(struct socket *sock, int level,
> int optname)
> @@ -1050,7 +1050,7 @@ static int apparmor_socket_shutdown(struct socket *sock, int how)
>
> #ifdef CONFIG_NETWORK_SECMARK
> /**
> - * apparmor_socket_sock_recv_skb - check perms before associating skb to sk
> + * apparmor_socket_sock_rcv_skb - check perms before associating skb to sk
> *
> * Note: can not sleep may be called with locks held
> *
>