https://gcc.gnu.org/g:4b7e6d5faa137f18a36d8c6323a8640e61ee48f1
commit r15-3690-g4b7e6d5faa137f18a36d8c6323a8640e61ee48f1
Author: Filip Kastl <fka...@suse.cz>
Date: Wed Sep 18 16:38:30 2024 +0200
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 <fka...@suse.cz>
Diff:
---
contrib/check-params-in-docs.py | 13 +++++++++++--
1 file changed, 11 insertions(+), 2 deletions(-)
diff --git a/contrib/check-params-in-docs.py b/contrib/check-params-in-docs.py
index ccdb8d721696..102f0e64e989 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)]
