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: <6aca407d-9c81-b460-f03e-cea0369a6185@canonical.com>
Date:   Tue, 19 Jul 2022 19:28:26 -0700
From:   John Johansen <john.johansen@...onical.com>
To:     Yang Li <yang.lee@...ux.alibaba.com>
Cc:     paul@...l-moore.com, 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 7/17/22 23:30, Yang Li wrote:
> Remove warnings found by running scripts/kernel-doc, which is caused by
> using 'make W=1'.
> security/apparmor/policy_ns.c:65: warning: Function parameter or member 'curr' not described in 'aa_ns_name'
> security/apparmor/policy_ns.c:65: warning: Function parameter or member 'view' not described in 'aa_ns_name'
> security/apparmor/policy_ns.c:65: warning: Function parameter or member 'subns' not described in 'aa_ns_name'
> security/apparmor/policy_ns.c:65: warning: expecting prototype for aa_na_name(). Prototype was for aa_ns_name() instead
> security/apparmor/policy_ns.c:214: warning: Function parameter or member 'view' not described in '__aa_lookupn_ns'
> security/apparmor/policy_ns.c:214: warning: Excess function parameter 'base' description in '__aa_lookupn_ns'
> security/apparmor/policy_ns.c:297: warning: expecting prototype for aa_create_ns(). Prototype was for __aa_find_or_create_ns() instead
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>

thanks I have pulled this into apparmor-next

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

> ---
>   security/apparmor/policy_ns.c | 12 ++++++------
>   1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/security/apparmor/policy_ns.c b/security/apparmor/policy_ns.c
> index 300953a02a24..0ef268d6554d 100644
> --- a/security/apparmor/policy_ns.c
> +++ b/security/apparmor/policy_ns.c
> @@ -54,10 +54,10 @@ bool aa_ns_visible(struct aa_ns *curr, struct aa_ns *view, bool subns)
>   }
>   
>   /**
> - * aa_na_name - Find the ns name to display for @view from @curr
> - * @curr - current namespace (NOT NULL)
> - * @view - namespace attempting to view (NOT NULL)
> - * @subns - are subns visible
> + * aa_ns_name - Find the ns name to display for @view from @curr
> + * @curr: current namespace (NOT NULL)
> + * @view: namespace attempting to view (NOT NULL)
> + * @subns: are subns visible
>    *
>    * Returns: name of @view visible from @curr
>    */
> @@ -200,7 +200,7 @@ struct aa_ns *aa_find_ns(struct aa_ns *root, const char *name)
>   
>   /**
>    * __aa_lookupn_ns - lookup the namespace matching @hname
> - * @base: base list to start looking up profile name from  (NOT NULL)
> + * @view: namespace to search in  (NOT NULL)
>    * @hname: hierarchical ns name  (NOT NULL)
>    * @n: length of @hname
>    *
> @@ -285,7 +285,7 @@ static struct aa_ns *__aa_create_ns(struct aa_ns *parent, const char *name,
>   }
>   
>   /**
> - * aa_create_ns - create an ns, fail if it already exists
> + * __aa_find_or_create_ns - create an ns, fail if it already exists
>    * @parent: the parent of the namespace being created
>    * @name: the name of the namespace
>    * @dir: if not null the dir to put the ns entries in