[gentoo-commits] proj/pax-utils:master commit in: /, man/

[Sam James]

commit:     502631b86d63c4604b0ed78ad86a054e9726e897
Author:     Sam James <sam <AT> gentoo <DOT> org>
AuthorDate: Wed Nov  2 00:37:57 2022 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Wed Nov  2 00:38:55 2022 +0000
URL:        https://gitweb.gentoo.org/proj/pax-utils.git/commit/?id=502631b8

meson: include generated man pages in dist tarballs

Meson doesn't have an idiomatic way of doing this (for once!)
so we have to (per Eli Schwartz, thanks!) have:
1. a dist script which duplicates the build rule;
2. some meson.build if/else logic with fs.exists() to prefer the built manpage when using tarballs

Sadly, still can't easily regenerate man pages if
you apply a patch downstream though.

We use Michael Stapelberg's example from the linked bug as inspiration.

Bug: https://github.com/mesonbuild/meson/issues/2166
Reported-by: psykose <alice <AT> ayaya.dev>
Thanks-to: Eli Schwartz <eschwartz <AT> archlinux.org>
Signed-off-by: Sam James <sam <AT> gentoo.org>

 man/meson.build         | 37 ++++++++++++++++++++++++-------------
 meson-build-dist-man.sh | 12 ++++++++++++
 meson.build             |  2 ++
 3 files changed, 38 insertions(+), 13 deletions(-)

diff --git a/man/meson.build b/man/meson.build
index 2e346ec..130c8ec 100644
--- a/man/meson.build
+++ b/man/meson.build
@@ -18,20 +18,31 @@ pages = [
     'dumpelf.docbook', 'pspax.docbook', 'scanelf.docbook', 'scanmacho.docbook'
 ]
 
+fs = import('fs')
+
 out_pages = []
+generated_man_pages_exist = true
 foreach page : pages
-  out_pages += page.replace('.docbook', '.1')
+  man_page_name = page.replace('.docbook', '.1')
+  out_pages += man_page_name
+  if not fs.exists(man_page_name)
+      generated_man_pages_exist = false
+  endif
 endforeach
 
-custom_target('docbook_to_man',
-  command : [
-    xmlto, '-x', files('custom.xsl'), '--skip-validation',
-    '-o', meson.current_build_dir(), 'man', book
-  ],
-  input : [
-    'pax-utils.docbook.in', 'custom.xsl', 'fragment/reftail',
-  ] + pages,
-  output : out_pages,
-  install : true,
-  install_dir : get_option('mandir') / 'man1'
-)
+if generated_man_pages_exist
+  install_man(out_pages)
+else
+  custom_target('docbook_to_man',
+    command : [
+      xmlto, '-x', files('custom.xsl'), '--skip-validation',
+      '-o', meson.current_build_dir(), 'man', book
+    ],
+    input : [
+      'pax-utils.docbook.in', 'custom.xsl', 'fragment/reftail',
+    ] + pages,
+    output : out_pages,
+    install : true,
+    install_dir : get_option('mandir') / 'man1'
+  )
+endif

diff --git a/meson-build-dist-man.sh b/meson-build-dist-man.sh
new file mode 100755
index 0000000..699a380
--- /dev/null
+++ b/meson-build-dist-man.sh
@@ -0,0 +1,12 @@
+#!/bin/sh
+# This script should be invoked by meson itself (via 'meson dist')
+# See https://github.com/mesonbuild/meson/issues/2166 and more specifically,
+# https://github.com/mesonbuild/meson/issues/2166#issuecomment-629696911.
+set -eu
+
+cd "${MESON_DIST_ROOT}"
+mkdir build
+meson setup build -Dbuild_manpages=enabled
+meson compile -C build
+cp build/man/* man/
+rm -rf build

diff --git a/meson.build b/meson.build
index 0ee2630..0054ba4 100644
--- a/meson.build
+++ b/meson.build
@@ -138,6 +138,8 @@ install_data('symtree.sh',
 
 subdir('man')
 
+meson.add_dist_script('meson-build-dist-man.sh')
+
 do_tests = get_option('tests')
 if do_tests
   subdir('tests/lddtree')