[PATCH 0/2] vfs kernel-doc fixes for 6.19

[PATCH 0/2] vfs kernel-doc fixes for 6.19

[Bagas Sanjaya]

Hi,

Here are kernel-doc fixes for vfs subsystem targetting 6.19. This small
series is split from much larger kernel-doc fixes series I posted a while
ago [1].

Enjoy!

[1]: https://lore.kernel.org/linux-fsdevel/20251215113903.46555-1-bagasdotme@gmail.com/

Bagas Sanjaya (2):
  fs: Describe @isnew parameter in ilookup5_nowait()
  VFS: fix __start_dirop() kernel-doc warnings

 fs/inode.c | 3 +++
 fs/namei.c | 3 ++-
 2 files changed, 5 insertions(+), 1 deletion(-)


base-commit: 24835a96f21ebb295d24e265b5466d9e40f12cbd
-- 
An old man doll... just what I always wanted! - Clara

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

[Bagas Sanjaya]

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

[PATCH 2/2] VFS: fix __start_dirop() kernel-doc warnings

[Bagas Sanjaya]

Sphinx report kernel-doc warnings:

WARNING: ./fs/namei.c:2853 function parameter 'state' not described in '__start_dirop'
WARNING: ./fs/namei.c:2853 expecting prototype for start_dirop(). Prototype was for __start_dirop() instead

Fix them up.

Fixes: ff7c4ea11a05c8 ("VFS: add start_creating_killable() and start_removing_killable()")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 fs/namei.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/fs/namei.c b/fs/namei.c
index bf0f66f0e9b92c..91fd3a786704e2 100644
--- a/fs/namei.c
+++ b/fs/namei.c
@@ -2836,10 +2836,11 @@ static int filename_parentat(int dfd, struct filename *name,
 }
 
 /**
- * start_dirop - begin a create or remove dirop, performing locking and lookup
+ * __start_dirop - begin a create or remove dirop, performing locking and lookup
  * @parent:       the dentry of the parent in which the operation will occur
  * @name:         a qstr holding the name within that parent
  * @lookup_flags: intent and other lookup flags.
+ * @state:        task state bitmask
  *
  * The lookup is performed and necessary locks are taken so that, on success,
  * the returned dentry can be operated on safely.
-- 
An old man doll... just what I always wanted! - Clara

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

[Jan Kara]

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

Re: [PATCH 2/2] VFS: fix __start_dirop() kernel-doc warnings

[Jan Kara]

On Fri 19-12-25 09:46:20, Bagas Sanjaya wrote:
> Sphinx report kernel-doc warnings:
> 
> WARNING: ./fs/namei.c:2853 function parameter 'state' not described in '__start_dirop'
> WARNING: ./fs/namei.c:2853 expecting prototype for start_dirop(). Prototype was for __start_dirop() instead
> 
> Fix them up.
> 
> Fixes: ff7c4ea11a05c8 ("VFS: add start_creating_killable() and start_removing_killable()")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Looks good. Feel free to add:

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

								Honza

> ---
>  fs/namei.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/fs/namei.c b/fs/namei.c
> index bf0f66f0e9b92c..91fd3a786704e2 100644
> --- a/fs/namei.c
> +++ b/fs/namei.c
> @@ -2836,10 +2836,11 @@ static int filename_parentat(int dfd, struct filename *name,
>  }
>  
>  /**
> - * start_dirop - begin a create or remove dirop, performing locking and lookup
> + * __start_dirop - begin a create or remove dirop, performing locking and lookup
>   * @parent:       the dentry of the parent in which the operation will occur
>   * @name:         a qstr holding the name within that parent
>   * @lookup_flags: intent and other lookup flags.
> + * @state:        task state bitmask
>   *
>   * The lookup is performed and necessary locks are taken so that, on success,
>   * the returned dentry can be operated on safely.
> -- 
> An old man doll... just what I always wanted! - Clara
> 
-- 
Jan Kara <jack@suse.com>
SUSE Labs, CR

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

[Jeff Layton]

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 2/2] VFS: fix __start_dirop() kernel-doc warnings

[Jeff Layton]

On Fri, 2025-12-19 at 09:46 +0700, Bagas Sanjaya wrote:
> Sphinx report kernel-doc warnings:
> 
> WARNING: ./fs/namei.c:2853 function parameter 'state' not described in '__start_dirop'
> WARNING: ./fs/namei.c:2853 expecting prototype for start_dirop(). Prototype was for __start_dirop() instead
> 
> Fix them up.
> 
> Fixes: ff7c4ea11a05c8 ("VFS: add start_creating_killable() and start_removing_killable()")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  fs/namei.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/fs/namei.c b/fs/namei.c
> index bf0f66f0e9b92c..91fd3a786704e2 100644
> --- a/fs/namei.c
> +++ b/fs/namei.c
> @@ -2836,10 +2836,11 @@ static int filename_parentat(int dfd, struct filename *name,
>  }
>  
>  /**
> - * start_dirop - begin a create or remove dirop, performing locking and lookup
> + * __start_dirop - begin a create or remove dirop, performing locking and lookup
>   * @parent:       the dentry of the parent in which the operation will occur
>   * @name:         a qstr holding the name within that parent
>   * @lookup_flags: intent and other lookup flags.
> + * @state:        task state bitmask
>   *
>   * The lookup is performed and necessary locks are taken so that, on success,
>   * the returned dentry can be operated on safely.

Reviewed-by: Jeff Layton <jlayton@kernel.org>

Re: [PATCH 0/2] vfs kernel-doc fixes for 6.19

[Christian Brauner]

On Fri, 19 Dec 2025 09:46:18 +0700, Bagas Sanjaya wrote:
> Here are kernel-doc fixes for vfs subsystem targetting 6.19. This small
> series is split from much larger kernel-doc fixes series I posted a while
> ago [1].
> 
> Enjoy!
> 
> [1]: https://lore.kernel.org/linux-fsdevel/20251215113903.46555-1-bagasdotme@gmail.com/
> 
> [...]

Applied to the vfs.fixes branch of the vfs/vfs.git tree.
Patches in the vfs.fixes branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs.fixes

[1/2] fs: Describe @isnew parameter in ilookup5_nowait()
      https://git.kernel.org/vfs/vfs/c/fe33729d2907
[2/2] VFS: fix __start_dirop() kernel-doc warnings
      https://git.kernel.org/vfs/vfs/c/73a91ef328a9

Re: [PATCH 2/2] VFS: fix __start_dirop() kernel-doc warnings

[NeilBrown]

On Fri, 19 Dec 2025, Bagas Sanjaya wrote:
> Sphinx report kernel-doc warnings:
> 
> WARNING: ./fs/namei.c:2853 function parameter 'state' not described in '__start_dirop'
> WARNING: ./fs/namei.c:2853 expecting prototype for start_dirop(). Prototype was for __start_dirop() instead
> 
> Fix them up.
> 
> Fixes: ff7c4ea11a05c8 ("VFS: add start_creating_killable() and start_removing_killable()")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  fs/namei.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/fs/namei.c b/fs/namei.c
> index bf0f66f0e9b92c..91fd3a786704e2 100644
> --- a/fs/namei.c
> +++ b/fs/namei.c
> @@ -2836,10 +2836,11 @@ static int filename_parentat(int dfd, struct filename *name,
>  }
>  
>  /**
> - * start_dirop - begin a create or remove dirop, performing locking and lookup
> + * __start_dirop - begin a create or remove dirop, performing locking and lookup
>   * @parent:       the dentry of the parent in which the operation will occur
>   * @name:         a qstr holding the name within that parent
>   * @lookup_flags: intent and other lookup flags.
> + * @state:        task state bitmask

I would really rather the doco comment was moved to be before
start_dirop(), and left unchanged.

Otherwise we would really need to actually docoument "@state", not just
add vague words to shut the checker up.

There was already been a patch posted to do this.

NeilBrown


>   *
>   * The lookup is performed and necessary locks are taken so that, on success,
>   * the returned dentry can be operated on safely.
> -- 
> An old man doll... just what I always wanted! - Clara
> 
> 

Re: [PATCH 0/2] vfs kernel-doc fixes for 6.19

[Christian Brauner]

On Fri, 19 Dec 2025 09:46:18 +0700, Bagas Sanjaya wrote:
> Here are kernel-doc fixes for vfs subsystem targetting 6.19. This small
> series is split from much larger kernel-doc fixes series I posted a while
> ago [1].
> 
> Enjoy!
> 
> [1]: https://lore.kernel.org/linux-fsdevel/20251215113903.46555-1-bagasdotme@gmail.com/
> 
> [...]

Applied to the vfs-7.0.misc branch of the vfs/vfs.git tree.
Patches in the vfs-7.0.misc branch should appear in linux-next soon.

Please report any outstanding bugs that were missed during review in a
new review to the original patch series allowing us to drop it.

It's encouraged to provide Acked-bys and Reviewed-bys even though the
patch has now been applied. If possible patch trailers will be updated.

Note that commit hashes shown below are subject to change due to rebase,
trailer updates or similar. If in doubt, please check the listed branch.

tree:   https://git.kernel.org/pub/scm/linux/kernel/git/vfs/vfs.git
branch: vfs-7.0.misc

[1/2] fs: Describe @isnew parameter in ilookup5_nowait()
      https://git.kernel.org/vfs/vfs/c/b0f5804b4178
[2/2] VFS: fix __start_dirop() kernel-doc warnings
      https://git.kernel.org/vfs/vfs/c/ba4c74f80ef3