2023-03-03 01:28:42

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] AppArmor: Fix some kernel-doc comments

Make the description of @table to @strs in function unpack_trans_table()
to silence the warnings:

security/apparmor/policy_unpack.c:456: warning: Function parameter or member 'strs' not described in 'unpack_trans_table'
security/apparmor/policy_unpack.c:456: warning: Excess function parameter 'table' description in 'unpack_trans_table'

Reported-by: Abaci Robot <[email protected]>
Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=4332
Signed-off-by: Yang Li <[email protected]>
---
security/apparmor/policy_unpack.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/security/apparmor/policy_unpack.c b/security/apparmor/policy_unpack.c
index cf2ceec40b28..c3f44f1deb07 100644
--- a/security/apparmor/policy_unpack.c
+++ b/security/apparmor/policy_unpack.c
@@ -448,7 +448,7 @@ static struct aa_dfa *unpack_dfa(struct aa_ext *e, int flags)
/**
* unpack_trans_table - unpack a profile transition table
* @e: serialized data extent information (NOT NULL)
- * @table: str table to unpack to (NOT NULL)
+ * @strs: str table to unpack to (NOT NULL)
*
* Returns: true if table successfully unpacked or not present
*/
--
2.20.1.7.g153144c



2023-04-09 22:28:02

by John Johansen

[permalink] [raw]
Subject: Re: [PATCH -next] AppArmor: Fix some kernel-doc comments

On 3/2/23 17:28, Yang Li wrote:
> Make the description of @table to @strs in function unpack_trans_table()
> to silence the warnings:
>
> security/apparmor/policy_unpack.c:456: warning: Function parameter or member 'strs' not described in 'unpack_trans_table'
> security/apparmor/policy_unpack.c:456: warning: Excess function parameter 'table' description in 'unpack_trans_table'
>
> Reported-by: Abaci Robot <[email protected]>
> Link: https://bugzilla.openanolis.cn/show_bug.cgi?id=4332
> Signed-off-by: Yang Li <[email protected]>

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

I have pulled this into the apparmor tree thanks

> ---
> security/apparmor/policy_unpack.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/security/apparmor/policy_unpack.c b/security/apparmor/policy_unpack.c
> index cf2ceec40b28..c3f44f1deb07 100644
> --- a/security/apparmor/policy_unpack.c
> +++ b/security/apparmor/policy_unpack.c
> @@ -448,7 +448,7 @@ static struct aa_dfa *unpack_dfa(struct aa_ext *e, int flags)
> /**
> * unpack_trans_table - unpack a profile transition table
> * @e: serialized data extent information (NOT NULL)
> - * @table: str table to unpack to (NOT NULL)
> + * @strs: str table to unpack to (NOT NULL)
> *
> * Returns: true if table successfully unpacked or not present
> */