diff mbox series

[-next] apparmor: remove kernel-doc warnings

Message ID 20230731111614.212113-1-wangzhu9@huawei.com (mailing list archive)
State Handled Elsewhere
Headers show
Series [-next] apparmor: remove kernel-doc warnings | expand

Commit Message

wangzhu July 31, 2023, 11:16 a.m. UTC
Remove kernel-doc warnings:

security/apparmor/lib.c:33: warning: Function parameter or member 't' not
described in 'aa_free_str_table'
security/apparmor/lib.c:33: warning: Excess function parameter 'str'
description in 'aa_free_str_table'
security/apparmor/lib.c:94: warning: Function parameter or member 'n' not
described in 'skipn_spaces'
security/apparmor/lib.c:390: warning: Excess function parameter 'deny'
description in 'aa_check_perms'

Signed-off-by: Zhu Wang <wangzhu9@huawei.com>
---
 security/apparmor/lib.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

John Johansen Aug. 8, 2023, 8:24 p.m. UTC | #1
On 7/31/23 04:16, Zhu Wang wrote:
> Remove kernel-doc warnings:
> 
> security/apparmor/lib.c:33: warning: Function parameter or member 't' not
> described in 'aa_free_str_table'
> security/apparmor/lib.c:33: warning: Excess function parameter 'str'
> description in 'aa_free_str_table'
> security/apparmor/lib.c:94: warning: Function parameter or member 'n' not
> described in 'skipn_spaces'
> security/apparmor/lib.c:390: warning: Excess function parameter 'deny'
> description in 'aa_check_perms'
> 
> Signed-off-by: Zhu Wang <wangzhu9@huawei.com>

thank you for your contribution unfortunately Gaosheng Cui beat you to this
set of changes with

[PATCH -next 06/11] apparmor: Fix kernel-doc warnings in apparmor/lib.c

> ---
>   security/apparmor/lib.c | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/security/apparmor/lib.c b/security/apparmor/lib.c
> index a630c951bb3b..01943ec184da 100644
> --- a/security/apparmor/lib.c
> +++ b/security/apparmor/lib.c
> @@ -27,7 +27,7 @@ struct aa_perms allperms = { .allow = ALL_PERMS_MASK,
>   
>   /**
>    * aa_free_str_table - free entries str table
> - * @str: the string table to free  (MAYBE NULL)
> + * @t: the string table to free  (MAYBE NULL)
>    */
>   void aa_free_str_table(struct aa_str_table *t)
>   {
> @@ -85,6 +85,7 @@ char *aa_split_fqname(char *fqname, char **ns_name)
>   /**
>    * skipn_spaces - Removes leading whitespace from @str.
>    * @str: The string to be stripped.
> + * @n: Number of spaces to be removed.
>    *
>    * Returns a pointer to the first non-whitespace character in @str.
>    * if all whitespace will return NULL
> @@ -371,7 +372,6 @@ int aa_profile_label_perm(struct aa_profile *profile, struct aa_profile *target,
>    * @profile: profile being checked
>    * @perms: perms computed for the request
>    * @request: requested perms
> - * @deny: Returns: explicit deny set
>    * @sa: initialized audit structure (MAY BE NULL if not auditing)
>    * @cb: callback fn for type specific fields (MAY BE NULL)
>    *
diff mbox series

Patch

diff --git a/security/apparmor/lib.c b/security/apparmor/lib.c
index a630c951bb3b..01943ec184da 100644
--- a/security/apparmor/lib.c
+++ b/security/apparmor/lib.c
@@ -27,7 +27,7 @@  struct aa_perms allperms = { .allow = ALL_PERMS_MASK,
 
 /**
  * aa_free_str_table - free entries str table
- * @str: the string table to free  (MAYBE NULL)
+ * @t: the string table to free  (MAYBE NULL)
  */
 void aa_free_str_table(struct aa_str_table *t)
 {
@@ -85,6 +85,7 @@  char *aa_split_fqname(char *fqname, char **ns_name)
 /**
  * skipn_spaces - Removes leading whitespace from @str.
  * @str: The string to be stripped.
+ * @n: Number of spaces to be removed.
  *
  * Returns a pointer to the first non-whitespace character in @str.
  * if all whitespace will return NULL
@@ -371,7 +372,6 @@  int aa_profile_label_perm(struct aa_profile *profile, struct aa_profile *target,
  * @profile: profile being checked
  * @perms: perms computed for the request
  * @request: requested perms
- * @deny: Returns: explicit deny set
  * @sa: initialized audit structure (MAY BE NULL if not auditing)
  * @cb: callback fn for type specific fields (MAY BE NULL)
  *