From: Filip Kastl <fkastl@suse.cz>
Date: Wed, 18 Sep 2024 14:38:30 +0000 (+0200)
Subject: contrib: Set check-params-in-docs.py to skip tables of values of a param
X-Git-Tag: basepoints/gcc-16~5863
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4b7e6d5faa137f18a36d8c6323a8640e61ee48f1;p=thirdparty%2Fgcc.git

contrib: Set check-params-in-docs.py to skip tables of values of a param

Currently check-params-in-docs.py reports extra params being listed in
invoke.texi.  However, those aren't actual params but items in a table of
possible values of the aarch64-autove-preference param.

This patch changes check-params-in-docs.py to ignore similar tables.

contrib/ChangeLog:

	* check-params-in-docs.py: Skip tables of values of a param.
	Remove code that skips items beginning with a number.

Signed-off-by: Filip Kastl <fkastl@suse.cz>
---

diff --git a/contrib/check-params-in-docs.py b/contrib/check-params-in-docs.py
index ccdb8d72169..102f0e64e98 100755
--- a/contrib/check-params-in-docs.py
+++ b/contrib/check-params-in-docs.py
@@ -66,14 +66,23 @@ texi = takewhile(lambda x: '@node Instrumentation Options' not in x, texi)
 texi = list(texi)[1:]
 
 texi_params = []
+skip = False
 for line in texi:
+    # Skip @table @samp sections of manual where values of a param are usually
+    # listed
+    if skip:
+        if line.startswith('@end table'):
+            skip = False
+        continue
+    elif line.startswith('@table @samp'):
+        skip = True
+        continue
+
     for token in ('@item ', '@itemx '):
         if line.startswith(token):
             texi_params.append(line[len(token):])
             break
 
-# Skip digits
-texi_params = [x for x in texi_params if not x[0].isdigit()]
 # Skip target-specific params
 texi_params = [x for x in texi_params if not target_specific(x)]