linux-kernel - Re: [PATCH -next] 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: <a6ce3c77-bb90-f074-e3a5-eb16c7b6ea8b@canonical.com>
Date:   Mon, 21 Mar 2022 13:20:07 -0700
From:   John Johansen <john.johansen@...onical.com>
To:     Yang Li <yang.lee@...ux.alibaba.com>
Cc:     jmorris@...ei.org, serge@...lyn.com, 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] apparmor: Fix some kernel-doc comments

On 3/16/22 18:03, Yang Li wrote:
> Remove some warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> 
> security/apparmor/domain.c:137: warning: Function parameter or member
> 'state' not described in 'label_compound_match'
> security/apparmor/domain.c:137: warning: Excess function parameter
> 'start' description in 'label_compound_match'
> security/apparmor/domain.c:1294: warning: Excess function parameter
> 'onexec' description in 'aa_change_profile'
> 
> 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/domain.c | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/security/apparmor/domain.c b/security/apparmor/domain.c
> index a29e69d2c300..d71023f5c9c4 100644
> --- a/security/apparmor/domain.c
> +++ b/security/apparmor/domain.c
> @@ -119,7 +119,7 @@ static inline unsigned int match_component(struct aa_profile *profile,
>   * @profile: profile to find perms for
>   * @label: label to check access permissions for
>   * @stack: whether this is a stacking request
> - * @start: state to start match in
> + * @state: state to start match in
>   * @subns: whether to do permission checks on components in a subns
>   * @request: permissions to request
>   * @perms: perms struct to set
> @@ -1279,7 +1279,6 @@ static int change_profile_perms_wrapper(const char *op, const char *name,
>  /**
>   * aa_change_profile - perform a one-way profile transition
>   * @fqname: name of profile may include namespace (NOT NULL)
> - * @onexec: whether this transition is to take place immediately or at exec
>   * @flags: flags affecting change behavior
>   *
>   * Change to new profile @name.  Unlike with hats, there is no way