apparmor: update kernel doc comments for xxx_label_crit_section

jrjohansen · jrjohansen · commit 6afb0a7bc95a · 2025-07-15T22:39:43.000-07:00
Add a kernel doc header for __end_current_label_crit_section(), and update the header for __begin_current_label_crit_section(). Fixes: b42ecc5 ("apparmor: make __begin_current_label_crit_section() indicate whether put is needed") Signed-off-by: John Johansen <john.johansen@canonical.com>
diff --git a/security/apparmor/include/cred.h b/security/apparmor/include/cred.h
@@ -114,6 +114,13 @@ static inline struct aa_label *aa_get_current_label(void)
 	return aa_get_label(l);
 }
 
+/**
+ * __end_current_label_crit_section - end crit section begun with __begin_...
+ * @label: label obtained from __begin_current_label_crit_section
+ * @needput: output: bool set by __begin_current_label_crit_section
+ *
+ * Returns: label to use for this crit section
+ */
 static inline void __end_current_label_crit_section(struct aa_label *label,
 						    bool needput)
 {
@@ -137,6 +144,7 @@ static inline void end_current_label_crit_section(struct aa_label *label)
 
 /**
  * __begin_current_label_crit_section - current's confining label
+ * @needput: store whether the label needs to be put when ending crit section
  *
  * Returns: up to date confining label or the ns unconfined label (NOT NULL)
  *

Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,13 @@ static inline struct aa_label *aa_get_current_label(void)`
`114`	`114`	`return aa_get_label(l);`
`115`	`115`	`}`
`116`	`116`
	`117`	`+/**`
	`118`	`+ * __end_current_label_crit_section - end crit section begun with __begin_...`
	`119`	`+ * @label: label obtained from __begin_current_label_crit_section`
	`120`	`+ * @needput: output: bool set by __begin_current_label_crit_section`
	`121`	`+ *`
	`122`	`+ * Returns: label to use for this crit section`
	`123`	`+ */`
`117`	`124`	`static inline void __end_current_label_crit_section(struct aa_label *label,`
`118`	`125`	`bool needput)`
`119`	`126`	`{`
`@@ -137,6 +144,7 @@ static inline void end_current_label_crit_section(struct aa_label *label)`
`137`	`144`
`138`	`145`	`/**`
`139`	`146`	`* __begin_current_label_crit_section - current's confining label`
	`147`	`+ * @needput: store whether the label needs to be put when ending crit section`
`140`	`148`	`*`
`141`	`149`	`* Returns: up to date confining label or the ns unconfined label (NOT NULL)`
`142`	`150`	`*`