linux-kernel - Re: [PATCH -next 3/3] apparmor: Fix some kernel-doc comments

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]

Message-ID: <9836f3d4-186f-7a6e-448d-8e94be5f634f@canonical.com>
Date:   Sat, 29 Jan 2022 16:03:03 -0800
From:   John Johansen <john.johansen@...onical.com>
To:     Yang Li <yang.lee@...ux.alibaba.com>, serge@...lyn.com
Cc:     jmorris@...ei.org, apparmor@...ts.ubuntu.com,
        linux-security-module@...r.kernel.org,
        linux-kernel@...r.kernel.org, Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next 3/3] apparmor: Fix some kernel-doc comments

On 1/28/22 18:52, Yang Li wrote:
> Don't use /** for non-kernel-doc comments and change function name
> aa_mangle_name to mangle_name in kernel-doc comment to Remove some
> warnings found by running scripts/kernel-doc, which is caused by
> using 'make W=1'.
> 
> security/apparmor/apparmorfs.c:1503: warning: Cannot understand  *
>  on line 1503 - I thought it was a doc line
> security/apparmor/apparmorfs.c:1530: warning: Cannot understand  *
>  on line 1530 - I thought it was a doc line
> security/apparmor/apparmorfs.c:1892: warning: Cannot understand  *
>  on line 1892 - I thought it was a doc line
> security/apparmor/apparmorfs.c:108: warning: expecting prototype for
> aa_mangle_name(). Prototype was for mangle_name() instead
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>

just for completeness (this is a dup of [PATCH 3/3] apparmor: Fix some kernel-doc comments)

Acked-by: John Johansen <john.johansen@...onical.com>

I have pulled this into my tree

> ---
>  security/apparmor/apparmorfs.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/security/apparmor/apparmorfs.c b/security/apparmor/apparmorfs.c
> index 15efe4076fc4..4d7df859542d 100644
> --- a/security/apparmor/apparmorfs.c
> +++ b/security/apparmor/apparmorfs.c
> @@ -98,7 +98,7 @@ static struct rawdata_f_data *rawdata_f_data_alloc(size_t size)
>  #endif
>  
>  /**
> - * aa_mangle_name - mangle a profile name to std profile layout form
> + * mangle_name - mangle a profile name to std profile layout form
>   * @name: profile name to mangle  (NOT NULL)
>   * @target: buffer to store mangled name, same length as @name (MAYBE NULL)
>   *
> @@ -1499,7 +1499,7 @@ int __aa_fs_create_rawdata(struct aa_ns *ns, struct aa_loaddata *rawdata)
>  
>  /** fns to setup dynamic per profile/namespace files **/
>  
> -/**
> +/*
>   *
>   * Requires: @profile->ns->lock held
>   */
> @@ -1526,7 +1526,7 @@ void __aafs_profile_rmdir(struct aa_profile *profile)
>  	}
>  }
>  
> -/**
> +/*
>   *
>   * Requires: @old->ns->lock held
>   */
> @@ -1888,7 +1888,7 @@ static void __aa_fs_list_remove_rawdata(struct aa_ns *ns)
>  		__aa_fs_remove_rawdata(ent);
>  }
>  
> -/**
> +/*
>   *
>   * Requires: @ns->lock held
>   */