From nobody Mon Oct 6 11:55:46 2025 Received: from mail-wm1-f53.google.com (mail-wm1-f53.google.com [209.85.128.53]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 485D02E040B for ; Mon, 21 Jul 2025 17:10:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.53 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1753117839; cv=none; b=jvZia5Q7Y1OsHbyIpMeJKoqB7AiYlMbVIt1OsxWbWmXMHc6xY+HVwo65jjH78bj1bafDFQwNDkO0twKrQNkRY2CV6V4Rbx2cZQLq7AcHND+oxW+9RqOS15zvt8C6VpC1kBsiiIsQn6w1WahmNsLO6TiFz9ylUQONECwslY+H3iI= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1753117839; c=relaxed/simple; bh=Xh4LDDhwpUBvyMN0r5+ZGiNOpB9NnQTQv7jcxfOB6vE=; h=From:Date:Subject:MIME-Version:Content-Type:Message-Id:To:Cc; b=EHOZDVSLtbsc4Uc6iv3BDzjwlBPm6tBxnlOpT+cFgw8fPLTWsK62zHRQ0F2UUi/89oS7TNm3LDU4l7660jp0vcEGVNrDs1/gqMmu6l6ucAX5e65+SApjMRxVcK2EakGhUR2SZLcqEyJ/YKl0cCy3bdkDNhEvtqRly9HK28Ybpm0= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com; spf=pass smtp.mailfrom=google.com; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b=xf8j1ikU; arc=none smtp.client-ip=209.85.128.53 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=google.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="xf8j1ikU" Received: by mail-wm1-f53.google.com with SMTP id 5b1f17b1804b1-4561b43de62so4805e9.0 for ; Mon, 21 Jul 2025 10:10:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1753117835; x=1753722635; darn=vger.kernel.org; h=cc:to:message-id:content-transfer-encoding:mime-version:subject :date:from:from:to:cc:subject:date:message-id:reply-to; bh=4un8nSFBWo7E3EBvAMYaGlfkVjBQ69T4Q1lbOQwgI8A=; b=xf8j1ikU0spxG9p3TK7elw5oCpnxQhAe5ALlOF6/mulkH+K7zy404gqH/fd+lMKS+E enEZIL+RMOAW1OFoSS4t2XsJqZ5uYsXss/1JE5s9/CEwycoTtcxaJ1xKxx1INbcD1ok9 BOru1Ena/TBVkQcug8cbHDnaZ7aX8tgTFHhdGkhXB41AnQ6fkx1qqMWk0qfZmBbFnp3V o9EfYRXTPFMCa1nbQ1AIPcQ499WzlH5c7wEtk5x9VjdH+Gr2TFZxRdnTJsKuDXCQWo8z wavyKnlOIQuT6FDL5KQR3xPAeJG7mgDNY9J5pt8ZsgJlNvVmTtMBddhO94jcJA+GMYzx tNkw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1753117835; x=1753722635; h=cc:to:message-id:content-transfer-encoding:mime-version:subject :date:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=4un8nSFBWo7E3EBvAMYaGlfkVjBQ69T4Q1lbOQwgI8A=; b=hXKWqus2Yslq4lxKSBh2Kg9mcGROry4x6hx4U0je0nn060mv+Qu7IeHkGkJjPLEOJh EMlT2sIMlYwn7RfHcHPFXNCNj7kd1RPSWnmKOIKs2yDiKWWHCgwbbBpFj3cya7xVkI99 f/sLQsolhgmOJbYyWuPyfFasGuEzRVWDNJegnVh/BDWwd1husc9PxN9jiSsPRQ7cXDrj J7W1buoYbUIkddN7+z1BBNMuU4jBS57VUBGKkS1Oos21X1MaI7Iz8fq1IkPnLmyxJOo3 L3IE94N3Z0bn7IZ/AgI02PlHViubdQNWvUlmIXbWSf2tu4mBNOjLcx8CQeOs6QCOJL2v EXUA== X-Forwarded-Encrypted: i=1; AJvYcCWpgJGu/FdR1Kpt4UBIlvOJW+die7iLQt/ucadAIXviTbbl/wgwcqFEdIpJ5Ec/cv/DcCSNbBmN8xT/brk=@vger.kernel.org X-Gm-Message-State: AOJu0YyQiD3Y4i3jtC4NOS/Dmg86lP6OI9Um02itRqPmBhKZEIg88RF/ IKRTGZ258WWBqRbLeb1larSVE1JX1pEhJd8ObQevjXReEMU6aRiufrn2tOGJdqPvCA== X-Gm-Gg: ASbGncskqhmnq1/s2IKCr4fOL4hRdqatv4lVLAyDLCCabBpOdioRkWRA/v/69VwP/nV 2cxOtgRei1SjqgLvYtkVTMCCq0ig78XDl3kDs0fK0pXfBZHVGSWXwzBRPAHS0914yE2EGcaMxh2 FAjFjGRNaetjhEsNwF+E9s6LOkVLiEEBrfTSHAK/KIMrBSOlGjXHX3qGhbugtjwYROiEqDk0Ll3 PgGwKqSLsYeru55gN/oTsZ1F1dkFxUaFlxT7Zes1v98qKq864IAFTgRix/FlpWxS4qV2ug2+WpW dCpwrKsFo8XTrvw7yJ8CHVfsmYAdHveRuj4EaJ8MGbHkC142TXCbl2vH1acOjGJNvRllhqfAfuh Z/w6aJvMe0bJ6Cv4PzzlE X-Google-Smtp-Source: AGHT+IEs/FWzsXvd6aAGOTf3DNnp3qevJR4IZXlTTOL1qa+g+sj5fIyKNezQOM6bGxhgPzhVTWJfaA== X-Received: by 2002:a05:600c:6307:b0:453:672b:5b64 with SMTP id 5b1f17b1804b1-458626f3f63mr184565e9.2.1753117835315; Mon, 21 Jul 2025 10:10:35 -0700 (PDT) Received: from localhost ([2a00:79e0:9d:4:2f39:c3cf:d3aa:5466]) by smtp.gmail.com with UTF8SMTPSA id 5b1f17b1804b1-4563b74f78bsm105016005e9.27.2025.07.21.10.10.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 21 Jul 2025 10:10:34 -0700 (PDT) From: Jann Horn Date: Mon, 21 Jul 2025 19:09:55 +0200 Subject: [PATCH] eventpoll: fix sphinx documentation build warning Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Message-Id: <20250721-epoll-sphinx-fix-v1-1-b695c92bf009@google.com> X-B4-Tracking: v=1; b=H4sIAGJ0fmgC/x2MQQqAIBAAvxJ7bkEllfpKdJDackFMFCIQ/550n IGZCoUyU4FlqJDp4cJ37CDHAXbv4kXIR2dQQmlhlURKdwhYkuf44skvzlYamozTigz0LGXq+l+ uW2sfwGKW5WIAAAA= X-Change-ID: 20250721-epoll-sphinx-fix-9716e46a52e6 To: Alexander Viro , Christian Brauner Cc: Jan Kara , linux-fsdevel@vger.kernel.org, linux-kernel@vger.kernel.org, Stephen Rothwell , kernel test robot , Jann Horn X-Mailer: b4 0.15-dev X-Developer-Signature: v=1; a=ed25519-sha256; t=1753117803; l=1514; i=jannh@google.com; s=20240730; h=from:subject:message-id; bh=Xh4LDDhwpUBvyMN0r5+ZGiNOpB9NnQTQv7jcxfOB6vE=; b=1S8UD7vqp5U9+jw6Djr1PnJec8iMHJ0yaV+ATeTx2X7uvP3B3Pf1P5GEQPqcpqcIchBxI8pop NHiY3TZBJvvBlmKJ2gm+9ZM81oACuOwHJr5PVus0a8b5tFbf0h/x1BB X-Developer-Key: i=jannh@google.com; a=ed25519; pk=AljNtGOzXeF6khBXDJVVvwSEkVDGnnZZYqfWhP1V+C8= 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 Closes: https://lore.kernel.org/r/20250717173655.10ecdce6@canb.auug.org.au Reported-by: kernel test robot Closes: https://lore.kernel.org/oe-kbuild-all/202507171958.aMcW08Cn-lkp@int= el.com/ Signed-off-by: Jann Horn Acked-by: Randy Dunlap Tested-by: Randy Dunlap --- 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, i= nt depth) return result; } =20 -/** - * ep_get_upwards_depth_proc - determine depth of @ep when traversed upwar= ds - */ +/* ep_get_upwards_depth_proc - determine depth of @ep when traversed upwar= ds */ static int ep_get_upwards_depth_proc(struct eventpoll *ep, int depth) { int result =3D 0; --- base-commit: 981569a06f704ac9c4eed249f47426e1be1a5636 change-id: 20250721-epoll-sphinx-fix-9716e46a52e6 --=20 Jann Horn