]>
git.ipfire.org Git - thirdparty/systemd.git/blob - make-directive-index.py
1 # -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
3 # This file is part of systemd.
5 # Copyright 2012 Zbigniew Jędrzejewski-Szmek
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.
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.
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/>.
22 import xml
.etree
.ElementTree
as tree
25 <refentry id="systemd.directives">
28 <title>systemd.directives</title>
29 <productname>systemd</productname>
33 <contrib>Developer</contrib>
34 <firstname>Zbigniew</firstname>
35 <surname>Jędrzejewski-Szmek</surname>
36 <email>zbyszek@in.waw.pl</email>
42 <refentrytitle>systemd.directives</refentrytitle>
43 <manvolnum>5</manvolnum>
47 <refname>systemd.directives</refname>
48 <refpurpose>Index of configuration directives</refpurpose>
52 <title>Unit directives</title>
54 <para>Directives for configuring units, used in unit
57 <variablelist id='unit-directives' />
61 <title>System manager directives</title>
63 <para>Directives for configuring the behaviour of the
64 systemd process.</para>
66 <variablelist id='systemd-directives' />
70 <title>UDEV directives</title>
72 <para>Directives for configuring systemd units through the
75 <variablelist id='udev-directives' />
79 <title>Journal directives</title>
81 <para>Directives for configuring the behaviour of the
82 journald process.</para>
84 <variablelist id='journal-directives' />
89 def _extract_directives(directive_groups
, page
):
91 section
= t
.find('./refmeta/manvolnum').text
92 pagename
= t
.find('./refmeta/refentrytitle').text
93 for variablelist
in t
.iterfind('.//variablelist'):
94 klass
= variablelist
.attrib
.get('class') or 'unit-directives'
95 stor
= directive_groups
[klass
]
96 for varname
in variablelist
.iterfind('./varlistentry/term/varname'):
97 text
= ''.join(varname
.text
.partition('=')[:2])
98 stor
[text
].append((pagename
, section
))
100 def _make_section(refentry
, name
, directives
):
101 varlist
= refentry
.find(".//*[@id='{}']".format(name
))
102 for varname
, manpages
in sorted(directives
.items()):
103 entry
= tree
.SubElement(varlist
, 'varlistentry')
104 a
= tree
.SubElement(tree
.SubElement(entry
, 'term'), 'varname')
106 para
= tree
.SubElement(tree
.SubElement(entry
, 'listitem'), 'para')
109 for manpage
, manvolume
in sorted(manpages
):
112 b
= tree
.SubElement(para
, 'citerefentry')
113 c
= tree
.SubElement(b
, 'refentrytitle')
115 d
= tree
.SubElement(b
, 'manvolnum')
119 def _make_page(directive_groups
):
120 """Create an XML tree from directive_groups.
123 'class': {'variable': [('manpage', 'manvolume'), ...],
128 refentry
= tree
.fromstring(TEMPLATE
)
130 for name
, directives
in directive_groups
.items():
131 _make_section(refentry
, name
, directives
)
135 def make_page(xml_files
):
136 "Extract directives from xml_files and return XML index tree."
137 directive_groups
= {name
:collections
.defaultdict(list)
138 for name
in ['unit-directives',
140 'systemd-directives',
141 'journal-directives',
143 for page
in xml_files
:
144 _extract_directives(directive_groups
, page
)
146 return _make_page(directive_groups
)
148 if __name__
== '__main__':
149 tree
.dump(make_page(sys
.argv
[1:]))