]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
projects / thirdparty / bind9.git / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 1da0af6)
Remove PDF-related bits from the build system
authorMichał Kępień <michal@isc.org>
Thu, 12 Oct 2023 12:24:42 +0000 (14:24 +0200)
committerMichał Kępień <michal@isc.org>
Thu, 12 Oct 2023 12:24:42 +0000 (14:24 +0200)
Read the Docs is capable of building the PDF version of the BIND 9 ARM
using just the contents of the doc/arm/ directory - it does not need the
build system to facilitate that.  Since the BIND 9 ARM is also built in
other formats when "make doc" is run, drop the parts of the build system
that enable building the PDF version as they pull in complexity without
bringing much added value in return.  Update related files accordingly.

.gitlab-ci.yml patch | blob | blame | history
.gitlab/issue_templates/Release.md patch | blob | blame | history
CONTRIBUTING.md patch | blob | blame | history
Makefile.docs patch | blob | blame | history
README.md patch | blob | blame | history
configure.ac patch | blob | blame | history
doc/arm/.gitattributes [deleted file] patch | blob | blame | history
doc/arm/Makefile.am patch | blob | blame | history

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 33c1578de10d099cc110c603957afe3a7e6e057c..105fb6e3f1d183c5c79238cb408a3d6fda184fd1 100644 (file)
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -497,7 +497,6 @@ cross-version-config-tests:
   script:
     - *configure
     - make -j${BUILD_PARALLEL_JOBS:-1} -k doc V=1
-    - qpdf --check doc/arm/_build/latex/Bv9ARM.pdf
     - find doc/man/ -maxdepth 1 -name "*.[0-9]" -exec mandoc -T lint "{}" \; | ( ! grep -v -e "skipping paragraph macro. sp after" -e "unknown font, skipping request. ft C" -e "input text line longer than 80 bytes" )
 
 .respdiff: &respdiff_job
@@ -1364,7 +1363,6 @@ release:
     - mv "${BIND_DIRECTORY}"/{CHANGES*,COPYRIGHT,LICENSE,README.md,srcid} .
     - rm -rf "${BIND_DIRECTORY}"
     - mv "../doc/arm/_build/html" doc/arm/
-    - mv "../doc/arm/_build/latex/Bv9ARM.pdf" doc/arm/
     - mv "../doc/arm/_build/epub/Bv9ARM.epub" doc/arm/
     - echo '<!DOCTYPE HTML><html lang="en"><meta http-equiv="refresh" content="0; url=doc/arm/html/notes.html"><title>Redirect</title></html>' > "RELEASE-NOTES-${BIND_DIRECTORY}.html"
     - popd
diff --git a/.gitlab/issue_templates/Release.md b/.gitlab/issue_templates/Release.md
index 82d635e70ddedc25fc7dca7e1f60bc23ddbdaedf..9aee063af454b128974cb2bf53d94a4c60582f32 100644 (file)
--- a/.gitlab/issue_templates/Release.md
+++ b/.gitlab/issue_templates/Release.md
@@ -52,7 +52,7 @@
 
 ### Before the ASN Deadline (for ASN Releases) or the Public Release Date (for Regular Releases)
 
- - [ ] ***(QA)*** Check that the formatting is correct for HTML and PDF versions of release notes.
+ - [ ] ***(QA)*** Check that the formatting is correct for the HTML version of release notes.
  - [ ] ***(QA)*** Check that the formatting of the generated man pages is correct.
  - [ ] ***(QA)*** Verify GitLab CI results [for the tags](https://gitlab.isc.org/isc-private/bind9/-/pipelines?scope=tags) created and sign off on the releases to be published.
  - [ ] ***(QA)*** Update GitLab settings for all maintained branches to allow merging to them again: [public](https://gitlab.isc.org/isc-projects/bind9/-/settings/repository), [private](https://gitlab.isc.org/isc-private/bind9/-/settings/repository)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c108dbeec61767382b93f1a71e87b87408e127eb..a013c4ea7314095227b29dbe867491d18b2ca91a 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -173,7 +173,7 @@ of documentation in the BIND source tree:
   they document, in files ending in `.rst`: for example, the
   `named` man page is `bin/named/named.rst`.
 * The *BIND 9 Administrator Reference Manual* is in the .rst files in
-  `doc/arm/`; the PDF and HTML versions are automatically generated from
+  `doc/arm/`; the HTML version is automatically generated from
   the `.rst` files.
 * API documentation is in the header file describing the API, in
   Doxygen-formatted comments.
diff --git a/Makefile.docs b/Makefile.docs
index 674f51d2fc87f4044a4c6af421b0ade3ac9001b2..a205c5efc7a54b215dbbe23f1522526c6a3d5d79 100644 (file)
--- a/Makefile.docs
+++ b/Makefile.docs
@@ -25,11 +25,8 @@ common_SPHINXOPTS =                  \
        -a                              \
        $(SPHINX_V)
 
-# The "today" variable set below is not directly used in the ARM, but its value
-# is implicitly inserted on the title page of the PDF file produced by Sphinx.
 ALLSPHINXOPTS =                                        \
        $(common_SPHINXOPTS)                    \
-       -D today="$(RELEASE_DATE)"              \
        -D rst_epilog="$$(printf "$${RST_EPILOG}")"     \
        $(SPHINXOPTS)                           \
        $(srcdir)
diff --git a/README.md b/README.md
index ad2b29bbc88cc24ca2c887df294715d5871df9b3..e05a114862001302e9d0bc44567e21f4a0b0d4e4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -141,9 +141,18 @@ parallel test driver; unit tests are also run by `make check`.
 
 The *BIND 9 Administrator Reference Manual* (ARM) is included with the source
 distribution, and in .rst format, in the `doc/arm`
-directory. HTML and PDF versions are automatically generated and can
+directory. The HTML version is automatically generated and can
 be viewed at [https://bind9.readthedocs.io/en/latest/index.html](https://bind9.readthedocs.io/en/latest/index.html).
 
+The PDF version can be built by running:
+
+    cd doc/arm/
+    sphinx-build -b latex . pdf/
+    make -C pdf/ all-pdf
+
+The above requires TeX Live in order to work. The PDF will be written to
+`doc/arm/pdf/Bv9ARM.pdf`.
+
 Man pages for some of the programs in the BIND 9 distribution
 are also included in the BIND ARM.
 
diff --git a/configure.ac b/configure.ac
index e6d286c161752329d423275fd61590249284c468..cce13b499fedd8051916547e33c1f3024b1123eb 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -1271,10 +1271,6 @@ AC_ARG_VAR([SPHINX_BUILD], [path to sphinx-build binary used to build the docume
 AC_PATH_PROG([SPHINX_BUILD], [sphinx-build], [])
 AM_CONDITIONAL([HAVE_SPHINX_BUILD], [test -n "$SPHINX_BUILD"])
 
-AC_PATH_PROG([XELATEX], [xelatex], [])
-AC_PATH_PROG([LATEXMK], [latexmk], [])
-AM_CONDITIONAL([HAVE_XELATEX], [test -n "$XELATEX" && test -n "$LATEXMK"])
-
 #
 # Build the man pages only if we have prebuilt manpages or we can build them from RST sources
 #
diff --git a/doc/arm/.gitattributes b/doc/arm/.gitattributes
deleted file mode 100644 (file)
index 967c07a..0000000
--- a/doc/arm/.gitattributes
+++ /dev/null
@@ -1,7 +0,0 @@
-
-Bv9ARM.ch* -diff -merge
-Bv9ARM.pdf -diff -merge
-Bv9ARM.xml   text
-Bv9ARM.conf  text
-
-*.xml auto=text
diff --git a/doc/arm/Makefile.am b/doc/arm/Makefile.am
index 5c53d566345640bf8dbc619ef888e40a29ae8403..bef634a4ac822507cc37d09e3f1eded03c75eeed 100644 (file)
--- a/doc/arm/Makefile.am
+++ b/doc/arm/Makefile.am
@@ -102,17 +102,7 @@ install-epub:
        $(INSTALL) -d $(DESTDIR)/$(docdir)
        $(INSTALL_DATA) $(SPHINXBUILDDIR)/epub/*.epub $(DESTDIR)/$(docdir)/
 
-if HAVE_XELATEX
-pdf-local:
-       $(AM_V_SPHINX)$(SPHINX_BUILD) -b latex -d $(SPHINXBUILDDIR)/.doctrees/latex $(ALLSPHINXOPTS) $(SPHINXBUILDDIR)/latex
-       $(MAKE) -C $(SPHINXBUILDDIR)/latex all-pdf
-
-install-pdf-local:
-       $(INSTALL) -d $(DESTDIR)/$(docdir)
-       $(INSTALL_DATA) $(SPHINXBUILDDIR)/latex/*.pdf $(DESTDIR)/$(docdir)/
-endif
-
 clean-local:
        -rm -rf $(SPHINXBUILDDIR)
 
-doc-local: html singlehtml pdf epub
+doc-local: html singlehtml epub
Mirror of https://gitlab.isc.org/isc-projects/bind9.git