2022-03-17 04:50:27

by Yang Li

Subject: [PATCH -next] apparmor: Fix some kernel-doc comments

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

2022-03-21 23:09:37

by John Johansen

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

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

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