2021-04-24 11:19:17

by Souptick Joarder

Subject: [PATCH] selinux: Corrected comment to match kernel-doc comment

Kernel test robot throws below warning ->

security/selinux/avc.c:822: warning: This comment starts with '/**', but
isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Updated the comment to align with kernel-doc comment.

Reported-by: kernel test robot <[email protected]>
Signed-off-by: Souptick Joarder <[email protected]>
---
security/selinux/avc.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/security/selinux/avc.c b/security/selinux/avc.c
index ad451cf..04a886b 100644
--- a/security/selinux/avc.c
+++ b/security/selinux/avc.c
@@ -818,7 +818,7 @@ int __init avc_add_callback(int (*callback)(u32 event), u32 events)
return rc;
}

-/**
+/*
* avc_update_node Update an AVC entry
* @event : Updating event
* @perms : Permission mask bits
--
1.9.1

2021-04-24 15:47:53

by Randy Dunlap

Subject: Re: [PATCH] selinux: Corrected comment to match kernel-doc comment

On 4/24/21 4:18 AM, Souptick Joarder wrote:
> Kernel test robot throws below warning ->
>
> security/selinux/avc.c:822: warning: This comment starts with '/**', but
> isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>
> Updated the comment to align with kernel-doc comment.
>
> Reported-by: kernel test robot <[email protected]>
> Signed-off-by: Souptick Joarder <[email protected]>
> ---
> security/selinux/avc.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/security/selinux/avc.c b/security/selinux/avc.c
> index ad451cf..04a886b 100644
> --- a/security/selinux/avc.c
> +++ b/security/selinux/avc.c
> @@ -818,7 +818,7 @@ int __init avc_add_callback(int (*callback)(u32 event), u32 events)
> return rc;
> }
>
> -/**
> +/*
> * avc_update_node Update an AVC entry

or

* avc_update_node - Update an AVC entry

would work also. :)
And leave the /**.

Mostly we want to have kernel-doc for exported (non-static) functions,
but this file doesn't exactly conform to that, so the latter fix
is more preferable IMO.

> * @event : Updating event
> * @perms : Permission mask bits
>


--
~Randy