f036b1d5e7
The commit 4d8da8ed ("Docs: Update sphinx targets with the build directory")
introduces an additional variable intending to allow an user to specify
a different build directory. Since the variable is not writable from the
outside and also the Docker container used to build doc.coreboot.org
calls the Makefile with `BUILDDIR` instead of `SPHINXDIR`, building the
documentation within the container doesn't work anymore.
Thus, change the variable name to `BUILDDIR` and make it writable.
Steps to reproduce:
cd util/docker
make doc.coreboot.org
make docker-build-docs
Change-Id: Ibc44134cf1996592597252aeb9dcf7ffb3378ee3
Signed-off-by: Felix Singer <felixsinger@posteo.net>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/75893
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Nicholas Chin <nic.c3.14@gmail.com>
Reviewed-by: Elyes Haouas <ehaouas@noos.fr>
Reviewed-by: Martin L Roth <gaumless@gmail.com>
80 lines
2.2 KiB
Makefile
80 lines
2.2 KiB
Makefile
## SPDX-License-Identifier: GPL-2.0-only
|
|
#
|
|
# Makefile for coreboot paper.
|
|
# hacked together by Stefan Reinauer <stepan@openbios.org>
|
|
#
|
|
|
|
PDFLATEX = pdflatex -t a4
|
|
BUILDDIR ?= _build
|
|
|
|
FIGS=codeflow.pdf hypertransport.pdf
|
|
|
|
all: sphinx corebootPortingGuide.pdf
|
|
|
|
SVG2PDF=$(shell command -v svg2pdf)
|
|
INKSCAPE=$(shell command -v inkscape)
|
|
CONVERT=$(shell command -v convert)
|
|
|
|
codeflow.pdf: codeflow.svg
|
|
ifneq ($(strip $(SVG2PDF)),)
|
|
svg2pdf $< $@
|
|
else ifneq ($(strip $(INKSCAPE)),)
|
|
inkscape $< --export-pdf=$@
|
|
else ifneq ($(strip $(CONVERT)),)
|
|
convert $< $@
|
|
endif
|
|
|
|
hypertransport.pdf: hypertransport.svg
|
|
ifneq ($(strip $(SVG2PDF)),)
|
|
svg2pdf $< $@
|
|
else ifneq ($(strip $(INKSCAPE)),)
|
|
inkscape $< --export-pdf=$@
|
|
else ifneq ($(strip $(CONVERT)),)
|
|
convert $< $@
|
|
endif
|
|
|
|
$(BUILDDIR):
|
|
mkdir -p $(BUILDDIR)
|
|
|
|
corebootPortingGuide.toc: $(FIGS) corebootBuildingGuide.tex
|
|
# 2 times to make sure we have a current toc.
|
|
$(PDFLATEX) corebootBuildingGuide.tex
|
|
$(PDFLATEX) corebootBuildingGuide.tex
|
|
|
|
corebootPortingGuide.pdf: $(FIGS) corebootBuildingGuide.tex corebootPortingGuide.toc
|
|
$(PDFLATEX) corebootBuildingGuide.tex
|
|
|
|
sphinx: $(BUILDDIR)
|
|
$(MAKE) -f Makefile.sphinx html BUILDDIR="$(BUILDDIR)"
|
|
|
|
clean-sphinx:
|
|
$(MAKE) -f Makefile.sphinx clean BUILDDIR="$(BUILDDIR)"
|
|
|
|
clean: clean-sphinx
|
|
rm -f *.aux *.idx *.log *.toc *.out $(FIGS)
|
|
|
|
distclean: clean
|
|
rm -f corebootPortingGuide.pdf
|
|
|
|
livesphinx: $(BUILDDIR)
|
|
$(MAKE) -f Makefile.sphinx livehtml SPHINXOPTS="$(SPHINXOPTS)" BUILDDIR="$(BUILDDIR)"
|
|
|
|
test:
|
|
@echo "Test for logging purposes - Failing tests will not fail the build"
|
|
-$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx html
|
|
-$(MAKE) -f Makefile.sphinx clean && $(MAKE) -K -f Makefile.sphinx doctest
|
|
|
|
help:
|
|
@echo "all - Builds coreboot porting guide PDF (outdated)"
|
|
@echo "sphinx - Builds html documentation in _build directory"
|
|
@echo "clean - Cleans intermediate files"
|
|
@echo "clean-sphinx - Removes sphinx output files"
|
|
@echo "distclean - Removes PDF files as well"
|
|
@echo "test - Runs documentation tests"
|
|
@echo
|
|
@echo " Makefile.sphinx builds - run with $(MAKE) -f Makefile-sphinx [target]"
|
|
@echo
|
|
@$(MAKE) -s -f Makefile.sphinx help 2>/dev/null
|
|
|
|
.phony: help livesphinx sphinx test
|
|
.phony: distclean clean clean-sphinx
|