Re: [PATCH 07/14] fs: Describe @isnew parameter in ilookup5_nowait()

[Jan Kara]

On Mon 15-12-25 18:38:55, 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@xxxxxxxxx>

...

> @@ -1593,6 +1593,7 @@ 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:	whether the inode is new or not

I'm sorry but this is true but misleading at the same time. I'd write there
something like:

 * @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).


								Honza
-- 
Jan Kara <jack@xxxxxxxx>
SUSE Labs, CR