Create doc subpackage and regenerate documentation

Regenerates full documentation on each build. Make documentation optional in case some dependencies would be missing.
2020-06-18 04:26:31 +02:00 · 2020-06-18 04:26:31 +02:00 · 0963df6403
commit 0963df6403
parent b8ccda0801
2 changed files with 41 additions and 259 deletions
--- a/bind-9.11-oot-manual.patch
+++ b/bind-9.11-oot-manual.patch
@ -1,252 +0,0 @@
-From c5b39725cd4f3f30eac7eeafd7802005a1fad533 Mon Sep 17 00:00:00 2001
-From: =?UTF-8?q?Petr=20Men=C5=A1=C3=ADk?= <pemensik@redhat.com>
-Date: Wed, 25 Jul 2018 12:24:16 +0200
-Subject: [PATCH] Use make automatic variables to install updated manuals
-
-Make will choose modified manual from build directory or original from source
-directory automagically. Take advantage of install tool feature.
-Install all files in single command instead of iterating on each of them.
---
- bin/check/Makefile.in   |  8 +++++---
- bin/confgen/Makefile.in |  9 +++++----
- bin/delv/Makefile.in    |  6 ++++--
- bin/dig/Makefile.in     |  8 ++++----
- bin/dnssec/Makefile.in  |  6 ++++--
- bin/named/Makefile.in   | 12 +++++++++---
- bin/pkcs11/Makefile.in  |  9 ++++-----
- bin/python/Makefile.in  |  8 ++++----
- bin/tools/Makefile.in   | 25 +++++++++++++++----------
- 9 files changed, 54 insertions(+), 37 deletions(-)
-
-diff --git a/bin/check/Makefile.in b/bin/check/Makefile.in
-index 8f009a4..de3c066 100644
--- a/bin/check/Makefile.in
-+++ b/bin/check/Makefile.in
-@@ -84,12 +84,14 @@ installdirs:
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${sbindir}
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8
- 
-install:: named-checkconf@EXEEXT@ named-checkzone@EXEEXT@ installdirs
-+install-man8: ${MANPAGES}
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man8
-+	(cd ${DESTDIR}${mandir}/man8; rm -f named-compilezone.8; ${LINK_PROGRAM} named-checkzone.8 named-compilezone.8)
-+
-+install:: named-checkconf@EXEEXT@ named-checkzone@EXEEXT@ installdirs install-man8
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} named-checkconf@EXEEXT@ ${DESTDIR}${sbindir}
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} named-checkzone@EXEEXT@ ${DESTDIR}${sbindir}
- 	(cd ${DESTDIR}${sbindir}; rm -f named-compilezone@EXEEXT@; ${LINK_PROGRAM} named-checkzone@EXEEXT@ named-compilezone@EXEEXT@)
-	for m in ${MANPAGES}; do ${INSTALL_DATA} ${srcdir}/$$m ${DESTDIR}${mandir}/man8 || exit 1; done
-	(cd ${DESTDIR}${mandir}/man8; rm -f named-compilezone.8; ${LINK_PROGRAM} named-checkzone.8 named-compilezone.8)
- 
- uninstall::
- 	rm -f ${DESTDIR}${mandir}/man8/named-compilezone.8
-diff --git a/bin/confgen/Makefile.in b/bin/confgen/Makefile.in
-index 0588f8b..44d87fd 100644
--- a/bin/confgen/Makefile.in
-+++ b/bin/confgen/Makefile.in
-@@ -93,13 +93,14 @@ installdirs:
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${sbindir}
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8
- 
-install:: rndc-confgen@EXEEXT@ ddns-confgen@EXEEXT@ installdirs
-+install-man8: rndc-confgen.8 ddns-confgen.8
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man8
-+	(cd ${DESTDIR}${mandir}/man8; rm -f tsig-keygen.8; ${LINK_PROGRAM} ddns-confgen.8 tsig-keygen.8)
-+
-+install:: rndc-confgen@EXEEXT@ ddns-confgen@EXEEXT@ installdirs install-man8
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} rndc-confgen@EXEEXT@ ${DESTDIR}${sbindir}
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} ddns-confgen@EXEEXT@ ${DESTDIR}${sbindir}
-	${INSTALL_DATA} ${srcdir}/rndc-confgen.8 ${DESTDIR}${mandir}/man8
-	${INSTALL_DATA} ${srcdir}/ddns-confgen.8 ${DESTDIR}${mandir}/man8
- 	(cd ${DESTDIR}${sbindir}; rm -f tsig-keygen@EXEEXT@; ${LINK_PROGRAM} ddns-confgen@EXEEXT@ tsig-keygen@EXEEXT@)
-	(cd ${DESTDIR}${mandir}/man8; rm -f tsig-keygen.8; ${LINK_PROGRAM} ddns-confgen.8 tsig-keygen.8)
- 
- uninstall::
- 	rm -f ${DESTDIR}${mandir}/man8/tsig-keygen.8
-diff --git a/bin/delv/Makefile.in b/bin/delv/Makefile.in
-index ea106f8..77adc91 100644
--- a/bin/delv/Makefile.in
-+++ b/bin/delv/Makefile.in
-@@ -63,10 +63,12 @@ installdirs:
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${bindir}
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man1
- 
-install:: delv@EXEEXT@ installdirs
-+install-man1: delv.1
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man1
-+
-+install:: delv@EXEEXT@ installdirs install-man1
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} \
- 		delv@EXEEXT@ ${DESTDIR}${bindir}
-	${INSTALL_DATA} ${srcdir}/delv.1 ${DESTDIR}${mandir}/man1
- 
- uninstall::
- 	rm -f ${DESTDIR}${mandir}/man1/delv.1
-diff --git a/bin/dig/Makefile.in b/bin/dig/Makefile.in
-index 8ea146f..3a97024 100644
--- a/bin/dig/Makefile.in
-+++ b/bin/dig/Makefile.in
-@@ -93,16 +93,16 @@ installdirs:
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${bindir}
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man1
- 
-install:: dig@EXEEXT@ host@EXEEXT@ nslookup@EXEEXT@ installdirs
-+install-man1: ${MANPAGES}
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man1
-+
-+install:: dig@EXEEXT@ host@EXEEXT@ nslookup@EXEEXT@ installdirs install-man1
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} \
- 		dig@EXEEXT@ ${DESTDIR}${bindir}
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} \
- 		host@EXEEXT@ ${DESTDIR}${bindir}
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} \
- 		nslookup@EXEEXT@ ${DESTDIR}${bindir}
-	for m in ${MANPAGES}; do \
-		${INSTALL_DATA} ${srcdir}/$$m ${DESTDIR}${mandir}/man1 || exit 1; \
-	done
- 
- uninstall::
- 	for m in ${MANPAGES}; do \
-diff --git a/bin/dnssec/Makefile.in b/bin/dnssec/Makefile.in
-index dfaad27..be1ac3b 100644
--- a/bin/dnssec/Makefile.in
-+++ b/bin/dnssec/Makefile.in
-@@ -114,9 +114,11 @@ installdirs:
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${sbindir}
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8
- 
-install:: ${TARGETS} installdirs
-+install-man8: ${MANPAGES}
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man8
-+
-+install:: ${TARGETS} installdirs install-man8
- 	for t in ${TARGETS}; do ${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} $$t ${DESTDIR}${sbindir} || exit 1; done
-	for m in ${MANPAGES}; do ${INSTALL_DATA} ${srcdir}/$$m ${DESTDIR}${mandir}/man8 || exit 1; done
- 
- uninstall::
- 	for m in ${MANPAGES}; do rm -f ${DESTDIR}${mandir}/man8/$$m || exit 1; done
-diff --git a/bin/named/Makefile.in b/bin/named/Makefile.in
-index 0485002..10d568f 100644
--- a/bin/named/Makefile.in
-+++ b/bin/named/Makefile.in
-@@ -169,10 +169,16 @@ installdirs:
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man5
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8
- 
-install:: named@EXEEXT@ installdirs
-+install-man5: named.conf.5
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man5
-+
-+install-man8: named.8
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man8
-+
-+install-man: install-man5 install-man8
-+
-+install:: named@EXEEXT@ installdirs install-man
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} named@EXEEXT@ ${DESTDIR}${sbindir}
-	${INSTALL_DATA} ${srcdir}/named.8 ${DESTDIR}${mandir}/man8
-	${INSTALL_DATA} ${srcdir}/named.conf.5 ${DESTDIR}${mandir}/man5
- 
- uninstall::
- 	rm -f ${DESTDIR}${mandir}/man5/named.conf.5
-diff --git a/bin/pkcs11/Makefile.in b/bin/pkcs11/Makefile.in
-index 2fd9861..96aec05 100644
--- a/bin/pkcs11/Makefile.in
-+++ b/bin/pkcs11/Makefile.in
-@@ -69,7 +69,10 @@ installdirs:
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${sbindir}
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8
- 
-install:: ${TARGETS} installdirs
-+install-man8: ${MANPAGES}
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man8
-+
-+install:: ${TARGETS} installdirs install-man8
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} pkcs11-list@EXEEXT@ \
- 		${DESTDIR}${sbindir}
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} pkcs11-destroy@EXEEXT@ \
-@@ -78,10 +81,6 @@ install:: ${TARGETS} installdirs
- 		${DESTDIR}${sbindir}
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} pkcs11-tokens@EXEEXT@ \
- 		${DESTDIR}${sbindir}
-	${INSTALL_DATA} ${srcdir}/pkcs11-list.8 ${DESTDIR}${mandir}/man8
-	${INSTALL_DATA} ${srcdir}/pkcs11-destroy.8 ${DESTDIR}${mandir}/man8
-	${INSTALL_DATA} ${srcdir}/pkcs11-keygen.8 ${DESTDIR}${mandir}/man8
-	${INSTALL_DATA} ${srcdir}/pkcs11-tokens.8 ${DESTDIR}${mandir}/man8
- 
- uninstall::
- 	rm -f ${DESTDIR}${mandir}/man8/pkcs11-tokens.8
-diff --git a/bin/python/Makefile.in b/bin/python/Makefile.in
-index aa678d4..064c404 100644
--- a/bin/python/Makefile.in
-+++ b/bin/python/Makefile.in
-@@ -47,13 +47,13 @@ installdirs:
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${sbindir}
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8
- 
-install:: ${TARGETS} installdirs
-+install-man8: ${MANPAGES}
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man8
-+
-+install:: ${TARGETS} installdirs install-man8
- 	${INSTALL_SCRIPT} dnssec-checkds ${DESTDIR}${sbindir}
- 	${INSTALL_SCRIPT} dnssec-coverage ${DESTDIR}${sbindir}
- 	${INSTALL_SCRIPT} dnssec-keymgr ${DESTDIR}${sbindir}
-	${INSTALL_DATA} ${srcdir}/dnssec-checkds.8 ${DESTDIR}${mandir}/man8
-	${INSTALL_DATA} ${srcdir}/dnssec-coverage.8 ${DESTDIR}${mandir}/man8
-	${INSTALL_DATA} ${srcdir}/dnssec-keymgr.8 ${DESTDIR}${mandir}/man8
- 	if test -n "${PYTHON}" ; then \
- 		if test -n "${DESTDIR}" ; then \
- 			${PYTHON} ${srcdir}/setup.py install --root=${DESTDIR} --prefix=${prefix} @PYTHON_INSTALL_LIB@ ; \
-diff --git a/bin/tools/Makefile.in b/bin/tools/Makefile.in
-index 0fd2847..3c4f028 100644
--- a/bin/tools/Makefile.in
-+++ b/bin/tools/Makefile.in
-@@ -107,17 +107,27 @@ installdirs:
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man1
- 	$(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man8
- 
-nzd:
-+nzd-man: named-nzd2nzf.8
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man8
-+
-+nzd: nzd-man
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} named-nzd2nzf@EXEEXT@ \
- 		${DESTDIR}${sbindir}
-	${INSTALL_DATA} ${srcdir}/named-nzd2nzf.8 ${DESTDIR}${mandir}/man8
- 
-dnstap:
-+dnstap-man: dnstap-read.1
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man1
-+
-+dnstap: dnstap-man
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} dnstap-read@EXEEXT@ \
- 		${DESTDIR}${bindir}
-	${INSTALL_DATA} ${srcdir}/dnstap-read.1 ${DESTDIR}${mandir}/man1
- 
-install:: ${TARGETS} installdirs @DNSTAP@ @NZD_TOOLS@
-+install-man1: arpaname.1 named-rrchecker.1 mdig.1
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man1
-+
-+install-man8: named-journalprint.8 nsec3hash.8
-+	${INSTALL_DATA} $^ ${DESTDIR}${mandir}/man8
-+
-+install:: ${TARGETS} installdirs @DNSTAP@ @NZD_TOOLS@ install-man1 install-man8
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} arpaname@EXEEXT@ \
- 		${DESTDIR}${bindir}
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} named-journalprint@EXEEXT@ \
-@@ -128,11 +138,6 @@ install:: ${TARGETS} installdirs @DNSTAP@ @NZD_TOOLS@
- 		${DESTDIR}${sbindir}
- 	${LIBTOOL_MODE_INSTALL} ${INSTALL_PROGRAM} mdig@EXEEXT@ \
- 		${DESTDIR}${bindir}
-	${INSTALL_DATA} ${srcdir}/arpaname.1 ${DESTDIR}${mandir}/man1
-	${INSTALL_DATA} ${srcdir}/named-journalprint.8 ${DESTDIR}${mandir}/man8
-	${INSTALL_DATA} ${srcdir}/named-rrchecker.1 ${DESTDIR}${mandir}/man1
-	${INSTALL_DATA} ${srcdir}/nsec3hash.8 ${DESTDIR}${mandir}/man8
-	${INSTALL_DATA} ${srcdir}/mdig.1 ${DESTDIR}${mandir}/man1
- 
- uninstall::
- 	rm -f ${DESTDIR}${mandir}/man1/mdig.1
-- 
-2.20.1
-
--- a/bind.spec
+++ b/bind.spec
@ -25,10 +25,12 @@
 %bcond_without UNITTEST
 %bcond_without DNSTAP
 %bcond_without LMDB
+%bcond_without DOC
 %else
 %bcond_with    UNITTEST
 %bcond_with    DNSTAP
 %bcond_with    LMDB
+%bcond_with    DOC
 %endif
 %bcond_with    TSAN

@ -115,8 +117,6 @@ Patch149:bind-9.11-kyua-pkcs11.patch
 # introduced by https://source.isc.org/cgi-bin/gitweb.cgi?p=bind9.git;a=commit;h=fc9f0ac5778f78003a7acc957a23711811fec122
 Patch137:bind-9.10-use-of-strlcat.patch
 Patch140:bind-9.11-rh1410433.patch
-# Avoid conflicts with OpenSSL PKCS11 engine
-Patch154:bind-9.11-oot-manual.patch
 Patch157:bind-9.11-fips-tests.patch
 Patch164:bind-9.11-rh1666814.patch
 Patch170:bind-9.11-feature-test-named.patch
@ -150,8 +150,6 @@ BuildRequires:  selinux-policy
 # needed for %%{__python3} macro
 BuildRequires:  python3-devel
 BuildRequires:  python3-ply
-BuildRequires:  python3-sphinx
-BuildRequires:  doxygen
 BuildRequires:  findutils sed
 %if 0%{?fedora}
 BuildRequires:  gnupg2
@ -192,7 +190,11 @@ BuildRequires:  libmaxminddb-devel
 BuildRequires:  fstrm-devel protobuf-c-devel
 %endif
 # Needed to regenerate dig.1 manpage
-BuildRequires: docbook-style-xsl, libxslt
+%if %{with DOC}
+BuildRequires:  python3-sphinx python3-sphinx_rtd_theme
+BuildRequires:  python3-sphinx-latex latexmk texlive-xetex texlive-xindy
+BuildRequires:  doxygen
+%endif
 %if %{with TSAN}
 BuildRequires: libtsan
 %endif
@ -416,6 +418,25 @@ BuildArch: noarch
 %description -n python3-bind
 This package provides a module which allows commands to be sent to rndc directly from Python programs.

+%if %{with DOC}
+%package doc
+Summary:   Documentation for BIND
+Requires:  bind-license = %{epoch}:%{version}-%{release}
+BuildArch: noarch
+
+%description doc
+BIND (Berkeley Internet Name Domain) is an implementation of the DNS
+(Domain Name System) protocols. BIND includes a DNS server (named),
+which resolves host names to IP addresses; a resolver library
+(routines for applications to use when interfacing with DNS); and
+tools for verifying that the DNS server is operating properly.
+
+This package contains BIND 9 Administrator Reference Manual
+in HTML and PDF format.
+%end
+
+%endif
+
 %prep
 %if 0%{?gpgverify:1}
 # RHEL does not yet support this verification
@ -431,7 +452,6 @@ This package provides a module which allows commands to be sent to rndc directly
 %patch112 -p1 -b .rh645544
 %patch130 -p1 -b .libdb
 %patch140 -p1 -b .rh1410433
-#%patch154 -p1 -b .oot-man # FIXME: sphinx replace?
 %patch157 -p1 -b .fips-tests
 %patch164 -p1 -b .rh1666814
 %patch170 -p1 -b .featuretest-named
@ -574,6 +594,10 @@ pushd bin/python
 make man
 popd

+%if %{with DOC}
+  make doc
+%endif
+
 %if %{with DLZ}
  pushd contrib/dlz
  pushd modules
@ -763,6 +787,11 @@ ln -s dnssec-verify.8.gz dnssec-verify-pkcs11.8.gz
 popd
 %endif

+pushd ${RPM_BUILD_ROOT}%{_mandir}/man8
+ln -s ddns-confgen.8.gz tsig-keygen.8.gz
+ln -s named-checkzone.8.gz named-compilezone.8.gz
+popd
+
 # Ghost config files:
 touch ${RPM_BUILD_ROOT}%{_localstatedir}/log/named.log

@ -945,7 +974,6 @@ fi;
 %{_mandir}/man8/named-journalprint.8*
 %{_mandir}/man8/filter-aaaa.8.gz
 %doc CHANGES README named.conf.default
-%doc doc/arm/*html doc/arm/*pdf
 %doc sample/

 # Hide configuration
@ -1157,10 +1185,16 @@ fi;
 %{python3_sitelib}/*.egg-info
 %{python3_sitelib}/isc/

+%if %{with DOC}
+%files doc
+%doc build/doc/arm/_build/html
+%doc build/doc/arm/Bv9ARM.pdf
+%endif

 %changelog
 * Thu Jun 18 2020 Petr Menšík <pemensik@redhat.com> - 32:9.16.4-1
 - Update to 9.16.4
+- Create separate bind-doc package with ARM

 * Wed May 20 2020 Petr Menšík <pemensik@redhat.com> - 32:9.16.3-1
 - Update to 9.16.3