chiark / gitweb /
man: generate xml not html for index
[elogind.git] / make-directive-index.py
index 51d28c4fae71c5f1c6209a927d6c7e430de460c4..48d830e96f01ea7123b33cb8896c98ded909962f 100755 (executable)
@@ -40,7 +40,7 @@ TEMPLATE = '''\
 
         <refmeta>
                 <refentrytitle>systemd.directives</refentrytitle>
-                <manvolnum>5</manvolnum>
+                <manvolnum>7</manvolnum>
         </refmeta>
 
         <refnamediv>
@@ -66,6 +66,23 @@ TEMPLATE = '''\
                 <variablelist id='systemd-directives' />
         </refsect1>
 
+        <refsect1>
+                <title>Options on the kernel command line</title>
+
+                <para>Kernel boot options for configuring the behaviour of the
+                systemd process.</para>
+
+                <variablelist id='kernel-commandline-directives' />
+        </refsect1>
+
+        <refsect1>
+                <title>Environment variables</title>
+
+                <para>Environment variables understood by the systemd process.</para>
+
+                <variablelist id='environment-variables' />
+        </refsect1>
+
         <refsect1>
                 <title>UDEV directives</title>
 
@@ -92,9 +109,19 @@ TEMPLATE = '''\
 
                 <variablelist id='bootchart-directives' />
         </refsect1>
+
+        <refsect1>
+                <title>Colophon</title>
+                <para id='colophon' />
+        </refsect1>
 </refentry>
 '''
 
+COLOPHON = '''\
+This index contains {count} entries in {sections} sections,
+referring to {pages} individual manual pages.
+'''
+
 def _extract_directives(directive_groups, page):
     t = tree.parse(page)
     section = t.find('./refmeta/manvolnum').text
@@ -125,6 +152,19 @@ def _make_section(template, name, directives):
                 d.text = manvolume
         entry.tail = '\n\n'
 
+def _make_colophon(template, groups):
+    count = 0
+    pages = set()
+    for group in groups:
+        count += len(group)
+        for pagelist in group.values():
+            pages |= set(pagelist)
+
+    para = template.find(".//para[@id='colophon']")
+    para.text = COLOPHON.format(count=count,
+                                sections=len(groups),
+                                pages=len(pages))
+
 def _make_page(template, directive_groups):
     """Create an XML tree from directive_groups.
 
@@ -137,6 +177,8 @@ def _make_page(template, directive_groups):
     for name, directives in directive_groups.items():
             _make_section(template, name, directives)
 
+    _make_colophon(template, directive_groups.values())
+
     return template
 
 def make_page(xml_files):