[PATCH] nstree: fix kernel-doc comments for internal functions

[PATCH] nstree: fix kernel-doc comments for internal functions

[Kriish Sharma]

Documentation build reported:

  Warning: kernel/nstree.c:325 function parameter 'ns_tree' not described in '__ns_tree_adjoined_rcu'
  Warning: kernel/nstree.c:325 expecting prototype for ns_tree_adjoined_rcu(). Prototype was for __ns_tree_adjoined_rcu() instead
  Warning: kernel/nstree.c:353 expecting prototype for ns_tree_gen_id(). Prototype was for __ns_tree_gen_id() instead

The kernel-doc comments for `__ns_tree_adjoined_rcu()` and
`__ns_tree_gen_id()` had mismatched function names and a missing
parameter description. This patch updates the function names in the
kernel-doc headers and adds the missing `@ns_tree` parameter description
for `__ns_tree_adjoined_rcu()`.

Fixes: 885fc8ac0a4d ("nstree: make iterator generic")
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202511061542.0LO7xKs8-lkp@intel.com
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
---
 kernel/nstree.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/kernel/nstree.c b/kernel/nstree.c
index 4a8838683b6b..23af5cd04c86 100644
--- a/kernel/nstree.c
+++ b/kernel/nstree.c
@@ -313,9 +313,10 @@ struct ns_common *ns_tree_lookup_rcu(u64 ns_id, int ns_type)
 }
 
 /**
- * ns_tree_adjoined_rcu - find the next/previous namespace in the same
+ * __ns_tree_adjoined_rcu - find the next/previous namespace in the same
  * tree
  * @ns: namespace to start from
+ * @ns_tree: namespace tree to search in
  * @previous: if true find the previous namespace, otherwise the next
  *
  * Find the next or previous namespace in the same tree as @ns. If
@@ -341,7 +342,7 @@ struct ns_common *__ns_tree_adjoined_rcu(struct ns_common *ns,
 }
 
 /**
- * ns_tree_gen_id - generate a new namespace id
+ * __ns_tree_gen_id - generate a new namespace id
  * @ns: namespace to generate id for
  * @id: if non-zero, this is the initial namespace and this is a fixed id
  *
-- 
2.34.1

Re: [PATCH] nstree: fix kernel-doc comments for internal functions

[Christian Brauner]

On Tue, 11 Nov 2025 11:25:33 +0000, Kriish Sharma wrote:
> Documentation build reported:
> 
>   Warning: kernel/nstree.c:325 function parameter 'ns_tree' not described in '__ns_tree_adjoined_rcu'
>   Warning: kernel/nstree.c:325 expecting prototype for ns_tree_adjoined_rcu(). Prototype was for __ns_tree_adjoined_rcu() instead
>   Warning: kernel/nstree.c:353 expecting prototype for ns_tree_gen_id(). Prototype was for __ns_tree_gen_id() instead
> 
> The kernel-doc comments for `__ns_tree_adjoined_rcu()` and
> `__ns_tree_gen_id()` had mismatched function names and a missing
> parameter description. This patch updates the function names in the
> kernel-doc headers and adds the missing `@ns_tree` parameter description
> for `__ns_tree_adjoined_rcu()`.
> 
> [...]

Applied to the namespace-6.19 branch of the vfs/vfs.git tree.
Patches in the namespace-6.19 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: namespace-6.19

[1/1] nstree: fix kernel-doc comments for internal functions
      https://git.kernel.org/vfs/vfs/c/05518c2e7132