2022-05-14 00:09:01

by Yang Li

Subject: [PATCH -next] apparmor: Fix aa_str_perms() kernel-doc comment

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 <[email protected]>
Signed-off-by: Yang Li <[email protected]>
---
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
--
2.20.1.7.g153144c

2022-05-19 10:37:18

by John Johansen

Subject: Re: [PATCH -next] apparmor: Fix aa_str_perms() kernel-doc comment

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 <[email protected]>
> Signed-off-by: Yang Li <[email protected]>

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

Acked-by: John Johansen <[email protected]>

> ---
> 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