linux-kernel - [PATCH] eventpoll: fix sphinx documentation build warning

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20250721-epoll-sphinx-fix-v1-1-b695c92bf009@google.com>
Date: Mon, 21 Jul 2025 19:09:55 +0200
From: Jann Horn <jannh@...gle.com>
To: Alexander Viro <viro@...iv.linux.org.uk>, 
 Christian Brauner <brauner@...nel.org>
Cc: Jan Kara <jack@...e.cz>, linux-fsdevel@...r.kernel.org, 
 linux-kernel@...r.kernel.org, Stephen Rothwell <sfr@...b.auug.org.au>, 
 kernel test robot <lkp@...el.com>, Jann Horn <jannh@...gle.com>
Subject: [PATCH] eventpoll: fix sphinx documentation build warning

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@...b.auug.org.au>
Closes: https://lore.kernel.org/r/20250717173655.10ecdce6@canb.auug.org.au
Reported-by: kernel test robot <lkp@...el.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202507171958.aMcW08Cn-lkp@intel.com/
Signed-off-by: Jann Horn <jannh@...gle.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@...gle.com>