mirror/gcc
1
0
Fork 0
mirror of https://github.com/gcc-mirror/gcc.git synced 2024-11-21 13:40:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Filip Kastl 2024-09-18 16:38:30 +02:00
parent de1389e24e
commit 4b7e6d5faa
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
contrib/check-params-in-docs.py
View File

@ -66,14 +66,23 @@ texi = takewhile(lambda x: '@node Instrumentation Options' not in x, texi)
texi = list(texi)[1:] texi = list(texi)[1:]
texi_params = [] texi_params = []
skip = False
for line in texi: 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 '): for token in ('@item ', '@itemx '):
if line.startswith(token): if line.startswith(token):
texi_params.append(line[len(token):]) texi_params.append(line[len(token):])
break break
# Skip digits
texi_params = [x for x in texi_params if not x[0].isdigit()]
# Skip target-specific params # Skip target-specific params
texi_params = [x for x in texi_params if not target_specific(x)] texi_params = [x for x in texi_params if not target_specific(x)]