linux-kernel - Re: [PATCH -next 2/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] [thread-next>] [day] [month] [year] [list]

Message-ID: <eca2206d-562f-a85f-ca51-01afcba63dc8@canonical.com>
Date:   Sat, 29 Jan 2022 15:59:58 -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 2/3] apparmor: Fix some kernel-doc comments

On 1/28/22 18:51, Yang Li wrote:
> Add the description of @ns_name, change function name aa_u16_chunck to
> unpack_u16_chunk and verify_head to verify_header in kernel-doc comment
> to remove warnings found by running scripts/kernel-doc, which is caused
> by using 'make W=1'.
> 
> security/apparmor/policy_unpack.c:224: warning: expecting prototype for
> aa_u16_chunck(). Prototype was for unpack_u16_chunk() instead
> security/apparmor/policy_unpack.c:678: warning: Function parameter or
> member 'ns_name' not described in 'unpack_profile'
> security/apparmor/policy_unpack.c:950: warning: expecting prototype for
> verify_head(). Prototype was for verify_header() instead
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
Acked-by: John Johansen <john.johansen@...onical.com>

I have pulled this into my tree

> ---
>  security/apparmor/policy_unpack.c | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/security/apparmor/policy_unpack.c b/security/apparmor/policy_unpack.c
> index 55dca9e3af50..3cc0fd2dff87 100644
> --- a/security/apparmor/policy_unpack.c
> +++ b/security/apparmor/policy_unpack.c
> @@ -214,7 +214,7 @@ static void *kvmemdup(const void *src, size_t len)
>  }
>  
>  /**
> - * aa_u16_chunck - test and do bounds checking for a u16 size based chunk
> + * unpack_u16_chunk - test and do bounds checking for a u16 size based chunk
>   * @e: serialized data read head (NOT NULL)
>   * @chunk: start address for chunk of data (NOT NULL)
>   *
> @@ -671,6 +671,7 @@ static int datacmp(struct rhashtable_compare_arg *arg, const void *obj)
>  /**
>   * unpack_profile - unpack a serialized profile
>   * @e: serialized data extent information (NOT NULL)
> + * @ns_name: pointer of newly allocated copy of %NULL in case of error
>   *
>   * NOTE: unpack profile sets audit struct if there is a failure
>   */
> @@ -939,7 +940,7 @@ static struct aa_profile *unpack_profile(struct aa_ext *e, char **ns_name)
>  }
>  
>  /**
> - * verify_head - unpack serialized stream header
> + * verify_header - unpack serialized stream header
>   * @e: serialized data read head (NOT NULL)
>   * @required: whether the header is required or optional
>   * @ns: Returns - namespace if one is specified else NULL (NOT NULL)