]> git.ipfire.org Git - thirdparty/systemd.git/blame - make-man-rules.py
zsh_completion: Split out zsh _coredumpctl
[thirdparty/systemd.git] / make-man-rules.py
CommitLineData
56ba3c78
ZJS
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
20from __future__ import print_function
56ba3c78
ZJS
21import collections
22import sys
1a13e31d 23from xml_helper import *
56ba3c78
ZJS
24
25SECTION = '''\
26MANPAGES += \\
27 {manpages}
28MANPAGES_ALIAS += \\
29 {aliases}
30{rules}
87cfe600 31{htmlrules}
56ba3c78
ZJS
32'''
33
34CONDITIONAL = '''\
35if {conditional}
36''' \
37+ SECTION + \
38'''\
39endif
40'''
41
42HEADER = '''\
43# Do not edit. Generated by make-man-rules.py.
185c3be0 44# Regenerate with 'make all update-man-list'.
56ba3c78
ZJS
45
46'''
47
87cfe600
ZJS
48HTML_ALIAS_RULE = '''\
49{}.html: {}.html
50 $(html-alias)
51'''
52
56ba3c78
ZJS
53def man(page, number):
54 return 'man/{}.{}'.format(page, number)
55
56def add_rules(rules, name):
1a13e31d 57 xml = xml_parse(name)
56ba3c78
ZJS
58 # print('parsing {}'.format(name), file=sys.stderr)
59 conditional = xml.getroot().get('conditional') or ''
60 rulegroup = rules[conditional]
61 refmeta = xml.find('./refmeta')
62 title = refmeta.find('./refentrytitle').text
63 number = refmeta.find('./manvolnum').text
64 refnames = xml.findall('./refnamediv/refname')
65 target = man(refnames[0].text, number)
66 if title != refnames[0].text:
67 raise ValueError('refmeta and refnamediv disagree: ' + name)
68 for refname in refnames:
69 assert all(refname not in group
70 for group in rules.values()), "duplicate page name"
71 alias = man(refname.text, number)
72 rulegroup[alias] = target
73 # print('{} => {} [{}]'.format(alias, target, conditional), file=sys.stderr)
74
75def create_rules(*xml_files):
76 " {conditional => {alias-name => source-name}} "
77 rules = collections.defaultdict(dict)
78 for name in xml_files:
79 add_rules(rules, name)
80 return rules
81
82def mjoin(files):
83 return ' \\\n\t'.join(sorted(files) or '#')
84
aa0bb9c2 85def make_makefile(rules):
56ba3c78
ZJS
86 return HEADER + '\n'.join(
87 (CONDITIONAL if conditional else SECTION).format(
88 manpages=mjoin(set(rulegroup.values())),
89 aliases=mjoin(k for k,v in rulegroup.items() if k != v),
90 rules='\n'.join('{}: {}'.format(k,v)
91 for k,v in sorted(rulegroup.items())
92 if k != v),
87cfe600
ZJS
93 htmlrules='\n'.join(HTML_ALIAS_RULE.format(k[:-2],v[:-2])
94 for k,v in sorted(rulegroup.items())
95 if k != v),
56ba3c78 96 conditional=conditional)
aa0bb9c2 97 for conditional,rulegroup in sorted(rules.items()))
56ba3c78
ZJS
98
99if __name__ == '__main__':
aa0bb9c2
ZJS
100 rules = create_rules(*sys.argv[1:])
101 print(make_makefile(rules), end='')