From cab8f69857d0c551ef760079a027323dda6b2694 Mon Sep 17 00:00:00 2001 From: Martin Liska Date: Tue, 23 Nov 2021 08:26:51 +0100 Subject: [PATCH] contrib: Support itemx in check-params-in-docs.py. contrib/ChangeLog: * check-params-in-docs.py: Support @itemx in param documentation and support multi-line documentation for parameters. --- contrib/check-params-in-docs.py | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/contrib/check-params-in-docs.py b/contrib/check-params-in-docs.py index 440549f5fd8..d57055088b7 100755 --- a/contrib/check-params-in-docs.py +++ b/contrib/check-params-in-docs.py @@ -47,7 +47,7 @@ ignored = {'logical-op-non-short-circuit'} params = {} for line in open(args.params_output).readlines(): - if line.startswith(' '): + if line.startswith(' ' * 2) and not line.startswith(' ' * 8): r = get_param_tuple(line) params[r[0]] = r[1] @@ -57,15 +57,20 @@ 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:] -token = '@item ' -texi = [x[len(token):] for x in texi if x.startswith(token)] -# skip digits -texi = [x for x in texi if not x[0].isdigit()] -# skip aarch64 params -texi = [x for x in texi if not x.startswith('aarch64')] -sorted_texi = sorted(texi) +texi_params = [] +for line in texi: + for token in ('@item ', '@itemx '): + if line.startswith(token): + texi_params.append(line[len(token):]) + break -texi_set = set(texi) - ignored +# skip digits +texi_params = [x for x in texi_params if not x[0].isdigit()] +# skip aarch64 params +texi_params = [x for x in texi_params if not x.startswith('aarch64')] +sorted_params = sorted(texi_params) + +texi_set = set(texi_params) - ignored params_set = set(params.keys()) - ignored success = True @@ -84,7 +89,4 @@ if len(missing): print() success = False -if texi != sorted_texi: - print('WARNING: not sorted alphabetically!') - sys.exit(0 if success else 1)