[PATCH 1/2] fs: Describe @isnew parameter in ilookup5_nowait()

Bagas Sanjaya posted 2 patches 1 month, 3 weeks ago
[PATCH 1/2] fs: Describe @isnew parameter in ilookup5_nowait()
Posted by Bagas Sanjaya 1 month, 3 weeks ago
Sphinx reports kernel-doc warning:

WARNING: ./fs/inode.c:1607 function parameter 'isnew' not described in 'ilookup5_nowait'

Describe the parameter.

Fixes: a27628f4363435 ("fs: rework I_NEW handling to operate without fences")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 fs/inode.c | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/fs/inode.c b/fs/inode.c
index 521383223d8a45..379f4c19845c95 100644
--- a/fs/inode.c
+++ b/fs/inode.c
@@ -1593,6 +1593,9 @@ EXPORT_SYMBOL(igrab);
  * @hashval:	hash value (usually inode number) to search for
  * @test:	callback used for comparisons between inodes
  * @data:	opaque data pointer to pass to @test
+ * @isnew:	return argument telling whether I_NEW was set when
+ *		the inode was found in hash (the caller needs to
+ *		wait for I_NEW to clear)
  *
  * Search for the inode specified by @hashval and @data in the inode cache.
  * If the inode is in the cache, the inode is returned with an incremented
-- 
An old man doll... just what I always wanted! - Clara
Re: [PATCH 1/2] fs: Describe @isnew parameter in ilookup5_nowait()
Posted by Jeff Layton 1 month, 2 weeks ago
On Fri, 2025-12-19 at 09:46 +0700, Bagas Sanjaya wrote:
> Sphinx reports kernel-doc warning:
> 
> WARNING: ./fs/inode.c:1607 function parameter 'isnew' not described in 'ilookup5_nowait'
> 
> Describe the parameter.
> 
> Fixes: a27628f4363435 ("fs: rework I_NEW handling to operate without fences")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  fs/inode.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/fs/inode.c b/fs/inode.c
> index 521383223d8a45..379f4c19845c95 100644
> --- a/fs/inode.c
> +++ b/fs/inode.c
> @@ -1593,6 +1593,9 @@ EXPORT_SYMBOL(igrab);
>   * @hashval:	hash value (usually inode number) to search for
>   * @test:	callback used for comparisons between inodes
>   * @data:	opaque data pointer to pass to @test
> + * @isnew:	return argument telling whether I_NEW was set when
> + *		the inode was found in hash (the caller needs to
> + *		wait for I_NEW to clear)
>   *
>   * Search for the inode specified by @hashval and @data in the inode cache.
>   * If the inode is in the cache, the inode is returned with an incremented

Reviewed-by: Jeff Layton <jlayton@kernel.org>
Re: [PATCH 1/2] fs: Describe @isnew parameter in ilookup5_nowait()
Posted by Jan Kara 1 month, 2 weeks ago
On Fri 19-12-25 09:46:19, Bagas Sanjaya wrote:
> Sphinx reports kernel-doc warning:
> 
> WARNING: ./fs/inode.c:1607 function parameter 'isnew' not described in 'ilookup5_nowait'
> 
> Describe the parameter.
> 
> Fixes: a27628f4363435 ("fs: rework I_NEW handling to operate without fences")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Looks good. Feel free to add:

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

								Honza

> ---
>  fs/inode.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/fs/inode.c b/fs/inode.c
> index 521383223d8a45..379f4c19845c95 100644
> --- a/fs/inode.c
> +++ b/fs/inode.c
> @@ -1593,6 +1593,9 @@ EXPORT_SYMBOL(igrab);
>   * @hashval:	hash value (usually inode number) to search for
>   * @test:	callback used for comparisons between inodes
>   * @data:	opaque data pointer to pass to @test
> + * @isnew:	return argument telling whether I_NEW was set when
> + *		the inode was found in hash (the caller needs to
> + *		wait for I_NEW to clear)
>   *
>   * Search for the inode specified by @hashval and @data in the inode cache.
>   * If the inode is in the cache, the inode is returned with an incremented
> -- 
> An old man doll... just what I always wanted! - Clara
> 
-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR