diff mbox series

apparmor: fix apparmor_socket_post_create() kernel-doc

Message ID 20240505-apparmor_socket_post_create-kdoc-v1-1-1fd88e546e92@quicinc.com (mailing list archive)
State Handled Elsewhere
Headers show
Series apparmor: fix apparmor_socket_post_create() kernel-doc | expand

Commit Message

Jeff Johnson May 5, 2024, 10:39 p.m. UTC
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 <quic_jjohnson@quicinc.com>
---
 security/apparmor/lsm.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


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

Comments

John Johansen May 10, 2024, 3:58 p.m. UTC | #1
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 <quic_jjohnson@quicinc.com>

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
>
Jeff Johnson May 10, 2024, 7:01 p.m. UTC | #2
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 <quic_jjohnson@quicinc.com>
> 
> 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 :)
diff mbox series

Patch

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: