diff mbox series

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

Message ID 20231023005517.115318-1-yang.lee@linux.alibaba.com (mailing list archive)
State Handled Elsewhere
Headers show
Series [-next] apparmor: Fix some kernel-doc comments | expand

Commit Message

Yang Li Oct. 23, 2023, 12:55 a.m. UTC
Fix some kernel-doc comments to silence the warnings:
security/apparmor/capability.c:66: warning: Function parameter or member 'ad' not described in 'audit_caps'
security/apparmor/capability.c:66: warning: Excess function parameter 'as' description in 'audit_caps'
security/apparmor/capability.c:154: warning: Function parameter or member 'subj_cred' not described in 'aa_capable'
security/apparmor/capability.c:154: warning: Excess function parameter 'subj_cread' description in 'aa_capable'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7035
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 security/apparmor/capability.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

John Johansen Nov. 19, 2023, 9:08 a.m. UTC | #1
On 10/22/23 17:55, Yang Li wrote:
> Fix some kernel-doc comments to silence the warnings:
> security/apparmor/capability.c:66: warning: Function parameter or member 'ad' not described in 'audit_caps'
> security/apparmor/capability.c:66: warning: Excess function parameter 'as' description in 'audit_caps'
> security/apparmor/capability.c:154: warning: Function parameter or member 'subj_cred' not described in 'aa_capable'
> security/apparmor/capability.c:154: warning: Excess function parameter 'subj_cread' description in 'aa_capable'
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7035
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

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

> ---
>   security/apparmor/capability.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/security/apparmor/capability.c b/security/apparmor/capability.c
> index 0b7d2b1086c9..9934df16c843 100644
> --- a/security/apparmor/capability.c
> +++ b/security/apparmor/capability.c
> @@ -51,7 +51,7 @@ static void audit_cb(struct audit_buffer *ab, void *va)
>   
>   /**
>    * audit_caps - audit a capability
> - * @as: audit data
> + * @ad: audit data
>    * @profile: profile being tested for confinement (NOT NULL)
>    * @cap: capability tested
>    * @error: error code returned by test
> @@ -140,7 +140,7 @@ static int profile_capable(struct aa_profile *profile, int cap,
>   
>   /**
>    * aa_capable - test permission to use capability
> - * @subj_cread: cred we are testing capability against
> + * @subj_cred: cred we are testing capability against
>    * @label: label being tested for capability (NOT NULL)
>    * @cap: capability to be tested
>    * @opts: CAP_OPT_NOAUDIT bit determines whether audit record is generated
diff mbox series

Patch

diff --git a/security/apparmor/capability.c b/security/apparmor/capability.c
index 0b7d2b1086c9..9934df16c843 100644
--- a/security/apparmor/capability.c
+++ b/security/apparmor/capability.c
@@ -51,7 +51,7 @@  static void audit_cb(struct audit_buffer *ab, void *va)
 
 /**
  * audit_caps - audit a capability
- * @as: audit data
+ * @ad: audit data
  * @profile: profile being tested for confinement (NOT NULL)
  * @cap: capability tested
  * @error: error code returned by test
@@ -140,7 +140,7 @@  static int profile_capable(struct aa_profile *profile, int cap,
 
 /**
  * aa_capable - test permission to use capability
- * @subj_cread: cred we are testing capability against
+ * @subj_cred: cred we are testing capability against
  * @label: label being tested for capability (NOT NULL)
  * @cap: capability to be tested
  * @opts: CAP_OPT_NOAUDIT bit determines whether audit record is generated