doc: Do not build modulemd-validator(1) with help2man

The manual page was not valid UTF-8. (An elipsis character in an usage
text.) The problem was caused by help2man tool which produced
ISO-8859-1 pages from UTF-8 "modulemd-validator --help" output.
help2man does not expect UTF-8 in nonlocalized mode. But localized
mode is not supported in Fedora for security reasons. Executing
"modulemd-validator --help" in C locale would fix help2man but it
would break Glib which prints a garbage in that locale. Moreover, the
manual page being identical to the usage output does not brought any
added value. Also the help2man output embeded a date which could
differ among builds for various architectures.

I fixed all the issues by writing the manual page by hand. Now the
manual page is more verbose and more helpful. We also dropped
a build-dependency on help2man.

To preserve compatibility, meson's with_manpages option was not turned
into a boolean. This can be done later when introducing large breaking
changes. (-Dwith_manpages=enabled vs. -Dwith_manpages=true)

Author: ppisar

.ci/archlinux/Dockerfile.deps.tmpl

@@ -9,7 +9,6 @@ RUN pacman -Syu --needed --noconfirm \
 	glib2-docs \
 	gobject-introspection \
 	gtk-doc \
-	help2man \
 	jq \
 	libyaml \
 	meson \

.ci/centos/Dockerfile.deps.tmpl

@@ -19,7 +19,6 @@ ifelse(eval(__RELEASE__ >= 8), 1, `dnl
 	glib2-doc \
 	gobject-introspection-devel \
 	gtk-doc \
-	help2man \
 	jq \
 	libyaml-devel \
 	meson \

.ci/fedora/get_fedora_deps.sh

@@ -24,7 +24,6 @@ dnf -y --setopt=install_weak_deps=False --setopt=tsflags='' \
     glib2-doc \
     gobject-introspection-devel \
     gtk-doc \
-    help2man \
     jq \
     libyaml-devel \
     meson \

.ci/mageia/Dockerfile.deps.tmpl

@@ -16,7 +16,6 @@ RUN dnf -y --setopt=install_weak_deps=False --setopt=tsflags='' install \
 	/usr/share/gtk-doc/html/glib/index.html \
 	gobject-introspection-devel \
 	gtk-doc \
-	help2man \
 	jq \
 	libyaml-devel \
 	meson \

.ci/openmandriva/Dockerfile.deps.tmpl

@@ -6,7 +6,6 @@ RUN dnf -y --setopt=install_weak_deps=False --setopt=tsflags='' install \
 	clang \
 	clang-analyzer \
 	cmake \
-	help2man \
 	jq \
 	meson \
 	ninja \

.ci/opensuse/Dockerfile.deps.tmpl

@@ -17,7 +17,6 @@ RUN zypper install --no-confirm --no-recommends --capability \
 	glib2-devel \
 	gobject-introspection-devel \
 	gtk-doc \
-	help2man \
 	jq \
 	libyaml-devel \
 	meson \

.github/workflows/ci.yaml

@@ -259,7 +259,7 @@ jobs:
         run: cp /etc/pacman.conf.pacnew /etc/pacman.conf
 
       - name: Install dependencies
-        run: pacman -Syu --needed --noconfirm base-devel file git glib2 glib2-docs gobject-introspection gtk-doc help2man jq libyaml meson python-gobject python2-six valgrind
+        run: pacman -Syu --needed --noconfirm base-devel file git glib2 glib2-docs gobject-introspection gtk-doc jq libyaml meson python-gobject python2-six valgrind
 
       - name: Checkout code
         uses: actions/checkout@v2
@@ -313,7 +313,6 @@ jobs:
               /usr/share/gtk-doc/html/glib/index.html
               gobject-introspection-devel
               gtk-doc
-              help2man
               jq
               libyaml-devel
               meson
@@ -394,7 +393,6 @@ jobs:
                  glib2-devel
                  gobject-introspection-devel
                  gtk-doc
-                 help2man
                  jq
                  libyaml-devel
                  meson
@@ -456,7 +454,6 @@ jobs:
               clang
               clang-analyzer
               cmake
-              help2man
               jq
               meson
               ninja

fedora/libmodulemd.spec

@@ -41,7 +41,6 @@ BuildRequires:  python-gobject-base
 %endif
 BuildRequires:  python%{python3_pkgversion}-devel
 BuildRequires:  python%{python3_pkgversion}-gobject-base
-BuildRequires:  help2man
 
 
 # Patches

meson.build

@@ -80,10 +80,11 @@ if with_docs
   endif
 endif
 
-with_manpages = get_option('with_manpages')
-help2man = find_program('help2man', required: with_manpages)
-if not help2man.found()
-    help2man = disabler()
+# Keep with_manpages option a tristate feature for backward compatibility.
+if get_option('with_manpages').disabled()
+  with_manpages = false
+else
+  with_manpages = true
 endif
 
 # Check whether this version of glib has the GDate autoptr defined
@@ -186,22 +187,10 @@ if meson.version().version_compare('>=0.53')
         endif
     endif
 
-    if help2man.found()
-        if with_manpages.enabled()
-            manpages_status = 'Enabled'
-        elif with_manpages.auto()
-            manpages_status = 'Enabled (autodetected)'
-        else
-            error('manpages state is unknown')
-        endif
+    if with_manpages
+        manpages_status = 'Enabled'
     else
-        if with_manpages.disabled()
-            manpages_status = 'Disabled'
-        elif with_rpmio.auto()
-            manpages_status = 'Disabled (autodetection could not locate help2man)'
-        else
-            error('manpages state is unknown')
-        endif
+        manpages_status = 'Disabled'
     endif
 
     summary({'prefix': get_option('prefix'),
@@ -215,7 +204,7 @@ if meson.version().version_compare('>=0.53')
     summary({'libmagic Support': magic_status,
              'Custom Python': get_option('python_name'),
              'RPMIO Support': rpmio_status,
-             'Generate Manpages': manpages_status,
+             'Generate Manual Pages': manpages_status,
              'Generate HTML Documentation': get_option('with_docs'),
              'Python 2 Support': get_option('with_py2'),
              'Python 3 Support': get_option('with_py3'),

modulemd/meson.build

@@ -255,6 +255,9 @@ configure_file(
   configuration : xcdata
 )
 
+
+# --- Documenatation --- #
+
 if with_docs
     gnome.gtkdoc(
         'modulemd-2.0',
@@ -273,18 +276,9 @@ if with_docs
     )
 endif
 
-help2man_opts = [
-  '--no-info',
-  '--section=1',
-]
-custom_target(
-    'modulemd-validator.1',
-    output: 'modulemd-validator.1',
-    command: [
-      help2man, help2man_opts, '--output=@OUTPUT@', modulemd_validator,
-    ],
-    install: true,
-    install_dir: join_paths(get_option('mandir'), 'man1'))
+if with_manpages
+    install_man('modulemd-validator.1')
+endif
 
 
 # --- TESTS --- #