From: Michał Kępień <michal@isc.org>
Date: Wed, 3 Feb 2021 11:18:45 +0000 (+0100)
Subject: Explicitly specify sphinx-build cache directories
X-Git-Tag: v9.16.12~6^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=36ea46fbe05dd68a1043127df98a85083cf47701;p=thirdparty%2Fbind9.git

Explicitly specify sphinx-build cache directories

When sphinx-build is invoked without the -d command line switch, the
default path to the directory in which cached environment and doctree
files are placed is OUTPUTDIR/.doctrees.  This causes the contents of
such cache directories to needlessly be included in BIND release
directories.  Avoid that by employing the -d command line switch to make
each sphinx-build process use a cache directory outside the output
directory.  Make sure these cache directories are separate from each
other as well, to prevent multiple sphinx-build processes running in
parallel from interfering with each other.
---

diff --git a/doc/arm/Makefile.in b/doc/arm/Makefile.in
index 3f653b794c7..fba3cee7fcb 100644
--- a/doc/arm/Makefile.in
+++ b/doc/arm/Makefile.in
@@ -57,10 +57,10 @@ man:: $(man1_MANS) $(man5_MANS) $(man8_MANS) @PKCS11_MANS@
 doc:: @HTMLTARGET@ @PDFTARGET@
 
 html dirhtml:
-	$(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) "$(SPHINXBUILDDIR)"/$@
+	$(SPHINXBUILD) -b $@ -d "$(SPHINXBUILDDIR)"/.doctrees/$@ $(ALLSPHINXOPTS) "$(SPHINXBUILDDIR)"/$@
 
 pdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) "$(SPHINXBUILDDIR)"/latex
+	$(SPHINXBUILD) -b latex -d "$(SPHINXBUILDDIR)"/.doctrees/$@ $(ALLSPHINXOPTS) "$(SPHINXBUILDDIR)"/latex
 	make -C "$(SPHINXBUILDDIR)"/latex
 	cp "$(SPHINXBUILDDIR)"/latex/Bv9ARM.pdf "${builddir}"
 
diff --git a/doc/man/Makefile.in b/doc/man/Makefile.in
index 81d36819723..240ae023511 100644
--- a/doc/man/Makefile.in
+++ b/doc/man/Makefile.in
@@ -182,7 +182,7 @@ man:: ootsetup $(man1_MANS) $(man5_MANS) $(man8_MANS) @DNSTAP_MANS@ @NZD_MANS@ @
 doc:: @HTMLTARGET@ @PDFTARGET@
 
 html dirhtml:
-	$(SPHINXBUILD) -b $@ $(ALLSPHINXOPTS) "$(SPHINXBUILDDIR)"/$@
+	$(SPHINXBUILD) -b $@ -d "$(SPHINXBUILDDIR)"/.doctrees/$@ $(ALLSPHINXOPTS) "$(SPHINXBUILDDIR)"/$@
 
 # copy in out-of-tree files in case sphinx-build isn't available
 .NOTPARALLEL:
@@ -192,7 +192,7 @@ ootsetup: $(MANPAGES_IN)
 	done
 
 $(MANPAGES_IN): $(MANPAGES_RST)
-	$(SPHINXBUILD) -b man $(man_SPHINXOPTS) "$(SPHINXBUILDDIR)"/man
+	$(SPHINXBUILD) -b man -d "$(SPHINXBUILDDIR)"/.doctrees/$@ $(man_SPHINXOPTS) "$(SPHINXBUILDDIR)"/man
 	-for man in $(MANPAGES_IN); do \
 	  [ -e "$(SPHINXBUILDDIR)"/man/"$$(basename $$man in)" ] && \
 	    cp -f "$(SPHINXBUILDDIR)"/man/"$$(basename $$man in)" "$$man"; \