generate man pages with pve-doc-generator

diff --git a/data/Makefile.in b/data/Makefile.in
index 56e7ed4ac367338973cd007c6a5264d015d1fab5..508f0c3307b31e5c3c4ddb5b7a16d66fedb73733 100644 (file)
--- a/data/Makefile.in
+++ b/data/Makefile.in
@@ -242,6 +242,10 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@
 PACKAGE_URL = @PACKAGE_URL@
 PACKAGE_VERSION = @PACKAGE_VERSION@
 PATH_SEPARATOR = @PATH_SEPARATOR@
+PERL = @PERL@
+PERL_INC = @PERL_INC@
+PERL_INSTALLARCHLIB = @PERL_INSTALLARCHLIB@
+PERL_VENDORLIB = @PERL_VENDORLIB@
 PKG_CONFIG = @PKG_CONFIG@
 PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@
 PKG_CONFIG_PATH = @PKG_CONFIG_PATH@

diff --git a/data/PVE/Makefile.am b/data/PVE/Makefile.am
index 88792a9936943791f55578d44e6dbbd5f371c02c..d7e6225fd4c0ff0b15947f7225a1068fdd34dd46 100644 (file)
--- a/data/PVE/Makefile.am
+++ b/data/PVE/Makefile.am
@@ -10,32 +10,18 @@ LDADD = $(QB_LIBS)
 perlbin_PROGRAMS = IPCC.so
 perlbindir = $(PERL_INSTALLARCHLIB)/auto/PVE/IPCC
 
-%.1.gz: %.1.pod
-       cat $<|pod2man -n $* -s 1 -r ${VERSION} -c "Proxmox Documentation"|gzip -c9 >$@
+# this require package pve-doc-generator
+export NOVIEW=1
+include /usr/share/pve-doc-generator/pve-doc-generator.mk
 
-%.5.gz: %.5.pod
-       cat $<|pod2man -n $* -s 5 -r ${VERSION} -c "Proxmox Documentation"|gzip -c9 >$@
-
-%.1.pod: %
-       perl -I.. -T -e "use PVE::CLI::$*; PVE::CLI::$*->generate_pod_manpage();" >$@.tmp
-       mv $@.tmp $@
 
 %.bash-completion:
        perl -I.. -T -e "use PVE::CLI::$*; PVE::CLI::$*->generate_bash_completions();" >$@.tmp
        mv $@.tmp $@
 
-datacenter.cfg.5.pod: Cluster.pm gen-datacenter-pod.pl
-       perl -I.. ./gen-datacenter-pod.pl > $@
-
-#datacenter.cfg.5.gz: Cluster.pm gen-datacenter-pod.pl
-#      ./gen-datacenter-pod.pl|pod2man -n datacenter.cfg -s 5 -r ${VERSION} -c #"Proxmox Documentation"|gzip -c9 >$@
-
-
-pod_DATA = pvecm.1.pod datacenter.cfg.5.pod
-poddir = /usr/share/doc/pve-cluster/pod
 
-man1_MANS = pvecm.1.gz
-man5_MANS = datacenter.cfg.5.gz
+man1_MANS = pvecm.1
+man5_MANS = datacenter.cfg.5
 
 IPCC_so_SOURCES = IPCC.c ppport.h
 
@@ -51,4 +37,6 @@ install-exec-hook: pvecm.bash-completion
        perl -I.. -T -e "use PVE::CLI::pvecm; PVE::CLI::pvecm->verify_api();"
        install -m 0644 -D pvecm.bash-completion ${DESTDIR}/usr/share/bash-completion/completions/pvecm
 
-CLEANFILES = IPCC.c *~ *.1.gz *.5.gz *.pod
+clean-local:
+       make cleanup-docgen
+       rm -f IPCC.c *~ *.1 *.5

diff --git a/data/PVE/Makefile.in b/data/PVE/Makefile.in
index 0de05f85c1deda057d52ffe6a7008743bdb3b52d..623267b9fbb86129a243231d7d723516e9cd1a5c 100644 (file)
--- a/data/PVE/Makefile.in
+++ b/data/PVE/Makefile.in
@@ -92,7 +92,7 @@ CONFIG_CLEAN_FILES =
 CONFIG_CLEAN_VPATH_FILES =
 am__installdirs = "$(DESTDIR)$(perlbindir)" "$(DESTDIR)$(bindir)" \
        "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" \
-       "$(DESTDIR)$(poddir)" "$(DESTDIR)$(pvelibdir)"
+       "$(DESTDIR)$(cliclassdir)" "$(DESTDIR)$(pvelibdir)"
 PROGRAMS = $(perlbin_PROGRAMS)
 am_IPCC_so_OBJECTS = IPCC.$(OBJEXT)
 IPCC_so_OBJECTS = $(am_IPCC_so_OBJECTS)
@@ -166,7 +166,7 @@ man1dir = $(mandir)/man1
 man5dir = $(mandir)/man5
 NROFF = nroff
 MANS = $(man1_MANS) $(man5_MANS)
-DATA = $(pod_DATA) $(pvelib_DATA)
+DATA = $(cliclass_DATA) $(noinst_DATA) $(pvelib_DATA)
 am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
 # Read a list of newline-separated strings from the standard input,
 # and print each of them once, without duplicates.  Input order is
@@ -240,6 +240,10 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@
 PACKAGE_URL = @PACKAGE_URL@
 PACKAGE_VERSION = @PACKAGE_VERSION@
 PATH_SEPARATOR = @PATH_SEPARATOR@
+PERL = @PERL@
+PERL_INC = @PERL_INC@
+PERL_INSTALLARCHLIB = @PERL_INSTALLARCHLIB@
+PERL_VENDORLIB = @PERL_VENDORLIB@
 PKG_CONFIG = @PKG_CONFIG@
 PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@
 PKG_CONFIG_PATH = @PKG_CONFIG_PATH@
@@ -296,20 +300,17 @@ top_build_prefix = @top_build_prefix@
 top_builddir = @top_builddir@
 top_srcdir = @top_srcdir@
 bin_SCRIPTS = pvecm
-AM_CFLAGS = -shared -fPIC -Wl,-z,relro -Wall -Werror -Wno-strict-aliasing -I/usr/lib/x86_64-linux-gnu/perl/5.20/CORE -DXS_VERSION=VERSION
+AM_CFLAGS = -shared -fPIC -Wl,-z,relro -Wall -Werror -Wno-strict-aliasing $(PERL_INC) -DXS_VERSION=VERSION
 LDADD = $(QB_LIBS)
-perlbindir = /usr/lib/x86_64-linux-gnu/perl/5.20/auto/PVE/IPCC/
-
-#datacenter.cfg.5.gz: Cluster.pm gen-datacenter-pod.pl
-#      ./gen-datacenter-pod.pl|pod2man -n datacenter.cfg -s 5 -r ${VERSION} -c #"Proxmox Documentation"|gzip -c9 >$@
-pod_DATA = pvecm.1.pod datacenter.cfg.5.pod
-poddir = /usr/share/doc/pve-cluster/pod
-man1_MANS = pvecm.1.gz
-man5_MANS = datacenter.cfg.5.gz
+perlbindir = $(PERL_INSTALLARCHLIB)/auto/PVE/IPCC
+man1_MANS = pvecm.1
+man5_MANS = datacenter.cfg.5
 IPCC_so_SOURCES = IPCC.c ppport.h
 pvelib_DATA = IPCC.pm Cluster.pm
-pvelibdir = /usr/share/perl5/PVE
-CLEANFILES = IPCC.c *~ *.1.gz *.5.gz *.pod
+pvelibdir = $(PERL_VENDORLIB)/PVE
+noinst_DATA = pvecm.bash-completion
+cliclass_DATA = CLI/pvecm.pm
+cliclassdir = $(PERL_VENDORLIB)/PVE/CLI
 all: all-am
 
 .SUFFIXES:
@@ -529,27 +530,27 @@ uninstall-man5:
        } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \
              -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
        dir='$(DESTDIR)$(man5dir)'; $(am__uninstall_files_from_dir)
-install-podDATA: $(pod_DATA)
+install-cliclassDATA: $(cliclass_DATA)
        @$(NORMAL_INSTALL)
-       @list='$(pod_DATA)'; test -n "$(poddir)" || list=; \
+       @list='$(cliclass_DATA)'; test -n "$(cliclassdir)" || list=; \
        if test -n "$$list"; then \
-         echo " $(MKDIR_P) '$(DESTDIR)$(poddir)'"; \
-         $(MKDIR_P) "$(DESTDIR)$(poddir)" || exit 1; \
+         echo " $(MKDIR_P) '$(DESTDIR)$(cliclassdir)'"; \
+         $(MKDIR_P) "$(DESTDIR)$(cliclassdir)" || exit 1; \
        fi; \
        for p in $$list; do \
          if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
          echo "$$d$$p"; \
        done | $(am__base_list) | \
        while read files; do \
-         echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(poddir)'"; \
-         $(INSTALL_DATA) $$files "$(DESTDIR)$(poddir)" || exit $$?; \
+         echo " $(INSTALL_DATA) $$files '$(DESTDIR)$(cliclassdir)'"; \
+         $(INSTALL_DATA) $$files "$(DESTDIR)$(cliclassdir)" || exit $$?; \
        done
 
-uninstall-podDATA:
+uninstall-cliclassDATA:
        @$(NORMAL_UNINSTALL)
-       @list='$(pod_DATA)'; test -n "$(poddir)" || list=; \
+       @list='$(cliclass_DATA)'; test -n "$(cliclassdir)" || list=; \
        files=`for p in $$list; do echo $$p; done | sed -e 's|^.*/||'`; \
-       dir='$(DESTDIR)$(poddir)'; $(am__uninstall_files_from_dir)
+       dir='$(DESTDIR)$(cliclassdir)'; $(am__uninstall_files_from_dir)
 install-pvelibDATA: $(pvelib_DATA)
        @$(NORMAL_INSTALL)
        @list='$(pvelib_DATA)'; test -n "$(pvelibdir)" || list=; \
@@ -658,7 +659,7 @@ check-am: all-am
 check: check-am
 all-am: Makefile $(PROGRAMS) $(SCRIPTS) $(MANS) $(DATA)
 installdirs:
-       for dir in "$(DESTDIR)$(perlbindir)" "$(DESTDIR)$(bindir)" "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(poddir)" "$(DESTDIR)$(pvelibdir)"; do \
+       for dir in "$(DESTDIR)$(perlbindir)" "$(DESTDIR)$(bindir)" "$(DESTDIR)$(man1dir)" "$(DESTDIR)$(man5dir)" "$(DESTDIR)$(cliclassdir)" "$(DESTDIR)$(pvelibdir)"; do \
          test -z "$$dir" || $(MKDIR_P) "$$dir"; \
        done
 install: install-am
@@ -683,7 +684,6 @@ install-strip:
 mostlyclean-generic:
 
 clean-generic:
-       -test -z "$(CLEANFILES)" || rm -f $(CLEANFILES)
 
 distclean-generic:
        -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
@@ -694,7 +694,8 @@ maintainer-clean-generic:
        @echo "it deletes files that may require special tools to rebuild."
 clean: clean-am
 
-clean-am: clean-generic clean-perlbinPROGRAMS mostlyclean-am
+clean-am: clean-generic clean-local clean-perlbinPROGRAMS \
+       mostlyclean-am
 
 distclean: distclean-am
        -rm -rf ./$(DEPDIR)
@@ -714,8 +715,8 @@ info: info-am
 
 info-am:
 
-install-data-am: install-man install-perlbinPROGRAMS install-podDATA \
-       install-pvelibDATA
+install-data-am: install-cliclassDATA install-man \
+       install-perlbinPROGRAMS install-pvelibDATA
 
 install-dvi: install-dvi-am
 
@@ -761,29 +762,29 @@ ps: ps-am
 
 ps-am:
 
-uninstall-am: uninstall-binSCRIPTS uninstall-man \
-       uninstall-perlbinPROGRAMS uninstall-podDATA \
-       uninstall-pvelibDATA
+uninstall-am: uninstall-binSCRIPTS uninstall-cliclassDATA \
+       uninstall-man uninstall-perlbinPROGRAMS uninstall-pvelibDATA
 
 uninstall-man: uninstall-man1 uninstall-man5
 
 .MAKE: install-am install-exec-am install-strip
 
 .PHONY: CTAGS GTAGS TAGS all all-am check check-am clean clean-generic \
-       clean-perlbinPROGRAMS cscopelist-am ctags ctags-am distclean \
-       distclean-compile distclean-generic distclean-tags distdir dvi \
-       dvi-am html html-am info info-am install install-am \
-       install-binSCRIPTS install-data install-data-am install-dvi \
-       install-dvi-am install-exec install-exec-am install-exec-hook \
-       install-html install-html-am install-info install-info-am \
-       install-man install-man1 install-man5 install-pdf \
-       install-pdf-am install-perlbinPROGRAMS install-podDATA \
-       install-ps install-ps-am install-pvelibDATA install-strip \
-       installcheck installcheck-am installdirs maintainer-clean \
-       maintainer-clean-generic mostlyclean mostlyclean-compile \
-       mostlyclean-generic pdf pdf-am ps ps-am tags tags-am uninstall \
-       uninstall-am uninstall-binSCRIPTS uninstall-man uninstall-man1 \
-       uninstall-man5 uninstall-perlbinPROGRAMS uninstall-podDATA \
+       clean-local clean-perlbinPROGRAMS cscopelist-am ctags ctags-am \
+       distclean distclean-compile distclean-generic distclean-tags \
+       distdir dvi dvi-am html html-am info info-am install \
+       install-am install-binSCRIPTS install-cliclassDATA \
+       install-data install-data-am install-dvi install-dvi-am \
+       install-exec install-exec-am install-exec-hook install-html \
+       install-html-am install-info install-info-am install-man \
+       install-man1 install-man5 install-pdf install-pdf-am \
+       install-perlbinPROGRAMS install-ps install-ps-am \
+       install-pvelibDATA install-strip installcheck installcheck-am \
+       installdirs maintainer-clean maintainer-clean-generic \
+       mostlyclean mostlyclean-compile mostlyclean-generic pdf pdf-am \
+       ps ps-am tags tags-am uninstall uninstall-am \
+       uninstall-binSCRIPTS uninstall-cliclassDATA uninstall-man \
+       uninstall-man1 uninstall-man5 uninstall-perlbinPROGRAMS \
        uninstall-pvelibDATA
 
 
@@ -791,20 +792,21 @@ IPCC.c: IPCC.xs
        xsubpp IPCC.xs > IPCC.xsc
        mv IPCC.xsc IPCC.c
 
-%.1.gz: %.1.pod
-       cat $<|pod2man -n $* -s 1 -r ${VERSION} -c "Proxmox Documentation"|gzip -c9 >$@
-
-%.5.gz: %.5.pod
-       cat $<|pod2man -n $* -s 5 -r ${VERSION} -c "Proxmox Documentation"|gzip -c9 >$@
+# this require package pve-doc-generator
+export NOVIEW=1
+include /usr/share/pve-doc-generator/pve-doc-generator.mk
 
-%.1.pod: %
-       perl -I.. ./$* printmanpod > $@
+%.bash-completion:
+       perl -I.. -T -e "use PVE::CLI::$*; PVE::CLI::$*->generate_bash_completions();" >$@.tmp
+       mv $@.tmp $@
 
-datacenter.cfg.5.pod: Cluster.pm gen-datacenter-pod.pl
-       perl -I.. ./gen-datacenter-pod.pl > $@
+install-exec-hook: pvecm.bash-completion
+       perl -I.. -T -e "use PVE::CLI::pvecm; PVE::CLI::pvecm->verify_api();"
+       install -m 0644 -D pvecm.bash-completion ${DESTDIR}/usr/share/bash-completion/completions/pvecm
 
-install-exec-hook:
-       perl -I.. ./pvecm verifyapi
+clean-local:
+       make cleanup-docgen
+       rm -f IPCC.c *~ *.1.gz *.5.gz *.pod
 
 # Tell versions [3.59,3.63) of GNU make to not export all variables.
 # Otherwise a system limit (for SysV at least) may be exceeded.

diff --git a/data/configure b/data/configure
index f5fb999b3c9d66c2dc6613c2f59806c522a8fb3d..3023e8ea3e3cbd86e55b79500952ec0293eb0bbe 100755 (executable)
--- a/data/configure
+++ b/data/configure
@@ -630,6 +630,10 @@ LIBOBJS
 EGREP
 GREP
 CPP
+PERL_INSTALLARCHLIB
+PERL_VENDORLIB
+PERL_INC
+PERL
 SQLITE3_LIBS
 SQLITE3_CFLAGS
 QB_LIBS
@@ -4959,6 +4963,59 @@ fi
 
 
 
+# Extract the first word of "perl", so it can be a program name with args.
+set dummy perl; ac_word=$2
+{ $as_echo "$as_me:${as_lineno-$LINENO}: checking for $ac_word" >&5
+$as_echo_n "checking for $ac_word... " >&6; }
+if ${ac_cv_path_PERL+:} false; then :
+  $as_echo_n "(cached) " >&6
+else
+  case $PERL in
+  [\\/]* | ?:[\\/]*)
+  ac_cv_path_PERL="$PERL" # Let the user override the test with a path.
+  ;;
+  *)
+  as_save_IFS=$IFS; IFS=$PATH_SEPARATOR
+for as_dir in $PATH
+do
+  IFS=$as_save_IFS
+  test -z "$as_dir" && as_dir=.
+    for ac_exec_ext in '' $ac_executable_extensions; do
+  if as_fn_executable_p "$as_dir/$ac_word$ac_exec_ext"; then
+    ac_cv_path_PERL="$as_dir/$ac_word$ac_exec_ext"
+    $as_echo "$as_me:${as_lineno-$LINENO}: found $as_dir/$ac_word$ac_exec_ext" >&5
+    break 2
+  fi
+done
+  done
+IFS=$as_save_IFS
+
+  test -z "$ac_cv_path_PERL" && ac_cv_path_PERL="no"
+  ;;
+esac
+fi
+PERL=$ac_cv_path_PERL
+if test -n "$PERL"; then
+  { $as_echo "$as_me:${as_lineno-$LINENO}: result: $PERL" >&5
+$as_echo "$PERL" >&6; }
+else
+  { $as_echo "$as_me:${as_lineno-$LINENO}: result: no" >&5
+$as_echo "no" >&6; }
+fi
+
+
+if test "x${PERL}" = xno; then
+  as_fn_error $? "perl not found" "$LINENO" 5
+fi
+
+
+PERL_INC="$(perl -MExtUtils::Embed -e perl_inc)"
+PERL_VENDORLIB="$(perl -MConfig -e 'print $Config{vendorlibexp}')"
+PERL_INSTALLARCHLIB="$(perl -MConfig -e 'print $Config{installarchlib}')"
+
+
+
+
 # Checks for header files.
 ac_header_dirent=no
 for ac_hdr in dirent.h sys/ndir.h sys/dir.h ndir.h; do

diff --git a/data/src/Makefile b/data/src/Makefile
index 5c0ec6228dc3b432c784252649cfd712863f7411..3070bcb7d1cea7239c6b504f93b82849acdbf5a1 100644 (file)
--- a/data/src/Makefile
+++ b/data/src/Makefile
@@ -415,7 +415,7 @@ AR = ar
 AUTOCONF = ${SHELL} /home/dietmar/pve4-devel/pve-cluster/data/missing autoconf
 AUTOHEADER = ${SHELL} /home/dietmar/pve4-devel/pve-cluster/data/missing autoheader
 AUTOMAKE = ${SHELL} /home/dietmar/pve4-devel/pve-cluster/data/missing automake-1.14
-AWK = mawk
+AWK = gawk
 CC = gcc
 CCDEPMODE = depmode=gcc3
 CFLAGS = -g -O2
@@ -461,6 +461,10 @@ PACKAGE_TARNAME = pve-cluster
 PACKAGE_URL = 
 PACKAGE_VERSION = 1.0
 PATH_SEPARATOR = :
+PERL = /usr/bin/perl
+PERL_INC =  -I/usr/lib/x86_64-linux-gnu/perl/5.20/CORE 
+PERL_INSTALLARCHLIB = /usr/lib/x86_64-linux-gnu/perl/5.20
+PERL_VENDORLIB = /usr/share/perl5
 PKG_CONFIG = /usr/bin/pkg-config
 PKG_CONFIG_LIBDIR = 
 PKG_CONFIG_PATH = 

diff --git a/data/src/Makefile.in b/data/src/Makefile.in
index 8a85a5b12e87b5ad1dd2d9037eb615809610c24c..b1e5f0ce4509c9da39c5c1b6d5d38bea32d95490 100644 (file)
--- a/data/src/Makefile.in
+++ b/data/src/Makefile.in
@@ -461,6 +461,10 @@ PACKAGE_TARNAME = @PACKAGE_TARNAME@
 PACKAGE_URL = @PACKAGE_URL@
 PACKAGE_VERSION = @PACKAGE_VERSION@
 PATH_SEPARATOR = @PATH_SEPARATOR@
+PERL = @PERL@
+PERL_INC = @PERL_INC@
+PERL_INSTALLARCHLIB = @PERL_INSTALLARCHLIB@
+PERL_VENDORLIB = @PERL_VENDORLIB@
 PKG_CONFIG = @PKG_CONFIG@
 PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@
 PKG_CONFIG_PATH = @PKG_CONFIG_PATH@

diff --git a/debian/control b/debian/control
index be48dddc703ebe6e55fd53992d1443826b3abcc3..c88196e71db880a3a7157a8906dd7a6ae61f9bce 100644 (file)
--- a/debian/control
+++ b/debian/control
@@ -2,7 +2,7 @@ Source: pve-cluster
 Section: admin
 Priority: optional
 Maintainer: Proxmox Support Team <support@proxmox.com>
-Build-Depends: debhelper (>= 7), autotools-dev, libsqlite3-dev, sqlite3, libfuse-dev (>= 2.9.2-4), libcorosync-pve-dev (>= 2.3.4-1), libqb-dev (>= 0.17.1-1), libpve-common-perl, libglib2.0-dev (>= 2.42.1-1), librrd-dev, librrds-perl, rrdcached, check, libdigest-hmac-perl, libxml-parser-perl, dh-systemd
+Build-Depends: debhelper (>= 7), autotools-dev, libsqlite3-dev, sqlite3, libfuse-dev (>= 2.9.2-4), libcorosync-pve-dev (>= 2.3.4-1), libqb-dev (>= 0.17.1-1), libpve-common-perl, libglib2.0-dev (>= 2.42.1-1), librrd-dev, librrds-perl, rrdcached, check, libdigest-hmac-perl, libxml-parser-perl, dh-systemd, pve-doc-generator
 Standards-Version: 3.7.3
 
 Package: pve-cluster