X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=make-directive-index.py;h=b43fea0b99e386936da6d32be21c6877504295d9;hp=15bd9b93410334c6982792939d4777aec6fdaa81;hb=916484f54d084e11a11458716b2e0bbdf4822d40;hpb=a4e0b94d318e35b1441fc56f590668e80ff2e44e diff --git a/make-directive-index.py b/make-directive-index.py index 15bd9b934..b43fea0b9 100755 --- a/make-directive-index.py +++ b/make-directive-index.py @@ -19,8 +19,9 @@ import sys import collections -import xml.etree.ElementTree as tree import re +from xml_helper import * +from copy import deepcopy TEMPLATE = '''\ @@ -137,6 +138,14 @@ TEMPLATE = '''\ + + Constants + + Various constant used and/or defined by systemd. + + + + Miscellaneous options and directives @@ -168,7 +177,7 @@ referring to {pages} individual manual pages. ''' def _extract_directives(directive_groups, formatting, page): - t = tree.parse(page) + t = xml_parse(page) section = t.find('./refmeta/manvolnum').text pagename = t.find('./refmeta/refentrytitle').text @@ -185,21 +194,33 @@ def _extract_directives(directive_groups, formatting, page): stor[text].append((pagename, section)) if text not in formatting: # use element as formatted display - name.tail = '' + if name.text[-1] in '= ': + name.clear() + else: + name.tail = '' name.text = text formatting[text] = name storfile = directive_groups['filenames'] - for xpath in ('.//refsynopsisdiv//filename', - './/refsynopsisdiv//command'): + for xpath, absolute_only in (('.//refsynopsisdiv//filename', False), + ('.//refsynopsisdiv//command', False), + ('.//filename', True)): for name in t.iterfind(xpath): + if absolute_only and not (name.text and name.text.startswith('/')): + continue + if name.attrib.get('noindex'): + continue name.tail = '' if name.text: + if name.text.endswith('*'): + name.text = name.text[:-1] if not name.text.startswith('.'): text = name.text.partition(' ')[0] if text != name.text: name.clear() name.text = text + if text.endswith('/'): + text = text[:-1] storfile[text].append((pagename, section)) if text not in formatting: # use element as formatted display @@ -209,24 +230,35 @@ def _extract_directives(directive_groups, formatting, page): storfile[text].append((pagename, section)) formatting[text] = name + storfile = directive_groups['constants'] + for name in t.iterfind('.//constant'): + if name.attrib.get('noindex'): + continue + name.tail = '' + if name.text.startswith('('): # a cast, strip it + name.text = name.text.partition(' ')[2] + storfile[name.text].append((pagename, section)) + formatting[name.text] = name + def _make_section(template, name, directives, formatting): varlist = template.find(".//*[@id='{}']".format(name)) for varname, manpages in sorted(directives.items()): entry = tree.SubElement(varlist, 'varlistentry') term = tree.SubElement(entry, 'term') - term.append(formatting[varname]) + display = deepcopy(formatting[varname]) + term.append(display) para = tree.SubElement(tree.SubElement(entry, 'listitem'), 'para') b = None for manpage, manvolume in sorted(set(manpages)): - if b is not None: - b.tail = ', ' - b = tree.SubElement(para, 'citerefentry') - c = tree.SubElement(b, 'refentrytitle') - c.text = manpage - d = tree.SubElement(b, 'manvolnum') - d.text = manvolume + if b is not None: + b.tail = ', ' + b = tree.SubElement(para, 'citerefentry') + c = tree.SubElement(b, 'refentrytitle') + c.text = manpage + d = tree.SubElement(b, 'manvolnum') + d.text = manvolume entry.tail = '\n\n' def _make_colophon(template, groups): @@ -252,7 +284,7 @@ def _make_page(template, directive_groups, formatting): } """ for name, directives in directive_groups.items(): - _make_section(template, name, directives, formatting) + _make_section(template, name, directives, formatting) _make_colophon(template, directive_groups.values()) @@ -274,4 +306,5 @@ def make_page(*xml_files): return _make_page(template, directive_groups, formatting) if __name__ == '__main__': - tree.dump(make_page(*sys.argv[1:])) + with open(sys.argv[1], 'wb') as f: + f.write(xml_print(make_page(*sys.argv[2:])))