chiark / gitweb /
libudev: fix strict aliasing violation
[elogind.git] / tools / make-man-rules.py
1 #  -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
2 #
3 #  This file is part of systemd.
4 #
5 #  Copyright 2013 Zbigniew JÄ™drzejewski-Szmek
6 #
7 #  systemd is free software; you can redistribute it and/or modify it
8 #  under the terms of the GNU Lesser General Public License as published by
9 #  the Free Software Foundation; either version 2.1 of the License, or
10 #  (at your option) any later version.
11 #
12 #  systemd is distributed in the hope that it will be useful, but
13 #  WITHOUT ANY WARRANTY; without even the implied warranty of
14 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 #  Lesser General Public License for more details.
16 #
17 #  You should have received a copy of the GNU Lesser General Public License
18 #  along with systemd; If not, see <http://www.gnu.org/licenses/>.
19
20 from __future__ import print_function
21 import collections
22 import sys
23 import os.path
24 from xml_helper import *
25
26 SECTION = '''\
27 MANPAGES += \\
28         {manpages}
29 MANPAGES_ALIAS += \\
30         {aliases}
31 {rules}
32 {htmlrules}
33 '''
34
35 CONDITIONAL = '''\
36 if {conditional}
37 ''' \
38 + SECTION + \
39 '''\
40 endif
41 '''
42
43 HEADER = '''\
44 # Do not edit. Generated by make-man-rules.py.
45 # To regenerate:
46 #   1. Create, update, or remove source .xml files in man/
47 #   2. Run 'make update-man-list'
48 #   3. Run 'make man' to generate manpages
49 #
50 # To make a man page conditional on a configure switch add
51 # attribute conditional="ENABLE_WHAT" or conditional="WITH_WHAT"
52 # to <refentry> element.
53 '''
54
55 HTML_ALIAS_RULE = '''\
56 {}.html: {}.html
57         $(html-alias)
58 '''
59
60 FOOTER = '''\
61
62 # Really, do not edit this file.
63
64 EXTRA_DIST += \\
65         {files}
66 '''
67
68 def man(page, number):
69     return 'man/{}.{}'.format(page, number)
70
71 def xml(file):
72     return 'man/{}'.format(os.path.basename(file))
73
74 def add_rules(rules, name):
75     xml = xml_parse(name)
76     # print('parsing {}'.format(name), file=sys.stderr)
77     if xml.getroot().tag != 'refentry':
78         return
79     conditional = xml.getroot().get('conditional') or ''
80     rulegroup = rules[conditional]
81     refmeta = xml.find('./refmeta')
82     title = refmeta.find('./refentrytitle').text
83     number = refmeta.find('./manvolnum').text
84     refnames = xml.findall('./refnamediv/refname')
85     target = man(refnames[0].text, number)
86     if title != refnames[0].text:
87         raise ValueError('refmeta and refnamediv disagree: ' + name)
88     for refname in refnames:
89         assert all(refname not in group
90                    for group in rules.values()), "duplicate page name"
91         alias = man(refname.text, number)
92         rulegroup[alias] = target
93         # print('{} => {} [{}]'.format(alias, target, conditional), file=sys.stderr)
94
95 def create_rules(xml_files):
96     " {conditional => {alias-name => source-name}} "
97     rules = collections.defaultdict(dict)
98     for name in xml_files:
99         try:
100             add_rules(rules, name)
101         except Exception:
102             print("Failed to process", name, file=sys.stderr)
103             raise
104     return rules
105
106 def mjoin(files):
107     return ' \\\n\t'.join(sorted(files) or '#')
108
109 def make_makefile(rules, files):
110     return HEADER + '\n'.join(
111         (CONDITIONAL if conditional else SECTION).format(
112             manpages=mjoin(set(rulegroup.values())),
113             aliases=mjoin(k for k,v in rulegroup.items() if k != v),
114             rules='\n'.join('{}: {}'.format(k,v)
115                             for k,v in sorted(rulegroup.items())
116                             if k != v),
117             htmlrules='\n'.join(HTML_ALIAS_RULE.format(k[:-2],v[:-2])
118                                 for k,v in sorted(rulegroup.items())
119                                 if k != v),
120             conditional=conditional)
121         for conditional,rulegroup in sorted(rules.items())
122         ) + FOOTER.format(files=mjoin(sorted(files)))
123
124 if __name__ == '__main__':
125     rules = create_rules(sys.argv[1:])
126     files = (xml(file) for file in sys.argv[1:])
127     print(make_makefile(rules, files), end='')