#!/usr/bin/env python3 # -*- coding: utf-8 -*- # # Copyright (C) 2018-2022 Matthias Klumpp # # SPDX-License-Identifier: LGPL-3.0-or-later import os import sys from functools import reduce from subprocess import check_call from xml.sax.saxutils import escape as xml_escape sys.path.append("..") class DocbookEditor: def __init__(self): self._replacements = {} def add_substvar(self, name, replacement): self._replacements['@{}@'.format(name)] = replacement def register_command_flag_synopsis(self, actions, command_name): flags_text = '' flags_entries = '' for item in actions: options_text = xml_escape('|'.join(item.option_strings)) flags_text += '{}\n'.format(options_text) oid = item.option_strings[0] desc_text = None if oid == '-h': desc_text = 'Print brief help information about available commands.' if command_name != 'create': if oid == '--variant': desc_text = 'Set the variant of the selected image, that was used for bootstrapping.' elif oid == '-a': desc_text = 'The architecture of the base image that should be selected.' if not desc_text: desc_text = item.help desc_text = xml_escape(desc_text) if desc_text.startswith('CF|'): desc_text = desc_text[3:] desc_text = desc_text.replace('binary:', ':', 1) desc_text = desc_text.replace('arch:', ':', 1) desc_text = desc_text.replace('indep:', ':', 1) desc_text = desc_text.replace('source:', ':', 1) flags_entries += ''' {} {} '''.format(options_text, desc_text) self.add_substvar('{}_FLAGS_SYNOPSIS'.format(command_name.upper()), flags_text) self.add_substvar('{}_FLAGS_ENTRIES'.format(command_name.upper()), flags_entries) def process_file(self, input_fname, output_fname): with open(input_fname, 'r') as f: template_content = f.read() result = reduce( lambda x, y: x.replace(y, self._replacements[y]), self._replacements, template_content ) with open(output_fname, 'w') as f: f.write(result) return output_fname def generate_docbook_pages(build_dir): from debspawn.cli import create_parser build_dir = os.path.abspath(build_dir) parser = create_parser() editor = DocbookEditor() editor.register_command_flag_synopsis(parser._get_optional_actions(), 'BASE') xml_manpages = [] xml_manpages.append(editor.process_file('docs/debspawn.1.xml', os.path.join(build_dir, 'debspawn.1.xml'))) for command, sp in parser._get_positional_actions()[0]._name_parser_map.items(): editor.register_command_flag_synopsis(sp._get_optional_actions(), command) template_fname = 'docs/debspawn-{}.1.xml'.format(command) if not os.path.isfile(template_fname): if command in ['ls', 'b']: continue # the ls and b shorthands need to manual page print('Manual page template {} is missing! Skipping it.'.format(template_fname)) continue xml_manpages.append( editor.process_file(template_fname, os.path.join(build_dir, os.path.basename(template_fname))) ) return xml_manpages def create_manpage(xml_src, out_dir): man_name = os.path.splitext(os.path.basename(xml_src))[0] out_fname = os.path.join(out_dir, man_name) print('Generating manual page {}'.format(man_name)) check_call( [ 'xsltproc', '--nonet', '--stringparam', 'man.output.quietly', '1', '--stringparam', 'funcsynopsis.style', 'ansi', '--stringparam', 'man.th.extra1.suppress', '1', '-o', out_fname, 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl', xml_src, ] ) return out_fname if __name__ == '__main__': generate_docbook_pages('/tmp')