mirror of
https://github.com/systemd/systemd.git
synced 2024-10-31 16:21:26 +03:00
1a13e31d27
This makes it easier to add substitutions to man pages, avoiding the separate transformation step. mkdir -p's are removed from the rule, because xsltproc will will create directories on it's own. All in all, two or three forks per man page are avoided, which should make things marginally faster. Unfortunately python parsers must too be tweaked to handle entities. This isn't particularly easy: with lxml a custom Resolver can be used, but the stdlib etree doesn't support external entities *at all*. So when running without lxml, the entities are just removed. Right now it doesn't matter, since the entities are not indexed anyway. But I intend to add indexing of filenames in the near future, and then the index generated without lxml might be missing a few lines. Oh well.
102 lines
3.1 KiB
Python
102 lines
3.1 KiB
Python
# -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
|
|
#
|
|
# This file is part of systemd.
|
|
#
|
|
# Copyright 2013 Zbigniew Jędrzejewski-Szmek
|
|
#
|
|
# systemd is free software; you can redistribute it and/or modify it
|
|
# under the terms of the GNU Lesser General Public License as published by
|
|
# the Free Software Foundation; either version 2.1 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# systemd is distributed in the hope that it will be useful, but
|
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
# Lesser General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
# along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
from __future__ import print_function
|
|
import collections
|
|
import sys
|
|
from xml_helper import *
|
|
|
|
SECTION = '''\
|
|
MANPAGES += \\
|
|
{manpages}
|
|
MANPAGES_ALIAS += \\
|
|
{aliases}
|
|
{rules}
|
|
{htmlrules}
|
|
'''
|
|
|
|
CONDITIONAL = '''\
|
|
if {conditional}
|
|
''' \
|
|
+ SECTION + \
|
|
'''\
|
|
endif
|
|
'''
|
|
|
|
HEADER = '''\
|
|
# Do not edit. Generated by make-man-rules.py.
|
|
# Regenerate with 'make all update-man-list'.
|
|
|
|
'''
|
|
|
|
HTML_ALIAS_RULE = '''\
|
|
{}.html: {}.html
|
|
$(html-alias)
|
|
'''
|
|
|
|
def man(page, number):
|
|
return 'man/{}.{}'.format(page, number)
|
|
|
|
def add_rules(rules, name):
|
|
xml = xml_parse(name)
|
|
# print('parsing {}'.format(name), file=sys.stderr)
|
|
conditional = xml.getroot().get('conditional') or ''
|
|
rulegroup = rules[conditional]
|
|
refmeta = xml.find('./refmeta')
|
|
title = refmeta.find('./refentrytitle').text
|
|
number = refmeta.find('./manvolnum').text
|
|
refnames = xml.findall('./refnamediv/refname')
|
|
target = man(refnames[0].text, number)
|
|
if title != refnames[0].text:
|
|
raise ValueError('refmeta and refnamediv disagree: ' + name)
|
|
for refname in refnames:
|
|
assert all(refname not in group
|
|
for group in rules.values()), "duplicate page name"
|
|
alias = man(refname.text, number)
|
|
rulegroup[alias] = target
|
|
# print('{} => {} [{}]'.format(alias, target, conditional), file=sys.stderr)
|
|
|
|
def create_rules(*xml_files):
|
|
" {conditional => {alias-name => source-name}} "
|
|
rules = collections.defaultdict(dict)
|
|
for name in xml_files:
|
|
add_rules(rules, name)
|
|
return rules
|
|
|
|
def mjoin(files):
|
|
return ' \\\n\t'.join(sorted(files) or '#')
|
|
|
|
def make_makefile(rules):
|
|
return HEADER + '\n'.join(
|
|
(CONDITIONAL if conditional else SECTION).format(
|
|
manpages=mjoin(set(rulegroup.values())),
|
|
aliases=mjoin(k for k,v in rulegroup.items() if k != v),
|
|
rules='\n'.join('{}: {}'.format(k,v)
|
|
for k,v in sorted(rulegroup.items())
|
|
if k != v),
|
|
htmlrules='\n'.join(HTML_ALIAS_RULE.format(k[:-2],v[:-2])
|
|
for k,v in sorted(rulegroup.items())
|
|
if k != v),
|
|
conditional=conditional)
|
|
for conditional,rulegroup in sorted(rules.items()))
|
|
|
|
if __name__ == '__main__':
|
|
rules = create_rules(*sys.argv[1:])
|
|
print(make_makefile(rules), end='')
|