linux-kernel - Re: [PATCH] vfs: inode insertion kdoc corrections

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: <20241004122756.3szmzyetiir435ua@quack3>
Date: Fri, 4 Oct 2024 14:27:56 +0200
From: Jan Kara <jack@...e.cz>
To: Andreas Gruenbacher <agruenba@...hat.com>
Cc: Christian Brauner <brauner@...nel.org>,
	Alexander Viro <viro@...iv.linux.org.uk>, Jan Kara <jack@...e.cz>,
	linux-fsdevel@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] vfs: inode insertion kdoc corrections

On Fri 04-10-24 13:51:51, Andreas Gruenbacher wrote:
> Some minor corrections to the inode_insert5 and iget5_locked kernel
> documentation.
> 
> Signed-off-by: Andreas Gruenbacher <agruenba@...hat.com>

Looks good. Feel free to add:

Reviewed-by: Jan Kara <jack@...e.cz>

								Honza

> ---
>  fs/inode.c | 25 ++++++++++++-------------
>  1 file changed, 12 insertions(+), 13 deletions(-)
> 
> diff --git a/fs/inode.c b/fs/inode.c
> index 471ae4a31549..6b3ff38df7f7 100644
> --- a/fs/inode.c
> +++ b/fs/inode.c
> @@ -1239,16 +1239,15 @@ EXPORT_SYMBOL(unlock_two_nondirectories);
>   * @data:	opaque data pointer to pass to @test and @set
>   *
>   * Search for the inode specified by @hashval and @data in the inode cache,
> - * and if present it is return it with an increased reference count. This is
> - * a variant of iget5_locked() for callers that don't want to fail on memory
> - * allocation of inode.
> + * and if present return it with an increased reference count. This is a
> + * variant of iget5_locked() that doesn't allocate an inode.
>   *
> - * If the inode is not in cache, insert the pre-allocated inode to cache and
> + * If the inode is not present in the cache, insert the pre-allocated inode and
>   * return it locked, hashed, and with the I_NEW flag set. The file system gets
>   * to fill it in before unlocking it via unlock_new_inode().
>   *
> - * Note both @test and @set are called with the inode_hash_lock held, so can't
> - * sleep.
> + * Note that both @test and @set are called with the inode_hash_lock held, so
> + * they can't sleep.
>   */
>  struct inode *inode_insert5(struct inode *inode, unsigned long hashval,
>  			    int (*test)(struct inode *, void *),
> @@ -1312,16 +1311,16 @@ EXPORT_SYMBOL(inode_insert5);
>   * @data:	opaque data pointer to pass to @test and @set
>   *
>   * Search for the inode specified by @hashval and @data in the inode cache,
> - * and if present it is return it with an increased reference count. This is
> - * a generalized version of iget_locked() for file systems where the inode
> + * and if present return it with an increased reference count. This is a
> + * generalized version of iget_locked() for file systems where the inode
>   * number is not sufficient for unique identification of an inode.
>   *
> - * If the inode is not in cache, allocate a new inode and return it locked,
> - * hashed, and with the I_NEW flag set. The file system gets to fill it in
> - * before unlocking it via unlock_new_inode().
> + * If the inode is not present in the cache, allocate and insert a new inode
> + * and return it locked, hashed, and with the I_NEW flag set. The file system
> + * gets to fill it in before unlocking it via unlock_new_inode().
>   *
> - * Note both @test and @set are called with the inode_hash_lock held, so can't
> - * sleep.
> + * Note that both @test and @set are called with the inode_hash_lock held, so
> + * they can't sleep.
>   */
>  struct inode *iget5_locked(struct super_block *sb, unsigned long hashval,
>  		int (*test)(struct inode *, void *),
> -- 
> 2.46.1
> 
-- 
Jan Kara <jack@...e.com>
SUSE Labs, CR