]> git.ipfire.org Git - thirdparty/systemd.git/blobdiff - man/meson.build
final v236 update (#7649)
[thirdparty/systemd.git] / man / meson.build
index 9d8d1a9922fff32ca47474ecaedaf03afbc1c836..3a684101d281e2ee329ad542e57e5938e1783355 100644 (file)
@@ -1,11 +1,23 @@
-# -*- mode: meson -*-
+# SPDX-License-Identifier: LGPL-2.1+
+#
+# Copyright 2017 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/>.
 
 # This is lame, I know, but meson has no other include mechanism
 subdir('rules')
 
-# TODO: add regeneration rule:
-# python3 tools/make-man-rules.py --meson man/*xml > man/rules/meson.build
-
 want_man = get_option('man')
 want_html = get_option('html')
 xsltproc = find_program('xsltproc',
@@ -14,143 +26,198 @@ want_man = want_man != 'false' and xsltproc.found()
 want_html = want_html != 'false' and xsltproc.found()
 
 xsltproc_flags = [
-  '--nonet',
-  '--xinclude',
-  '--stringparam', 'man.output.quietly', '1',
-  '--stringparam', 'funcsynopsis.style', 'ansi',
-  '--stringparam', 'man.authors.section.enabled', '0',
-  '--stringparam', 'man.copyright.section.enabled', '0',
-  '--stringparam', 'systemd.version', '@0@'.format(meson.project_version()),
-  '--path',
-  '@0@:@1@'.format(meson.current_build_dir(), meson.current_source_dir())]
+        '--nonet',
+        '--xinclude',
+        '--maxdepth', '9000',
+        '--stringparam', 'man.output.quietly', '1',
+        '--stringparam', 'funcsynopsis.style', 'ansi',
+        '--stringparam', 'man.authors.section.enabled', '0',
+        '--stringparam', 'man.copyright.section.enabled', '0',
+        '--stringparam', 'systemd.version', '@0@'.format(meson.project_version()),
+        '--path',
+        '@0@:@1@'.format(meson.current_build_dir(), meson.current_source_dir())]
 
 custom_man_xsl = files('custom-man.xsl')
 custom_html_xsl = files('custom-html.xsl')
+xslt_cmd = [xsltproc, '-o', '@OUTPUT0@'] + xsltproc_flags
 
 custom_entities_ent = configure_file(
-    input : 'custom-entities.ent.in',
-    output : 'custom-entities.ent',
-    configuration : conf)
+        input : 'custom-entities.ent.in',
+        output : 'custom-entities.ent',
+        configuration : conf)
 
 man_pages = []
 html_pages = []
 source_xml_files = []
-foreach tuple : manpages
-  stem = tuple[0]
-  section = tuple[1]
-  aliases = tuple[2]
-  condition = tuple[3]
-
-  xml = stem + '.xml'
-  html = stem + '.html'
-  man = stem + '.' + section
-
-  manaliases = []
-  htmlaliases = []
-  foreach alias : aliases
-    manaliases += [alias + '.' + section]
-    htmlaliases += [alias + '.html']
-  endforeach
-
-  mandirn = join_paths(get_option('mandir'), 'man' + section)
-
-  have = condition == '' or conf.get(condition, 0) == 1
-
-  if have
-    p1 = custom_target(
-        man,
-        input : xml,
-        output : [man] + manaliases,
-        command : [xsltproc, '-o', '@OUTPUT0@'] + xsltproc_flags + [custom_man_xsl, '@INPUT@'],
-        depend_files : custom_entities_ent,
-        install : want_man,
-        install_dir : mandirn)
-    man_pages += [p1]
-
-    p2 = custom_target(
-        html,
-        input : xml,
-        output : [html] + htmlaliases,
-        command : [xsltproc, '-o', '@OUTPUT0@'] + xsltproc_flags + [custom_html_xsl, '@INPUT@'],
-        depend_files : custom_entities_ent,
-        install : want_html,
-        install_dir : join_paths(docdir, 'html'))
-    html_pages += [p2]
-
-    source_xml_files += files(tuple[0] + '.xml')
-  else
-    message('Skipping @0@.@1@ because @2@ is @3@'.format(stem, section, condition, have))
-  endif
+foreach tuple : xsltproc.found() ? manpages : []
+        stem = tuple[0]
+        section = tuple[1]
+        aliases = tuple[2]
+        condition = tuple[3]
+
+        xml = stem + '.xml'
+        html = stem + '.html'
+        man = stem + '.' + section
+
+        manaliases = []
+        htmlaliases = []
+        foreach alias : aliases
+                manaliases += [alias + '.' + section]
+                htmlaliases += [alias + '.html']
+        endforeach
+
+        mandirn = join_paths(get_option('mandir'), 'man' + section)
+
+        if condition == '' or conf.get(condition) == 1
+                p1 = custom_target(
+                        man,
+                        input : xml,
+                        output : [man] + manaliases,
+                        command : xslt_cmd + [custom_man_xsl, '@INPUT@'],
+                        depend_files : custom_entities_ent,
+                        install : want_man,
+                        install_dir : mandirn)
+                man_pages += [p1]
+
+                p2 = []
+                foreach htmlalias : htmlaliases
+                        link = custom_target(
+                                htmlalias,
+                                input : p2,
+                                output : htmlalias,
+                                command : ['ln', '-fs', html, '@OUTPUT@'])
+                        if want_html
+                                dst = join_paths(docdir, 'html', htmlalias)
+                                cmd = 'ln -fs @0@ $DESTDIR@1@'.format(html, dst)
+                                meson.add_install_script('sh', '-c', cmd)
+                                p2 += [link]
+                        endif
+                        html_pages += [link]
+                endforeach
+
+                p3 = custom_target(
+                        html,
+                        input : xml,
+                        output : html,
+                        command : xslt_cmd + [custom_html_xsl, '@INPUT@'],
+                        depend_files : custom_entities_ent,
+                        depends : p2,
+                        install : want_html,
+                        install_dir : join_paths(docdir, 'html'))
+                html_pages += [p3]
+
+                source_xml_files += files(tuple[0] + '.xml')
+        else
+                message('Skipping @0@.@1@ because @2@ is false'.format(stem, section, condition))
+        endif
 endforeach
 
 ############################################################
 
 have_lxml = run_command(xml_helper_py).returncode() == 0
 if not have_lxml
-  message('python-lxml not available, not making man page indices')
+        message('python-lxml not available, not making man page indices')
 endif
 
 systemd_directives_xml = custom_target(
-    'systemd.directives.xml',
-    input : source_xml_files,
-    output : 'systemd.directives.xml',
-    command : [make_directive_index_py, '@OUTPUT@'] + source_xml_files)
+        'systemd.directives.xml',
+        input : source_xml_files,
+        output : 'systemd.directives.xml',
+        command : [make_directive_index_py, '@OUTPUT@'] + source_xml_files)
 
 nonindex_xml_files = source_xml_files + [systemd_directives_xml]
 systemd_index_xml = custom_target(
-    'systemd.index.xml',
-    input : nonindex_xml_files,
-    output : 'systemd.index.xml',
-    command : [make_man_index_py, '@OUTPUT@'] + nonindex_xml_files)
-
-foreach tuple : [['systemd.directives', '7', systemd_directives_xml],
-                 ['systemd.index',      '7', systemd_index_xml]]
-  stem = tuple[0]
-  section = tuple[1]
-  xml = tuple[2]
-
-  html = stem + '.html'
-  man = stem + '.' + section
-
-  mandirn = join_paths(get_option('mandir'), 'man' + section)
-
-  p1 = custom_target(
-      man,
-      input : xml,
-      output : man,
-      command : [xsltproc, '-o', '@OUTPUT0@'] + xsltproc_flags + [custom_man_xsl, '@INPUT@'],
-      install : want_man and have_lxml,
-      install_dir : mandirn)
-  man_pages += [p1]
-
-  p2 = custom_target(
-      html,
-      input : xml,
-      output : html,
-      command : [xsltproc, '-o', '@OUTPUT0@'] + xsltproc_flags + [custom_html_xsl, '@INPUT@'],
-      install : want_html and have_lxml,
-      install_dir : join_paths(docdir, 'html'))
-  html_pages += [p2]
+        'systemd.index.xml',
+        input : nonindex_xml_files,
+        output : 'systemd.index.xml',
+        command : [make_man_index_py, '@OUTPUT@'] + nonindex_xml_files)
+
+foreach tuple : want_man or want_html ? [['systemd.directives', '7', systemd_directives_xml],
+                                         ['systemd.index',      '7', systemd_index_xml]] : []
+        stem = tuple[0]
+        section = tuple[1]
+        xml = tuple[2]
+
+        html = stem + '.html'
+        man = stem + '.' + section
+
+        mandirn = join_paths(get_option('mandir'), 'man' + section)
+
+        p1 = custom_target(
+                man,
+                input : xml,
+                output : man,
+                command : xslt_cmd + [custom_man_xsl, '@INPUT@'],
+                install : want_man and have_lxml,
+                install_dir : mandirn)
+        man_pages += [p1]
+
+        p2 = []
+        if html == 'systemd.index.html'
+                htmlalias = 'index.html'
+                link = custom_target(
+                        htmlalias,
+                        input : p2,
+                        output : htmlalias,
+                        command : ['ln', '-fs', html, '@OUTPUT@'])
+                if want_html
+                        dst = join_paths(docdir, 'html', htmlalias)
+                        cmd = 'ln -fs @0@ $DESTDIR@1@'.format(html, dst)
+                        meson.add_install_script('sh', '-c', cmd)
+                        p2 += [link]
+                endif
+                html_pages += [link]
+        endif
+
+        p3 = custom_target(
+                html,
+                input : xml,
+                output : html,
+                command : xslt_cmd + [custom_html_xsl, '@INPUT@'],
+                depend_files : custom_entities_ent,
+                depends : p2,
+                install : want_html and have_lxml,
+                install_dir : join_paths(docdir, 'html'))
+        html_pages += [p3]
 endforeach
 
-man = custom_target('man',
-                    depends : man_pages,
-                    output : 'man',
-                    command : ['echo'])
-
-html = custom_target('html',
-                     depends : html_pages,
-                     output : 'html',
-                     command : ['echo'])
-
-custom_target('doc-sync',
-              depends : [man, html],
-              output : ['doc-sync'],
-              command : ['rsync', '-rlv',
-                         '--delete-excluded',
-                         '--include=man',
-                         '--include=*.html',
-                         '--exclude=*',
-                         '--omit-dir-times',
-                         meson.current_build_dir(),
-                         get_option('www-target')])
+# cannot use run_target until https://github.com/mesonbuild/meson/issues/1644 is resolved
+man = custom_target(
+        'man',
+        output : 'man',
+        depends : man_pages,
+        command : ['echo'])
+
+html = custom_target(
+        'html',
+        output : 'html',
+        depends : html_pages,
+        command : ['echo'])
+
+run_target(
+        'doc-sync',
+        depends : man_pages + html_pages,
+        command : ['rsync', '-rlv',
+                   '--delete-excluded',
+                   '--include=man',
+                   '--include=*.html',
+                   '--exclude=*',
+                   '--omit-dir-times',
+                   meson.current_build_dir(),
+                   get_option('www-target')])
+
+############################################################
+
+if git.found()
+        custom_target(
+                'update-man-rules',
+                output : 'update-man-rules',
+                # slightly strange syntax because of
+                # https://github.com/mesonbuild/meson/issues/1643
+                # and https://github.com/mesonbuild/meson/issues/1512
+                command : ['sh', '-c',
+                           'cd @0@ && '.format(meson.build_root()) +
+                           'python3 @0@/tools/make-man-rules.py `git ls-files ":/man/*.xml"` >t && '.format(meson.source_root()) +
+                           'mv t @0@/rules/meson.build'.format(meson.current_source_dir())],
+                depend_files : custom_entities_ent)
+endif