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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <774bce75-551e-486d-9e35-16da3cb962bb@schaufler-ca.com>
Date: Fri, 2 May 2025 08:50:35 -0700
From: Casey Schaufler <casey@...aufler-ca.com>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: linux-security-module@...r.kernel.org, Paul Moore <paul@...l-moore.com>,
 James Morris <jmorris@...ei.org>, "Serge E. Hallyn" <serge@...lyn.com>,
 Casey Schaufler <casey@...aufler-ca.com>
Subject: Re: [PATCH] security/smack/smackfs: small kernel-doc fixes

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@...radead.org>

I'll take this. Thank you.

> Cc: Casey Schaufler <casey@...aufler-ca.com>
> Cc: linux-security-module@...r.kernel.org
> Cc: Paul Moore <paul@...l-moore.com>
> Cc: James Morris <jmorris@...ei.org>
> Cc: "Serge E. Hallyn" <serge@...lyn.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)
>  {
>