Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <61824a01-0c03-7c74-1101-a30d3ae99f32@canonical.com>
Date:   Thu, 19 May 2022 01:52:40 -0700
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.8.1
Subject: Re: [PATCH -next] apparmor: Fix aa_str_perms() kernel-doc comment
Content-Language: en-US
To:     Yang Li <yang.lee@linux.alibaba.com>
Cc:     jmorris@namei.org, serge@hallyn.com, apparmor@lists.ubuntu.com,
        linux-security-module@vger.kernel.org,
        linux-kernel@vger.kernel.org, Abaci Robot <abaci@linux.alibaba.com>
References: <20220512075350.31163-1-yang.lee@linux.alibaba.com>
From:   John Johansen <john.johansen@canonical.com>
Organization: Canonical
In-Reply-To: <20220512075350.31163-1-yang.lee@linux.alibaba.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 5/12/22 00:53, Yang Li wrote:
> Add the description of @start and remove @state in aa_str_perms()
> kernel-doc comment to remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> 
> security/apparmor/file.c:260: warning: Function parameter or member
> 'start' not described in 'aa_str_perms'
> security/apparmor/file.c:260: warning: Excess function parameter 'state'
> description in 'aa_str_perms'
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

sorry, for the delay on this I have pulled it into my tree

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

> ---
>  security/apparmor/file.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/security/apparmor/file.c b/security/apparmor/file.c
> index e1b7e93602e4..137c99bb5d4a 100644
> --- a/security/apparmor/file.c
> +++ b/security/apparmor/file.c
> @@ -247,7 +247,7 @@ struct aa_perms aa_compute_fperms(struct aa_dfa *dfa, unsigned int state,
>  /**
>   * aa_str_perms - find permission that match @name
>   * @dfa: to match against  (MAYBE NULL)
> - * @state: state to start matching in
> + * @start: the state of the dfa to start matching in
>   * @name: string to match against dfa  (NOT NULL)
>   * @cond: conditions to consider for permission set computation  (NOT NULL)
>   * @perms: Returns - the permissions found when matching @name