]>
Commit | Line | Data |
---|---|---|
1 | #!/usr/bin/env python3 | |
2 | # | |
3 | # Find missing and extra parameters in documentation compared to | |
4 | # output of: gcc --help=params. | |
5 | # | |
6 | # This file is part of GCC. | |
7 | # | |
8 | # GCC is free software; you can redistribute it and/or modify it under | |
9 | # the terms of the GNU General Public License as published by the Free | |
10 | # Software Foundation; either version 3, or (at your option) any later | |
11 | # version. | |
12 | # | |
13 | # GCC is distributed in the hope that it will be useful, but WITHOUT ANY | |
14 | # WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
15 | # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
16 | # for more details. | |
17 | # | |
18 | # You should have received a copy of the GNU General Public License | |
19 | # along with GCC; see the file COPYING3. If not see | |
20 | # <http://www.gnu.org/licenses/>. */ | |
21 | # | |
22 | # | |
23 | # | |
24 | ||
25 | import argparse | |
26 | from itertools import dropwhile, takewhile | |
27 | ||
28 | ||
29 | def get_param_tuple(line): | |
30 | line = line.strip().replace('--param=', '') | |
31 | i = line.find(' ') | |
32 | name = line[:i] | |
33 | if '=' in name: | |
34 | name = name[:name.find('=')] | |
35 | description = line[i:].strip() | |
36 | return (name, description) | |
37 | ||
38 | ||
39 | parser = argparse.ArgumentParser() | |
40 | parser.add_argument('texi_file') | |
41 | parser.add_argument('params_output') | |
42 | ||
43 | args = parser.parse_args() | |
44 | ||
45 | ignored = set(['logical-op-non-short-circuit']) | |
46 | params = {} | |
47 | ||
48 | for line in open(args.params_output).readlines(): | |
49 | if line.startswith(' '): | |
50 | r = get_param_tuple(line) | |
51 | params[r[0]] = r[1] | |
52 | ||
53 | # Find section in .texi manual with parameters | |
54 | texi = ([x.strip() for x in open(args.texi_file).readlines()]) | |
55 | texi = dropwhile(lambda x: 'item --param' not in x, texi) | |
56 | texi = takewhile(lambda x: '@node Instrumentation Options' not in x, texi) | |
57 | texi = list(texi)[1:] | |
58 | ||
59 | token = '@item ' | |
60 | texi = [x[len(token):] for x in texi if x.startswith(token)] | |
61 | sorted_texi = sorted(texi) | |
62 | ||
63 | texi_set = set(texi) - ignored | |
64 | params_set = set(params.keys()) - ignored | |
65 | ||
66 | extra = texi_set - params_set | |
67 | if len(extra): | |
68 | print('Extra:') | |
69 | print(extra) | |
70 | ||
71 | missing = params_set - texi_set | |
72 | if len(missing): | |
73 | print('Missing:') | |
74 | for m in missing: | |
75 | print('@item ' + m) | |
76 | print(params[m]) | |
77 | print() | |
78 | ||
79 | if texi != sorted_texi: | |
80 | print('WARNING: not sorted alphabetically!') |