Skip to contentSkip to conversation

apparmor: Fix aa_str_perms() kernel-doc comment

PATCH In review Yang Li 2 participants 2 messages May 12, 2022 – May 19, 2022

Subsystems (2)
lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 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'

---
 security/apparmor/file.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
security/apparmor/file.c +1 -1
index e1b7e93602e4..137c99bb5d4a 100644
@@ -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
Signature · 1 line
2.20.1.7.g153144c
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 11 lines · Yang Li

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'

sorry, for the delay on this I have pulled it into my tree

Quoted 17 lines
---
 security/apparmor/file.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
security/apparmor/file.c +1 -1
index e1b7e93602e4..137c99bb5d4a 100644
@@ -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