]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
docs: Use skiplist when checking sysctl admin-guide
authorJoel Granados <joel.granados@kernel.org>
Tue, 1 Jul 2025 07:55:39 +0000 (09:55 +0200)
committerJoel Granados <joel.granados@kernel.org>
Wed, 23 Jul 2025 09:57:05 +0000 (11:57 +0200)
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

index 178dcf2888ffd21845e8464fc2595052c02ff4a3..568197cb1c0a84147785f05aabbbc6ab9dd896bc 100755 (executable)
@@ -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