diff options
| author | Joel Granados <joel.granados@kernel.org> | 2025-07-01 09:55:39 +0200 |
|---|---|---|
| committer | Joel Granados <joel.granados@kernel.org> | 2025-07-23 11:57:05 +0200 |
| commit | be0aef10dca87a644affb087f01728386c19903a (patch) | |
| tree | 5690d1265f8a648569e6ca6dc93593f3e954c7f1 /scripts | |
| parent | 89b491bcf2d19516dd19b1f7a8872394a58b591b (diff) | |
docs: Use skiplist when checking sysctl admin-guide
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>
Diffstat (limited to 'scripts')
| -rwxr-xr-x | scripts/check-sysctl-docs | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/scripts/check-sysctl-docs b/scripts/check-sysctl-docs index 178dcf2888ff..568197cb1c0a 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 |