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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Sat, 24 Apr 2021 08:46:22 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Souptick Joarder <jrdr.linux@...il.com>, paul@...l-moore.com,
        stephen.smalley.work@...il.com, eparis@...isplace.org
Cc:     selinux@...r.kernel.org, linux-kernel@...r.kernel.org
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 <lkp@...el.com>
> Signed-off-by: Souptick Joarder <jrdr.linux@...il.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