mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-09-03 08:05:21 +00:00
Code Issues Releases Wiki Activity

Merge branch 'michal/remove-pdf-related-bits-from-the-build-system' into 'main'

Browse Source 
Remove PDF-related bits from the build system

See merge request isc-projects/bind9!8350
This commit is contained in:
Michał Kępień
2023-10-12 12:37:48 +00:00
parent 1da0af6d2f 561a83a291
commit a87436d3d5
8 changed files with 13 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitlab-ci.yml
View File

@@ -497,7 +497,6 @@ cross-version-config-tests:
script: script:
- *configure - *configure
- make -j${BUILD_PARALLEL_JOBS:-1} -k doc V=1 - 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" ) - 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 .respdiff: &respdiff_job
@@ -1364,7 +1363,6 @@ release:
- mv "${BIND_DIRECTORY}"/{CHANGES*,COPYRIGHT,LICENSE,README.md,srcid} . - mv "${BIND_DIRECTORY}"/{CHANGES*,COPYRIGHT,LICENSE,README.md,srcid} .
- rm -rf "${BIND_DIRECTORY}" - rm -rf "${BIND_DIRECTORY}"
- mv "../doc/arm/_build/html" doc/arm/ - 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/ - 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" - 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 - popd

2
.gitlab/issue_templates/Release.md
View File

@@ -52,7 +52,7 @@
### Before the ASN Deadline (for ASN Releases) or the Public Release Date (for Regular Releases) ### 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)*** 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)*** 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) - [ ] ***(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)

2
CONTRIBUTING.md
View File

@@ -173,7 +173,7 @@ of documentation in the BIND source tree:
they document, in files ending in `.rst`: for example, the they document, in files ending in `.rst`: for example, the
`named` man page is `bin/named/named.rst`. `named` man page is `bin/named/named.rst`.
* The *BIND 9 Administrator Reference Manual* is in the .rst files in * 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. the `.rst` files.
* API documentation is in the header file describing the API, in * API documentation is in the header file describing the API, in
Doxygen-formatted comments. Doxygen-formatted comments.

3
Makefile.docs
View File

@@ -25,11 +25,8 @@ common_SPHINXOPTS = \
-a \ -a \
$(SPHINX_V) $(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 = \ ALLSPHINXOPTS = \
$(common_SPHINXOPTS) \ $(common_SPHINXOPTS) \
-D today="$(RELEASE_DATE)" \
-D rst_epilog="$$(printf "$${RST_EPILOG}")" \ -D rst_epilog="$$(printf "$${RST_EPILOG}")" \
$(SPHINXOPTS) \ $(SPHINXOPTS) \
$(srcdir) $(srcdir)

11
README.md
View File

@@ -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 The *BIND 9 Administrator Reference Manual* (ARM) is included with the source
distribution, and in .rst format, in the `doc/arm` 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). 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 Man pages for some of the programs in the BIND 9 distribution
are also included in the BIND ARM. are also included in the BIND ARM.

4
configure.ac
View File

@@ -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], []) AC_PATH_PROG([SPHINX_BUILD], [sphinx-build], [])
AM_CONDITIONAL([HAVE_SPHINX_BUILD], [test -n "$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 # Build the man pages only if we have prebuilt manpages or we can build them from RST sources
# #

7
doc/arm/.gitattributes vendored
View File

@@ -1,7 +0,0 @@
Bv9ARM.ch* -diff -merge
Bv9ARM.pdf -diff -merge
Bv9ARM.xml text
Bv9ARM.conf text
*.xml auto=text

12
doc/arm/Makefile.am
View File

@@ -102,17 +102,7 @@ install-epub:
$(INSTALL) -d $(DESTDIR)/$(docdir) $(INSTALL) -d $(DESTDIR)/$(docdir)
$(INSTALL_DATA) $(SPHINXBUILDDIR)/epub/*.epub $(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: clean-local:
-rm -rf $(SPHINXBUILDDIR) -rm -rf $(SPHINXBUILDDIR)
doc-local: html singlehtml pdf epub doc-local: html singlehtml epub