Skip to content

Commit ecb6cc0

Browse files
thejhbrauner
authored andcommitted
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: 22bacca ("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> Link: https://lore.kernel.org/20250721-epoll-sphinx-fix-v1-1-b695c92bf009@google.com Tested-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Christian Brauner <brauner@kernel.org>
1 parent 981569a commit ecb6cc0

1 file changed

Lines changed: 1 addition & 3 deletions

File tree

fs/eventpoll.c

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2192,9 +2192,7 @@ static int ep_loop_check_proc(struct eventpoll *ep, int depth)
21922192
return result;
21932193
}
21942194

2195-
/**
2196-
* ep_get_upwards_depth_proc - determine depth of @ep when traversed upwards
2197-
*/
2195+
/* ep_get_upwards_depth_proc - determine depth of @ep when traversed upwards */
21982196
static int ep_get_upwards_depth_proc(struct eventpoll *ep, int depth)
21992197
{
22002198
int result = 0;

0 commit comments

Comments
 (0)