[PATCH] eventpoll: fix sphinx documentation build warning

[PATCH] eventpoll: fix sphinx documentation build warning

[Jann Horn]

Sphinx complains that ep_get_upwards_depth_proc() has a kerneldoc-style
comment without documenting its parameters.
This is an internal function that was not meant to show up in kernel
documentation, so fix the warning by changing the comment to a
non-kerneldoc one.

Fixes: 22bacca48a17 ("epoll: prevent creating circular epoll structures")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/r/20250717173655.10ecdce6@canb.auug.org.au
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202507171958.aMcW08Cn-lkp@intel.com/
Signed-off-by: Jann Horn <jannh@google.com>
---
This should go on the vfs misc branch. (Feel free to squash it or not,
idk how you do that in the VFS tree.)
---
 fs/eventpoll.c | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/fs/eventpoll.c b/fs/eventpoll.c
index 44648cc09250..02ac05322b1b 100644
--- a/fs/eventpoll.c
+++ b/fs/eventpoll.c
@@ -2192,9 +2192,7 @@ static int ep_loop_check_proc(struct eventpoll *ep, int depth)
 	return result;
 }
 
-/**
- * ep_get_upwards_depth_proc - determine depth of @ep when traversed upwards
- */
+/* ep_get_upwards_depth_proc - determine depth of @ep when traversed upwards */
 static int ep_get_upwards_depth_proc(struct eventpoll *ep, int depth)
 {
 	int result = 0;

---
base-commit: 981569a06f704ac9c4eed249f47426e1be1a5636
change-id: 20250721-epoll-sphinx-fix-9716e46a52e6

-- 
Jann Horn <jannh@google.com>

Re: [PATCH] eventpoll: fix sphinx documentation build warning

[Randy Dunlap]

On 7/21/25 10:09 AM, Jann Horn wrote:
> Sphinx complains that ep_get_upwards_depth_proc() has a kerneldoc-style
> comment without documenting its parameters.
> This is an internal function that was not meant to show up in kernel
> documentation, so fix the warning by changing the comment to a
> non-kerneldoc one.
> 
> Fixes: 22bacca48a17 ("epoll: prevent creating circular epoll structures")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/r/20250717173655.10ecdce6@canb.auug.org.au
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202507171958.aMcW08Cn-lkp@intel.com/
> Signed-off-by: Jann Horn <jannh@google.com>
> ---
> This should go on the vfs misc branch. (Feel free to squash it or not,
> idk how you do that in the VFS tree.)


Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  fs/eventpoll.c | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/fs/eventpoll.c b/fs/eventpoll.c
> index 44648cc09250..02ac05322b1b 100644
> --- a/fs/eventpoll.c
> +++ b/fs/eventpoll.c
> @@ -2192,9 +2192,7 @@ static int ep_loop_check_proc(struct eventpoll *ep, int depth)
>  	return result;
>  }
>  
> -/**
> - * ep_get_upwards_depth_proc - determine depth of @ep when traversed upwards
> - */
> +/* ep_get_upwards_depth_proc - determine depth of @ep when traversed upwards */
>  static int ep_get_upwards_depth_proc(struct eventpoll *ep, int depth)
>  {
>  	int result = 0;
> 
> ---
> base-commit: 981569a06f704ac9c4eed249f47426e1be1a5636
> change-id: 20250721-epoll-sphinx-fix-9716e46a52e6
> 

-- 
~Randy

Re: [PATCH] eventpoll: fix sphinx documentation build warning

[Christian Brauner]

On Mon, 21 Jul 2025 19:09:55 +0200, Jann Horn wrote:
> Sphinx complains that ep_get_upwards_depth_proc() has a kerneldoc-style
> comment without documenting its parameters.
> This is an internal function that was not meant to show up in kernel
> documentation, so fix the warning by changing the comment to a
> non-kerneldoc one.
> 
> 
> [...]

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

[1/1] eventpoll: fix sphinx documentation build warning
      https://git.kernel.org/vfs/vfs/c/ecb6cc0fd8cd