[PATCH] security/smack/smackfs: small kernel-doc fixes

[PATCH] security/smack/smackfs: small kernel-doc fixes

[Randy Dunlap]

Add function short descriptions to the kernel-doc where missing.
Correct a verb and add ending periods to sentences.

smackfs.c:1080: warning: missing initial short description on line:
 * smk_net4addr_insert
smackfs.c:1343: warning: missing initial short description on line:
 * smk_net6addr_insert

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Casey Schaufler <casey@schaufler-ca.com>
Cc: linux-security-module@vger.kernel.org
Cc: Paul Moore <paul@paul-moore.com>
Cc: James Morris <jmorris@namei.org>
Cc: "Serge E. Hallyn" <serge@hallyn.com>
---
 security/smack/smackfs.c |   12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

--- linux-next-20250501.orig/security/smack/smackfs.c
+++ linux-next-20250501/security/smack/smackfs.c
@@ -1077,13 +1077,12 @@ static int smk_open_net4addr(struct inod
 }
 
 /**
- * smk_net4addr_insert
+ * smk_net4addr_insert - insert a new entry into the net4addrs list
  * @new : netlabel to insert
  *
- * This helper insert netlabel in the smack_net4addrs list
+ * This helper inserts netlabel in the smack_net4addrs list
  * sorted by netmask length (longest to smallest)
- * locked by &smk_net4addr_lock in smk_write_net4addr
- *
+ * locked by &smk_net4addr_lock in smk_write_net4addr.
  */
 static void smk_net4addr_insert(struct smk_net4addr *new)
 {
@@ -1340,13 +1339,12 @@ static int smk_open_net6addr(struct inod
 }
 
 /**
- * smk_net6addr_insert
+ * smk_net6addr_insert - insert a new entry into the net6addrs list
  * @new : entry to insert
  *
  * This inserts an entry in the smack_net6addrs list
  * sorted by netmask length (longest to smallest)
- * locked by &smk_net6addr_lock in smk_write_net6addr
- *
+ * locked by &smk_net6addr_lock in smk_write_net6addr.
  */
 static void smk_net6addr_insert(struct smk_net6addr *new)
 {

Re: [PATCH] security/smack/smackfs: small kernel-doc fixes

[Casey Schaufler]

On 5/1/2025 6:44 PM, Randy Dunlap wrote:
> Add function short descriptions to the kernel-doc where missing.
> Correct a verb and add ending periods to sentences.
>
> smackfs.c:1080: warning: missing initial short description on line:
>  * smk_net4addr_insert
> smackfs.c:1343: warning: missing initial short description on line:
>  * smk_net6addr_insert
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

I'll take this. Thank you.

> Cc: Casey Schaufler <casey@schaufler-ca.com>
> Cc: linux-security-module@vger.kernel.org
> Cc: Paul Moore <paul@paul-moore.com>
> Cc: James Morris <jmorris@namei.org>
> Cc: "Serge E. Hallyn" <serge@hallyn.com>
> ---
>  security/smack/smackfs.c |   12 +++++-------
>  1 file changed, 5 insertions(+), 7 deletions(-)
>
> --- linux-next-20250501.orig/security/smack/smackfs.c
> +++ linux-next-20250501/security/smack/smackfs.c
> @@ -1077,13 +1077,12 @@ static int smk_open_net4addr(struct inod
>  }
>  
>  /**
> - * smk_net4addr_insert
> + * smk_net4addr_insert - insert a new entry into the net4addrs list
>   * @new : netlabel to insert
>   *
> - * This helper insert netlabel in the smack_net4addrs list
> + * This helper inserts netlabel in the smack_net4addrs list
>   * sorted by netmask length (longest to smallest)
> - * locked by &smk_net4addr_lock in smk_write_net4addr
> - *
> + * locked by &smk_net4addr_lock in smk_write_net4addr.
>   */
>  static void smk_net4addr_insert(struct smk_net4addr *new)
>  {
> @@ -1340,13 +1339,12 @@ static int smk_open_net6addr(struct inod
>  }
>  
>  /**
> - * smk_net6addr_insert
> + * smk_net6addr_insert - insert a new entry into the net6addrs list
>   * @new : entry to insert
>   *
>   * This inserts an entry in the smack_net6addrs list
>   * sorted by netmask length (longest to smallest)
> - * locked by &smk_net6addr_lock in smk_write_net6addr
> - *
> + * locked by &smk_net6addr_lock in smk_write_net6addr.
>   */
>  static void smk_net6addr_insert(struct smk_net6addr *new)
>  {
>