apparmor: fixup return comments for kernel doc cleanups by Gaosheng Cui

jrjohansen · jrjohansen · commit d2fe16e94cc3 · 2023-08-08T13:12:19.000-07:00
[PATCH -next 05/11] apparmor: Fix kernel-doc warnings in apparmor/label.c missed updating the Returns comment for the new parameter names [PATCH -next 05/11] apparmor: Fix kernel-doc warnings in apparmor/label.c Added the @SiZe parameter comment without mentioning it is a return value. Signed-off-by: John Johansen <john.johansen@canonical.com>
diff --git a/security/apparmor/label.c b/security/apparmor/label.c
@@ -159,9 +159,9 @@ static int profile_cmp(struct aa_profile *a, struct aa_profile *b)
  * @b: aa_profile to compare (NOT NULL)
  * @bn: length of @b
  *
- * Returns: <0  if a < vec
- *          ==0 if a == vec
- *          >0  if a > vec
+ * Returns: <0  if @a < @b
+ *          ==0 if @a == @b
+ *          >0  if @a > @b
  */
 static int vec_cmp(struct aa_profile **a, int an, struct aa_profile **b, int bn)
 {
diff --git a/security/apparmor/policy_compat.c b/security/apparmor/policy_compat.c
@@ -143,7 +143,7 @@ static struct aa_perms compute_fperms_other(struct aa_dfa *dfa,
  * compute_fperms - convert dfa compressed perms to internal perms and store
  *		    them so they can be retrieved later.
  * @dfa: a dfa using fperms to remap to internal permissions
- * @size: the permission table size
+ * @size: Returns the permission table size
  *
  * Returns: remapped perm table
  */

Original file line number	Diff line number	Diff line change
`@@ -159,9 +159,9 @@ static int profile_cmp(struct aa_profile a, struct aa_profile b)`
`159`	`159`	`* @b: aa_profile to compare (NOT NULL)`
`160`	`160`	`* @bn: length of @b`
`161`	`161`	`*`
`162`		`- * Returns: <0 if a < vec`
`163`		`- * ==0 if a == vec`
`164`		`- * >0 if a > vec`
	`162`	`+ * Returns: <0 if @a < @b`
	`163`	`+ * ==0 if @a == @b`
	`164`	`+ * >0 if @a > @b`
`165`	`165`	`*/`
`166`	`166`	`static int vec_cmp(struct aa_profile a, int an, struct aa_profile b, int bn)`
`167`	`167`	`{`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ static struct aa_perms compute_fperms_other(struct aa_dfa *dfa,`
`143`	`143`	`* compute_fperms - convert dfa compressed perms to internal perms and store`
`144`	`144`	`* them so they can be retrieved later.`
`145`	`145`	`* @dfa: a dfa using fperms to remap to internal permissions`
`146`		`- * @size: the permission table size`
	`146`	`+ * @size: Returns the permission table size`
`147`	`147`	`*`
`148`	`148`	`* Returns: remapped perm table`
`149`	`149`	`*/`