From: Joel Granados <joel.granados@kernel.org>
To: Kees Cook <kees@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
Paul Walmsley <paul.walmsley@sifive.com>,
Palmer Dabbelt <palmer@dabbelt.com>,
Albert Ou <aou@eecs.berkeley.edu>,
Alexandre Ghiti <alex@ghiti.fr>
Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org,
linux-doc@vger.kernel.org, linux-riscv@lists.infradead.org,
Joel Granados <joel.granados@kernel.org>
Subject: [PATCH 2/6] docs: Use skiplist when checking sysctl admin-guide
Date: Tue, 01 Jul 2025 10:56:43 +0200 [thread overview]
Message-ID: <20250701-jag-sysctldoc-v1-2-936912553f58@kernel.org> (raw)
In-Reply-To: <20250701-jag-sysctldoc-v1-0-936912553f58@kernel.org>
Use a skiplist to "skip" the titles in the guide documentation
(Documentation/admin-guide/sysctl/*) that are not sysctls. This will
give a more accurate account of what sysctl are miss-documented.
Signed-off-by: Joel Granados <joel.granados@kernel.org>
---
scripts/check-sysctl-docs | 21 +++++++++++++++++----
1 file changed, 17 insertions(+), 4 deletions(-)
diff --git a/scripts/check-sysctl-docs b/scripts/check-sysctl-docs
index 178dcf2888ffd21845e8464fc2595052c02ff4a3..568197cb1c0a84147785f05aabbbc6ab9dd896bc 100755
--- a/scripts/check-sysctl-docs
+++ b/scripts/check-sysctl-docs
@@ -17,6 +17,18 @@ BEGIN {
print "Please specify the table to look for using the table variable" > "/dev/stderr"
exit 1
}
+
+ # Documentation title skiplist
+ skiplist[0] = "^Documentation for"
+ skiplist[1] = "Network core options$"
+ skiplist[2] = "POSIX message queues filesystem$"
+ skiplist[3] = "Configuration options"
+ skiplist[4] = ". /proc/sys/fs"
+ skiplist[5] = "^Introduction$"
+ skiplist[6] = "^seccomp$"
+ skiplist[7] = "^pty$"
+ skiplist[8] = "^firmware_config$"
+ skiplist[9] = "^random$"
}
# The following globals are used:
@@ -53,10 +65,11 @@ function printentry(entry) {
# Stage 1: build the list of documented entries
FNR == NR && /^=+$/ {
- if (prevline ~ /Documentation for/) {
- # This is the main title
- next
- }
+ for (i in skiplist) {
+ if (prevline ~ skiplist[i]) {
+ next
+ }
+ }
# The previous line is a section title, parse it
$0 = prevline
--
2.47.2
next prev parent reply other threads:[~2025-07-01 8:57 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-01 8:56 [PATCH 0/6] docs: Remove false positives from check-sysctl-docs Joel Granados
2025-07-01 8:56 ` [PATCH 1/6] docs: nixify check-sysctl-docs Joel Granados
2025-07-01 8:56 ` Joel Granados [this message]
2025-07-01 8:56 ` [PATCH 3/6] docs: Add awk section for ucount sysctl entries Joel Granados
2025-07-01 8:56 ` [PATCH 4/6] docs: Remove colon from ctltable title in vm.rst Joel Granados
2025-07-01 8:56 ` [PATCH 5/6] docs: Replace spaces with tabs in check-sysctl-docs Joel Granados
2025-07-01 8:56 ` [PATCH 6/6] docs: Downgrade arm64 & riscv from titles to comment Joel Granados
2025-08-10 21:12 ` [PATCH 0/6] docs: Remove false positives from check-sysctl-docs patchwork-bot+linux-riscv
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250701-jag-sysctldoc-v1-2-936912553f58@kernel.org \
--to=joel.granados@kernel.org \
--cc=alex@ghiti.fr \
--cc=aou@eecs.berkeley.edu \
--cc=corbet@lwn.net \
--cc=kees@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fsdevel@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-riscv@lists.infradead.org \
--cc=palmer@dabbelt.com \
--cc=paul.walmsley@sifive.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).