chiark / gitweb /
tree-wide: drop 'This file is part of systemd' blurb
[elogind.git] / tools / make-man-rules.py
old mode 100644 (file)
new mode 100755 (executable)
index 5e61917..a9027d1
@@ -1,75 +1,21 @@
+#!/usr/bin/env python3
 #  -*- Mode: python; coding: utf-8; indent-tabs-mode: nil -*- */
+#  SPDX-License-Identifier: LGPL-2.1+
 #
-#  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/>.
+#  Copyright 2013, 2017 Zbigniew JÄ™drzejewski-Szmek
 
 from __future__ import print_function
 import collections
 import sys
 import os.path
-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.
-# To regenerate:
-#   1. Create, update, or remove source .xml files in man/
-#   2. Run 'make update-man-list'
-#   3. Run 'make man' to generate manpages
-#
-# To make a man page conditional on a configure switch add
-# attribute conditional="ENABLE_WHAT" or conditional="WITH_WHAT"
-# to <refentry> element.
-'''
-
-HTML_ALIAS_RULE = '''\
-{}.html: {}.html
-       $(html-alias)
-'''
-
-FOOTER = '''\
-
-# Really, do not edit this file.
-
-EXTRA_DIST += \\
-       {dist_files}
-'''
+import pprint
+from xml_helper import xml_parse
 
 def man(page, number):
-    return 'man/{}.{}'.format(page, number)
+    return '{}.{}'.format(page, number)
 
 def xml(file):
-    return 'man/{}'.format(os.path.basename(file))
+    return os.path.basename(file)
 
 def add_rules(rules, name):
     xml = xml_parse(name)
@@ -106,24 +52,36 @@ def create_rules(xml_files):
 def mjoin(files):
     return ' \\\n\t'.join(sorted(files) or '#')
 
-def make_makefile(rules, dist_files):
-    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())
-        ) + FOOTER.format(dist_files=mjoin(sorted(dist_files)))
+MESON_HEADER = '''\
+# Do not edit. Generated by make-man-rules.py.
+manpages = ['''
+
+MESON_FOOTER = '''\
+]
+# Really, do not edit.'''
+
+def make_mesonfile(rules, dist_files):
+    # reformat rules as
+    # grouped = [ [name, section, [alias...], condition], ...]
+    #
+    # but first create a dictionary like
+    # lists = { (name, condition) => [alias...]
+    grouped = collections.defaultdict(list)
+    for condition, items in rules.items():
+        for alias, name in items.items():
+            group = grouped[(name, condition)]
+            if name != alias:
+                group.append(alias)
+
+    lines = [ [p[0][:-2], p[0][-1], sorted(a[:-2] for a in aliases), p[1]]
+              for p, aliases in sorted(grouped.items()) ]
+    return '\n'.join((MESON_HEADER, pprint.pformat(lines)[1:-1], MESON_FOOTER))
 
 if __name__ == '__main__':
-    rules = create_rules(sys.argv[1:])
-    dist_files = (xml(file) for file in sys.argv[1:]
+    pages = sys.argv[1:]
+
+    rules = create_rules(pages)
+    dist_files = (xml(file) for file in pages
                   if not file.endswith(".directives.xml") and
                      not file.endswith(".index.xml"))
-    print(make_makefile(rules, dist_files), end='')
+    print(make_mesonfile(rules, dist_files))