linux-kernel - [PATCH -next] apparmor: Fix aa_str

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20220512075350.31163-1-yang.lee@linux.alibaba.com>
Date:   Thu, 12 May 2022 15:53:50 +0800
From:   Yang Li <yang.lee@...ux.alibaba.com>
To:     john.johansen@...onical.com
Cc:     jmorris@...ei.org, serge@...lyn.com, apparmor@...ts.ubuntu.com,
        linux-security-module@...r.kernel.org,
        linux-kernel@...r.kernel.org, Yang Li <yang.lee@...ux.alibaba.com>,
        Abaci Robot <abaci@...ux.alibaba.com>
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 <abaci@...ux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
---
 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