]>
Commit | Line | Data |
---|---|---|
e7098b69 ZJS |
1 | # -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */ |
2 | # | |
3 | # This file is part of systemd. | |
4 | # | |
5 | # Copyright 2012 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 | ||
d9cfd694 ZJS |
20 | import sys |
21 | import collections | |
22 | import xml.etree.ElementTree as tree | |
23 | ||
24 | TEMPLATE = '''\ | |
25 | <refentry id="systemd.directives"> | |
26 | ||
27 | <refentryinfo> | |
28 | <title>systemd.directives</title> | |
29 | <productname>systemd</productname> | |
30 | ||
31 | <authorgroup> | |
32 | <author> | |
33 | <contrib>Developer</contrib> | |
34 | <firstname>Zbigniew</firstname> | |
35 | <surname>Jędrzejewski-Szmek</surname> | |
36 | <email>zbyszek@in.waw.pl</email> | |
37 | </author> | |
38 | </authorgroup> | |
39 | </refentryinfo> | |
40 | ||
41 | <refmeta> | |
42 | <refentrytitle>systemd.directives</refentrytitle> | |
43 | <manvolnum>5</manvolnum> | |
44 | </refmeta> | |
45 | ||
46 | <refnamediv> | |
47 | <refname>systemd.directives</refname> | |
48 | <refpurpose>Index of configuration directives</refpurpose> | |
49 | </refnamediv> | |
50 | ||
51 | <refsect1> | |
52 | <title>Unit directives</title> | |
53 | ||
54 | <para>Directives for configuring units, used in unit | |
55 | files.</para> | |
56 | ||
57 | <variablelist id='unit-directives' /> | |
58 | </refsect1> | |
e1abd3ef | 59 | |
ffafe91b ZJS |
60 | <refsect1> |
61 | <title>System manager directives</title> | |
62 | ||
63 | <para>Directives for configuring the behaviour of the | |
64 | systemd process.</para> | |
65 | ||
66 | <variablelist id='systemd-directives' /> | |
67 | </refsect1> | |
68 | ||
e1abd3ef ZJS |
69 | <refsect1> |
70 | <title>UDEV directives</title> | |
71 | ||
72 | <para>Directives for configuring systemd units through the | |
73 | udev database.</para> | |
74 | ||
75 | <variablelist id='udev-directives' /> | |
76 | </refsect1> | |
f6c2e28b ZJS |
77 | |
78 | <refsect1> | |
79 | <title>Journal directives</title> | |
80 | ||
81 | <para>Directives for configuring the behaviour of the | |
82 | journald process.</para> | |
83 | ||
84 | <variablelist id='journal-directives' /> | |
85 | </refsect1> | |
4a431c9a ZJS |
86 | |
87 | <refsect1> | |
88 | <title>bootchart.conf directives</title> | |
89 | ||
90 | <para>Directives for configuring the behaviour of the | |
91 | systemd-bootchart process.</para> | |
92 | ||
93 | <variablelist id='bootchart-directives' /> | |
94 | </refsect1> | |
0acfdd61 ZJS |
95 | |
96 | <refsect1> | |
97 | <title>Colophon</title> | |
98 | <para id='colophon' /> | |
99 | </refsect1> | |
d9cfd694 ZJS |
100 | </refentry> |
101 | ''' | |
102 | ||
0acfdd61 ZJS |
103 | COLOPHON = '''\ |
104 | This index contains {count} entries in {sections} sections, | |
105 | referring to {pages} individual manual pages. | |
106 | ''' | |
107 | ||
d9cfd694 ZJS |
108 | def _extract_directives(directive_groups, page): |
109 | t = tree.parse(page) | |
110 | section = t.find('./refmeta/manvolnum').text | |
111 | pagename = t.find('./refmeta/refentrytitle').text | |
112 | for variablelist in t.iterfind('.//variablelist'): | |
113 | klass = variablelist.attrib.get('class') or 'unit-directives' | |
114 | stor = directive_groups[klass] | |
115 | for varname in variablelist.iterfind('./varlistentry/term/varname'): | |
116 | text = ''.join(varname.text.partition('=')[:2]) | |
117 | stor[text].append((pagename, section)) | |
118 | ||
eeb019b5 ZJS |
119 | def _make_section(template, name, directives): |
120 | varlist = template.find(".//*[@id='{}']".format(name)) | |
d9cfd694 ZJS |
121 | for varname, manpages in sorted(directives.items()): |
122 | entry = tree.SubElement(varlist, 'varlistentry') | |
123 | a = tree.SubElement(tree.SubElement(entry, 'term'), 'varname') | |
124 | a.text = varname | |
125 | para = tree.SubElement(tree.SubElement(entry, 'listitem'), 'para') | |
126 | ||
127 | b = None | |
128 | for manpage, manvolume in sorted(manpages): | |
129 | if b is not None: | |
130 | b.tail = ', ' | |
131 | b = tree.SubElement(para, 'citerefentry') | |
132 | c = tree.SubElement(b, 'refentrytitle') | |
133 | c.text = manpage | |
134 | d = tree.SubElement(b, 'manvolnum') | |
135 | d.text = manvolume | |
136 | entry.tail = '\n\n' | |
137 | ||
0acfdd61 ZJS |
138 | def _make_colophon(template, groups): |
139 | count = 0 | |
140 | pages = set() | |
141 | for group in groups: | |
142 | count += len(group) | |
143 | for pagelist in group.values(): | |
144 | pages |= set(pagelist) | |
145 | ||
146 | para = template.find(".//para[@id='colophon']") | |
147 | para.text = COLOPHON.format(count=count, | |
148 | sections=len(groups), | |
149 | pages=len(pages)) | |
150 | ||
eeb019b5 | 151 | def _make_page(template, directive_groups): |
d9cfd694 ZJS |
152 | """Create an XML tree from directive_groups. |
153 | ||
154 | directive_groups = { | |
155 | 'class': {'variable': [('manpage', 'manvolume'), ...], | |
156 | 'variable2': ...}, | |
157 | ... | |
158 | } | |
159 | """ | |
d9cfd694 | 160 | for name, directives in directive_groups.items(): |
eeb019b5 | 161 | _make_section(template, name, directives) |
d9cfd694 | 162 | |
0acfdd61 ZJS |
163 | _make_colophon(template, directive_groups.values()) |
164 | ||
eeb019b5 | 165 | return template |
d9cfd694 ZJS |
166 | |
167 | def make_page(xml_files): | |
168 | "Extract directives from xml_files and return XML index tree." | |
eeb019b5 ZJS |
169 | template = tree.fromstring(TEMPLATE) |
170 | names = [vl.get('id') for vl in template.iterfind('.//variablelist')] | |
d9cfd694 | 171 | directive_groups = {name:collections.defaultdict(list) |
eeb019b5 | 172 | for name in names} |
d9cfd694 ZJS |
173 | for page in xml_files: |
174 | _extract_directives(directive_groups, page) | |
175 | ||
eeb019b5 | 176 | return _make_page(template, directive_groups) |
d9cfd694 ZJS |
177 | |
178 | if __name__ == '__main__': | |
179 | tree.dump(make_page(sys.argv[1:])) |