* [PATCH] selinux: Corrected comment to match kernel-doc comment
@ 2021-04-24 11:18 Souptick Joarder
2021-04-24 15:46 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Souptick Joarder @ 2021-04-24 11:18 UTC (permalink / raw)
To: paul, stephen.smalley.work, eparis
Cc: selinux, linux-kernel, Souptick Joarder
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 <lkp@intel.com>
Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
---
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
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] selinux: Corrected comment to match kernel-doc comment
2021-04-24 11:18 [PATCH] selinux: Corrected comment to match kernel-doc comment Souptick Joarder
@ 2021-04-24 15:46 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2021-04-24 15:46 UTC (permalink / raw)
To: Souptick Joarder, paul, stephen.smalley.work, eparis
Cc: selinux, linux-kernel
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 <lkp@intel.com>
> Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
> ---
> 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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-04-24 15:46 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-24 11:18 [PATCH] selinux: Corrected comment to match kernel-doc comment Souptick Joarder
2021-04-24 15:46 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).