2023-10-23 01:12:04

by Yang Li

[permalink] [raw]
Subject: [PATCH -next 1/2] apparmor: Fix one kernel-doc comment

Fix one kernel-doc comment to silence the warnings:
security/apparmor/domain.c:46: warning: Function parameter or member 'to_cred' not described in 'may_change_ptraced_domain'
security/apparmor/domain.c:46: warning: Excess function parameter 'cred' description in 'may_change_ptraced_domain'

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

diff --git a/security/apparmor/domain.c b/security/apparmor/domain.c
index ed4a13d44894..89fbeab4b33b 100644
--- a/security/apparmor/domain.c
+++ b/security/apparmor/domain.c
@@ -31,7 +31,7 @@

/**
* may_change_ptraced_domain - check if can change profile on ptraced task
- * @cred: cred of task changing domain
+ * @to_cred: cred of task changing domain
* @to_label: profile to change to (NOT NULL)
* @info: message if there is an error
*
--
2.20.1.7.g153144c


2023-10-23 01:12:04

by Yang Li

[permalink] [raw]
Subject: [PATCH -next 2/2] apparmor: Fix some kernel-doc comments

Fix some kernel-doc comments to silence the warnings:
security/apparmor/policy.c:117: warning: Function parameter or member 'kref' not described in 'aa_pdb_free_kref'
security/apparmor/policy.c:117: warning: Excess function parameter 'kr' description in 'aa_pdb_free_kref'
security/apparmor/policy.c:882: warning: Function parameter or member 'subj_cred' not described in 'aa_may_manage_policy'

Reported-by: Abaci Robot <[email protected]>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7037
Signed-off-by: Yang Li <[email protected]>
---
security/apparmor/policy.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/security/apparmor/policy.c b/security/apparmor/policy.c
index a441d96adcbf..ed4c9803c8fa 100644
--- a/security/apparmor/policy.c
+++ b/security/apparmor/policy.c
@@ -111,7 +111,7 @@ static void aa_free_pdb(struct aa_policydb *policy)

/**
* aa_pdb_free_kref - free aa_policydb by kref (called by aa_put_pdb)
- * @kr: kref callback for freeing of a dfa (NOT NULL)
+ * @kref: kref callback for freeing of a dfa (NOT NULL)
*/
void aa_pdb_free_kref(struct kref *kref)
{
@@ -870,7 +870,7 @@ bool aa_current_policy_admin_capable(struct aa_ns *ns)

/**
* aa_may_manage_policy - can the current task manage policy
- * @subj_cred; subjects cred
+ * @subj_cred: subjects cred
* @label: label to check if it can manage policy
* @ns: namespace being managed by @label (may be NULL if @label's ns)
* @mask: contains the policy manipulation operation being done
--
2.20.1.7.g153144c

2023-11-19 09:10:20

by John Johansen

[permalink] [raw]
Subject: Re: [PATCH -next 2/2] apparmor: Fix some kernel-doc comments

On 10/22/23 18:11, Yang Li wrote:
> Fix some kernel-doc comments to silence the warnings:
> security/apparmor/policy.c:117: warning: Function parameter or member 'kref' not described in 'aa_pdb_free_kref'
> security/apparmor/policy.c:117: warning: Excess function parameter 'kr' description in 'aa_pdb_free_kref'
> security/apparmor/policy.c:882: warning: Function parameter or member 'subj_cred' not described in 'aa_may_manage_policy'
>
> Reported-by: Abaci Robot <[email protected]>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7037
> Signed-off-by: Yang Li <[email protected]>

sorry I missed replying to this. It was pulled into apparmor-next and merged upstream during the 6.7 merge window


> ---
> security/apparmor/policy.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/security/apparmor/policy.c b/security/apparmor/policy.c
> index a441d96adcbf..ed4c9803c8fa 100644
> --- a/security/apparmor/policy.c
> +++ b/security/apparmor/policy.c
> @@ -111,7 +111,7 @@ static void aa_free_pdb(struct aa_policydb *policy)
>
> /**
> * aa_pdb_free_kref - free aa_policydb by kref (called by aa_put_pdb)
> - * @kr: kref callback for freeing of a dfa (NOT NULL)
> + * @kref: kref callback for freeing of a dfa (NOT NULL)
> */
> void aa_pdb_free_kref(struct kref *kref)
> {
> @@ -870,7 +870,7 @@ bool aa_current_policy_admin_capable(struct aa_ns *ns)
>
> /**
> * aa_may_manage_policy - can the current task manage policy
> - * @subj_cred; subjects cred
> + * @subj_cred: subjects cred
> * @label: label to check if it can manage policy
> * @ns: namespace being managed by @label (may be NULL if @label's ns)
> * @mask: contains the policy manipulation operation being done