mirror of
https://github.com/gcc-mirror/gcc.git
synced 2024-11-21 13:40:47 +00:00
e30e760b51
contrib/check-params-in-docs.py is a script that checks that all options reported with gcc --help=params are in gcc/doc/invoke.texi and vice versa. gcc/doc/invoke.texi lists target-specific params but gcc --help=params doesn't. This meant that the script would mistakenly complain about parms missing from --help=params. Previously, the script was just set to ignore aarch64 and gcn params which solved this issue only for x86. This patch sets the script to ignore all target-specific params. contrib/ChangeLog: * check-params-in-docs.py: Ignore target specific params. Signed-off-by: Filip Kastl <fkastl@suse.cz>
100 lines
2.7 KiB
Python
Executable File
100 lines
2.7 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
|
|
# Copyright (C) 2018-2024 Free Software Foundation, Inc.
|
|
#
|
|
# Find missing and extra parameters in documentation compared to
|
|
# output of: gcc --help=params.
|
|
#
|
|
# This file is part of GCC.
|
|
#
|
|
# GCC is free software; you can redistribute it and/or modify it under
|
|
# the terms of the GNU General Public License as published by the Free
|
|
# Software Foundation; either version 3, or (at your option) any later
|
|
# version.
|
|
#
|
|
# GCC is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
# for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with GCC; see the file COPYING3. If not see
|
|
# <http://www.gnu.org/licenses/>.
|
|
#
|
|
#
|
|
#
|
|
|
|
import argparse
|
|
import sys
|
|
from itertools import dropwhile, takewhile
|
|
|
|
|
|
def get_param_tuple(line):
|
|
line = line.strip().replace('--param=', '')
|
|
i = line.find(' ')
|
|
name = line[:i]
|
|
if '=' in name:
|
|
name = name[:name.find('=')]
|
|
description = line[i:].strip()
|
|
return (name, description)
|
|
|
|
def target_specific(param):
|
|
return param.split('-')[0] in ('aarch64', 'gcn', 'x86')
|
|
|
|
|
|
parser = argparse.ArgumentParser()
|
|
parser.add_argument('texi_file')
|
|
parser.add_argument('params_output')
|
|
|
|
args = parser.parse_args()
|
|
|
|
ignored = {'logical-op-non-short-circuit'}
|
|
help_params = {}
|
|
|
|
for line in open(args.params_output).readlines():
|
|
if line.startswith(' ' * 2) and not line.startswith(' ' * 8):
|
|
r = get_param_tuple(line)
|
|
help_params[r[0]] = r[1]
|
|
|
|
# Skip target-specific params
|
|
help_params = [x for x in help_params.keys() if not target_specific(x)]
|
|
|
|
# Find section in .texi manual with parameters
|
|
texi = ([x.strip() for x in open(args.texi_file).readlines()])
|
|
texi = dropwhile(lambda x: 'item --param' not in x, texi)
|
|
texi = takewhile(lambda x: '@node Instrumentation Options' not in x, texi)
|
|
texi = list(texi)[1:]
|
|
|
|
texi_params = []
|
|
for line in texi:
|
|
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)]
|
|
|
|
texi_set = set(texi_params) - ignored
|
|
params_set = set(help_params) - ignored
|
|
|
|
success = True
|
|
extra = texi_set - params_set
|
|
if len(extra):
|
|
print('Extra:')
|
|
print(extra)
|
|
success = False
|
|
|
|
missing = params_set - texi_set
|
|
if len(missing):
|
|
print('Missing:')
|
|
for m in missing:
|
|
print('@item ' + m)
|
|
print(params[m])
|
|
print()
|
|
success = False
|
|
|
|
sys.exit(0 if success else 1)
|