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 <[email protected]> Closes: https://lore.kernel.org/r/[email protected] Reported-by: kernel test robot <[email protected]> Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/ Signed-off-by: Jann Horn <[email protected]> Link: https://lore.kernel.org/[email protected] Tested-by: Randy Dunlap <[email protected]> Acked-by: Randy Dunlap <[email protected]> Signed-off-by: Christian Brauner <[email protected]>
1 parent 981569a commit ecb6cc0

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

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)