]>
Commit | Line | Data |
---|---|---|
e7098b69 ZJS |
1 | # -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */ |
2 | # | |
3 | # This file is part of systemd. | |
4 | # | |
ccc9a4f9 | 5 | # Copyright 2012-2013 Zbigniew Jędrzejewski-Szmek |
e7098b69 ZJS |
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 | |
ccc9a4f9 | 23 | import re |
d9cfd694 ZJS |
24 | |
25 | TEMPLATE = '''\ | |
56ba3c78 | 26 | <refentry id="systemd.directives" conditional="HAVE_PYTHON"> |
d9cfd694 ZJS |
27 | |
28 | <refentryinfo> | |
29 | <title>systemd.directives</title> | |
30 | <productname>systemd</productname> | |
31 | ||
32 | <authorgroup> | |
33 | <author> | |
34 | <contrib>Developer</contrib> | |
35 | <firstname>Zbigniew</firstname> | |
36 | <surname>Jędrzejewski-Szmek</surname> | |
37 | <email>zbyszek@in.waw.pl</email> | |
38 | </author> | |
39 | </authorgroup> | |
40 | </refentryinfo> | |
41 | ||
42 | <refmeta> | |
43 | <refentrytitle>systemd.directives</refentrytitle> | |
9cc2c8b7 | 44 | <manvolnum>7</manvolnum> |
d9cfd694 ZJS |
45 | </refmeta> |
46 | ||
47 | <refnamediv> | |
48 | <refname>systemd.directives</refname> | |
49 | <refpurpose>Index of configuration directives</refpurpose> | |
50 | </refnamediv> | |
51 | ||
52 | <refsect1> | |
53 | <title>Unit directives</title> | |
54 | ||
55 | <para>Directives for configuring units, used in unit | |
56 | files.</para> | |
57 | ||
58 | <variablelist id='unit-directives' /> | |
59 | </refsect1> | |
e1abd3ef | 60 | |
08177c85 ZJS |
61 | <refsect1> |
62 | <title>Options on the kernel command line</title> | |
63 | ||
64 | <para>Kernel boot options for configuring the behaviour of the | |
65 | systemd process.</para> | |
66 | ||
ccc9a4f9 | 67 | <variablelist id='kernel-commandline-options' /> |
08177c85 ZJS |
68 | </refsect1> |
69 | ||
70 | <refsect1> | |
71 | <title>Environment variables</title> | |
72 | ||
ccc9a4f9 ZJS |
73 | <para>Environment variables understood by the systemd |
74 | manager and other programs.</para> | |
08177c85 ZJS |
75 | |
76 | <variablelist id='environment-variables' /> | |
77 | </refsect1> | |
78 | ||
e1abd3ef ZJS |
79 | <refsect1> |
80 | <title>UDEV directives</title> | |
81 | ||
82 | <para>Directives for configuring systemd units through the | |
83 | udev database.</para> | |
84 | ||
85 | <variablelist id='udev-directives' /> | |
86 | </refsect1> | |
f6c2e28b ZJS |
87 | |
88 | <refsect1> | |
ccc9a4f9 | 89 | <title>Journal fields</title> |
f6c2e28b | 90 | |
ccc9a4f9 | 91 | <para>Fields in the journal events with a well known meaning.</para> |
f6c2e28b ZJS |
92 | |
93 | <variablelist id='journal-directives' /> | |
94 | </refsect1> | |
4a431c9a | 95 | |
ccc9a4f9 ZJS |
96 | <refsect1> |
97 | <title>PAM configuration directives</title> | |
98 | ||
99 | <para>Directives for configuring PAM behaviour.</para> | |
100 | ||
101 | <variablelist id='pam-directives' /> | |
102 | </refsect1> | |
103 | ||
104 | <refsect1> | |
105 | <title>crypttab options</title> | |
106 | ||
107 | <para>Options which influence mounted filesystems and | |
108 | encrypted volumes.</para> | |
109 | ||
110 | <variablelist id='crypttab-options' /> | |
111 | </refsect1> | |
112 | ||
113 | <refsect1> | |
114 | <title>System manager directives</title> | |
115 | ||
116 | <para>Directives for configuring the behaviour of the | |
117 | systemd process.</para> | |
118 | ||
119 | <variablelist id='systemd-directives' /> | |
120 | </refsect1> | |
121 | ||
4a431c9a ZJS |
122 | <refsect1> |
123 | <title>bootchart.conf directives</title> | |
124 | ||
125 | <para>Directives for configuring the behaviour of the | |
126 | systemd-bootchart process.</para> | |
127 | ||
128 | <variablelist id='bootchart-directives' /> | |
129 | </refsect1> | |
0acfdd61 | 130 | |
ccc9a4f9 ZJS |
131 | <refsect1> |
132 | <title>command-line options</title> | |
133 | ||
134 | <para>Command-line options accepted by programs in the | |
135 | systemd suite.</para> | |
136 | ||
137 | <variablelist id='options' /> | |
138 | </refsect1> | |
139 | ||
140 | <refsect1> | |
141 | <title>Miscellaneous options and directives</title> | |
142 | ||
143 | <para>Other configuration elements which don't fit in | |
144 | any of the above groups.</para> | |
145 | ||
146 | <variablelist id='miscellaneous' /> | |
147 | </refsect1> | |
148 | ||
a4e0b94d ZJS |
149 | <refsect1> |
150 | <title>Files and directories</title> | |
151 | ||
152 | <para>Paths and file names referred to in the | |
153 | documentation.</para> | |
154 | ||
155 | <variablelist id='filenames' /> | |
156 | </refsect1> | |
157 | ||
0acfdd61 ZJS |
158 | <refsect1> |
159 | <title>Colophon</title> | |
160 | <para id='colophon' /> | |
161 | </refsect1> | |
d9cfd694 ZJS |
162 | </refentry> |
163 | ''' | |
164 | ||
0acfdd61 ZJS |
165 | COLOPHON = '''\ |
166 | This index contains {count} entries in {sections} sections, | |
167 | referring to {pages} individual manual pages. | |
168 | ''' | |
169 | ||
d970bd6d | 170 | def _extract_directives(directive_groups, formatting, page): |
d9cfd694 ZJS |
171 | t = tree.parse(page) |
172 | section = t.find('./refmeta/manvolnum').text | |
173 | pagename = t.find('./refmeta/refentrytitle').text | |
a4e0b94d ZJS |
174 | |
175 | storopt = directive_groups['options'] | |
d9cfd694 | 176 | for variablelist in t.iterfind('.//variablelist'): |
ccc9a4f9 ZJS |
177 | klass = variablelist.attrib.get('class') |
178 | storvar = directive_groups[klass or 'miscellaneous'] | |
ccc9a4f9 ZJS |
179 | # <option>s go in OPTIONS, unless class is specified |
180 | for xpath, stor in (('./varlistentry/term/varname', storvar), | |
181 | ('./varlistentry/term/option', | |
182 | storvar if klass else storopt)): | |
183 | for name in variablelist.iterfind(xpath): | |
184 | text = re.sub(r'([= ]).*', r'\1', name.text).rstrip() | |
185 | stor[text].append((pagename, section)) | |
d970bd6d ZJS |
186 | if text not in formatting: |
187 | # use element as formatted display | |
188 | name.tail = '' | |
189 | name.text = text | |
190 | formatting[text] = name | |
d9cfd694 | 191 | |
a4e0b94d ZJS |
192 | storfile = directive_groups['filenames'] |
193 | for xpath in ('.//refsynopsisdiv//filename', | |
194 | './/refsynopsisdiv//command'): | |
195 | for name in t.iterfind(xpath): | |
196 | name.tail = '' | |
197 | if name.text: | |
198 | if not name.text.startswith('.'): | |
199 | text = name.text.partition(' ')[0] | |
200 | if text != name.text: | |
201 | name.clear() | |
202 | name.text = text | |
203 | storfile[text].append((pagename, section)) | |
204 | if text not in formatting: | |
205 | # use element as formatted display | |
206 | formatting[text] = name | |
207 | else: | |
208 | text = ' '.join(name.itertext()) | |
209 | storfile[text].append((pagename, section)) | |
210 | formatting[text] = name | |
211 | ||
d970bd6d | 212 | def _make_section(template, name, directives, formatting): |
eeb019b5 | 213 | varlist = template.find(".//*[@id='{}']".format(name)) |
d9cfd694 ZJS |
214 | for varname, manpages in sorted(directives.items()): |
215 | entry = tree.SubElement(varlist, 'varlistentry') | |
d970bd6d ZJS |
216 | term = tree.SubElement(entry, 'term') |
217 | term.append(formatting[varname]) | |
218 | ||
d9cfd694 ZJS |
219 | para = tree.SubElement(tree.SubElement(entry, 'listitem'), 'para') |
220 | ||
221 | b = None | |
ccc9a4f9 | 222 | for manpage, manvolume in sorted(set(manpages)): |
d9cfd694 ZJS |
223 | if b is not None: |
224 | b.tail = ', ' | |
225 | b = tree.SubElement(para, 'citerefentry') | |
226 | c = tree.SubElement(b, 'refentrytitle') | |
227 | c.text = manpage | |
228 | d = tree.SubElement(b, 'manvolnum') | |
229 | d.text = manvolume | |
230 | entry.tail = '\n\n' | |
231 | ||
0acfdd61 ZJS |
232 | def _make_colophon(template, groups): |
233 | count = 0 | |
234 | pages = set() | |
235 | for group in groups: | |
236 | count += len(group) | |
237 | for pagelist in group.values(): | |
238 | pages |= set(pagelist) | |
239 | ||
240 | para = template.find(".//para[@id='colophon']") | |
241 | para.text = COLOPHON.format(count=count, | |
242 | sections=len(groups), | |
243 | pages=len(pages)) | |
244 | ||
d970bd6d | 245 | def _make_page(template, directive_groups, formatting): |
d9cfd694 ZJS |
246 | """Create an XML tree from directive_groups. |
247 | ||
248 | directive_groups = { | |
249 | 'class': {'variable': [('manpage', 'manvolume'), ...], | |
250 | 'variable2': ...}, | |
251 | ... | |
252 | } | |
253 | """ | |
d9cfd694 | 254 | for name, directives in directive_groups.items(): |
d970bd6d | 255 | _make_section(template, name, directives, formatting) |
d9cfd694 | 256 | |
0acfdd61 ZJS |
257 | _make_colophon(template, directive_groups.values()) |
258 | ||
eeb019b5 | 259 | return template |
d9cfd694 | 260 | |
ccc9a4f9 | 261 | def make_page(*xml_files): |
d9cfd694 | 262 | "Extract directives from xml_files and return XML index tree." |
eeb019b5 ZJS |
263 | template = tree.fromstring(TEMPLATE) |
264 | names = [vl.get('id') for vl in template.iterfind('.//variablelist')] | |
d9cfd694 | 265 | directive_groups = {name:collections.defaultdict(list) |
eeb019b5 | 266 | for name in names} |
d970bd6d | 267 | formatting = {} |
d9cfd694 | 268 | for page in xml_files: |
ccc9a4f9 | 269 | try: |
d970bd6d | 270 | _extract_directives(directive_groups, formatting, page) |
ccc9a4f9 ZJS |
271 | except Exception: |
272 | raise ValueError("failed to process " + page) | |
d9cfd694 | 273 | |
d970bd6d | 274 | return _make_page(template, directive_groups, formatting) |
d9cfd694 ZJS |
275 | |
276 | if __name__ == '__main__': | |
ccc9a4f9 | 277 | tree.dump(make_page(*sys.argv[1:])) |