tools/make-directive-index.py

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