diff options
| author | David Bremner <david@tethera.net> | 2019-05-31 23:24:52 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2019-06-03 07:35:30 -0300 |
| commit | 6edc073e4496b71d24e339f4d0cca41c2e4ac3e1 (patch) | |
| tree | 4caa22ecdcbd2c7677a3995a6272102c7b85451f /doc/Makefile.local | |
| parent | 80cfc48af550f66837ad3822a2db18b916487eea (diff) | |
doc: use separate doctrees for distinct builders
It seems our previous attempt with order-only targets was not
sufficient to avoid problems with sphinx-builds doctree cache [0].
Looking around at other people's approaches [1], using separate
doctrees was suggested. I guess there might be a slight loss of
efficiency, but it seems more robust.
[0]: build failures were first noticed in Debian experimental, but I was able to duplicate it in
my usual build environment about 1 in 8 builds.
[1]: in particular
https://salsa.debian.org/mpd-team/mpc/commit/9e3fc1657d043d75755993846c93f7700b97f907
Diffstat (limited to 'doc/Makefile.local')
| -rw-r--r-- | doc/Makefile.local | 16 |
1 files changed, 4 insertions, 12 deletions
diff --git a/doc/Makefile.local b/doc/Makefile.local index 651168f4..719172fe 100644 --- a/doc/Makefile.local +++ b/doc/Makefile.local @@ -8,7 +8,7 @@ SPHINXBUILD = HAVE_EMACS=${HAVE_EMACS} sphinx-build DOCBUILDDIR := $(dir)/_build # Internal variables. -ALLSPHINXOPTS := -d $(DOCBUILDDIR)/doctrees $(SPHINXOPTS) $(srcdir)/$(dir) +ALLSPHINXOPTS := $(SPHINXOPTS) $(srcdir)/$(dir) APIMAN := $(DOCBUILDDIR)/man/man3/notmuch.3 DOXYFILE := $(srcdir)/$(dir)/doxygen.cfg @@ -42,24 +42,16 @@ ifeq ($(WITH_EMACS),1) $(DOCBUILDDIR)/.roff.stamp sphinx-html sphinx-texinfo: docstring.stamp endif -# Sequentialize the calls to sphinx-build to avoid races with -# reading/writing cached state. This uses GNU make specific -# "order-only" prerequisites. - -sphinx-html: | $(DOCBUILDDIR)/.roff.stamp -sphinx-texinfo: | sphinx-html -sphinx-info: | sphinx-texinfo - sphinx-html: $(DOCBUILDDIR)/.html.stamp $(DOCBUILDDIR)/.html.stamp: $(ALL_RST_FILES) - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html + $(SPHINXBUILD) -b html -d $(DOCBUILDDIR)/html_doctrees $(ALLSPHINXOPTS) $(DOCBUILDDIR)/html touch $@ sphinx-texinfo: $(DOCBUILDDIR)/.texi.stamp $(DOCBUILDDIR)/.texi.stamp: $(ALL_RST_FILES) - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo + $(SPHINXBUILD) -b texinfo -d $(DOCBUILDDIR)/texinfo_doctrees $(ALLSPHINXOPTS) $(DOCBUILDDIR)/texinfo touch $@ sphinx-info: sphinx-texinfo @@ -75,7 +67,7 @@ ${MAN_ROFF_FILES}: $(DOCBUILDDIR)/.roff.stamp # instance of this recipe for each roff file. $(DOCBUILDDIR)/.roff.stamp: ${MAN_RST_FILES} ifeq ($(HAVE_SPHINX),1) - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man + $(SPHINXBUILD) -b man -d $(DOCBUILDDIR)/man_doctrees $(ALLSPHINXOPTS) $(DOCBUILDDIR)/man for section in 1 5 7; do \ mkdir -p $(DOCBUILDDIR)/man/man$${section}; \ mv $(DOCBUILDDIR)/man/*.$${section} $(DOCBUILDDIR)/man/man$${section}; \ |