2024-05-05 22:39:44

by Jeff Johnson

[permalink] [raw]
Subject: [PATCH] apparmor: fix apparmor_socket_post_create() kernel-doc

make C=1 reports:

security/apparmor/lsm.c:1138: warning: Function parameter or struct member 'protocol' not described in 'apparmor_socket_post_create'

Fix this by correcting the misspelling of 'protocol'.

Signed-off-by: Jeff Johnson <[email protected]>
---
security/apparmor/lsm.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/security/apparmor/lsm.c b/security/apparmor/lsm.c
index cef8c466af80..d0485fb0ed63 100644
--- a/security/apparmor/lsm.c
+++ b/security/apparmor/lsm.c
@@ -1124,7 +1124,7 @@ static int apparmor_socket_create(int family, int type, int protocol, int kern)
* @sock: socket that is being setup
* @family: family of socket being created
* @type: type of the socket
- * @ptotocol: protocol of the socket
+ * @protocol: protocol of the socket
* @kern: socket is a special kernel socket
*
* Note:

---
base-commit: 2c4d8e19cf060744a9db466ffbaea13ab37f25ca
change-id: 20240505-apparmor_socket_post_create-kdoc-897c7ad5d007



2024-05-10 16:09:16

by John Johansen

[permalink] [raw]
Subject: Re: [PATCH] apparmor: fix apparmor_socket_post_create() kernel-doc

On 5/5/24 15:39, Jeff Johnson wrote:
> make C=1 reports:
>
> security/apparmor/lsm.c:1138: warning: Function parameter or struct member 'protocol' not described in 'apparmor_socket_post_create'
>
> Fix this by correcting the misspelling of 'protocol'.
>
> Signed-off-by: Jeff Johnson <[email protected]>

Hey Jeff, thanks for the patch, unfortunately Christian Göttsche version of the patch came in before yours so that is the one I committed

> ---
> security/apparmor/lsm.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/security/apparmor/lsm.c b/security/apparmor/lsm.c
> index cef8c466af80..d0485fb0ed63 100644
> --- a/security/apparmor/lsm.c
> +++ b/security/apparmor/lsm.c
> @@ -1124,7 +1124,7 @@ static int apparmor_socket_create(int family, int type, int protocol, int kern)
> * @sock: socket that is being setup
> * @family: family of socket being created
> * @type: type of the socket
> - * @ptotocol: protocol of the socket
> + * @protocol: protocol of the socket
> * @kern: socket is a special kernel socket
> *
> * Note:
>
> ---
> base-commit: 2c4d8e19cf060744a9db466ffbaea13ab37f25ca
> change-id: 20240505-apparmor_socket_post_create-kdoc-897c7ad5d007
>


2024-05-10 19:01:50

by Jeff Johnson

[permalink] [raw]
Subject: Re: [PATCH] apparmor: fix apparmor_socket_post_create() kernel-doc

On 5/10/2024 8:58 AM, John Johansen wrote:
> On 5/5/24 15:39, Jeff Johnson wrote:
>> make C=1 reports:
>>
>> security/apparmor/lsm.c:1138: warning: Function parameter or struct member 'protocol' not described in 'apparmor_socket_post_create'
>>
>> Fix this by correcting the misspelling of 'protocol'.
>>
>> Signed-off-by: Jeff Johnson <[email protected]>
>
> Hey Jeff, thanks for the patch, unfortunately Christian Göttsche version of the patch came in before yours so that is the one I committed

np, glad others are helping to clean up :)