mirror of
https://github.com/Dasharo/coreboot.git
synced 2026-03-06 14:43:26 -08:00
6d8bb8cf29
Use the -W (--fail-on-warning) flag of sphinx-build to tell it to exit with an error if any warnings are generated. This is intended to fail the coreboot-docs-gerrit build to help catch issues. To allow all warnings to be output in the same build, use the --keep-going flag so that the author is able to see all issues and address them after a single build. Note that this behavior is enabled by default as of Sphinx 8.1 and this option may be removed in the future. It is added here for compatibility with older versions of Sphinx, including the doc.coreboot.org container which uses 7.2.6. Change-Id: I3aa564b79d4d4125a3800023b1b805bf4a50b10a Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/84886 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
50 lines
1.3 KiB
Makefile
50 lines
1.3 KiB
Makefile
## SPDX-License-Identifier: GPL-2.0-only
|
|
#
|
|
# Makefile for coreboot paper.
|
|
# hacked together by Stefan Reinauer <stepan@openbios.org>
|
|
#
|
|
|
|
BUILDDIR ?= _build
|
|
SPHINXOPTS ?= -j auto -W --keep-going
|
|
|
|
export SPHINXOPTS
|
|
|
|
all: sphinx
|
|
|
|
$(BUILDDIR):
|
|
mkdir -p $(BUILDDIR)
|
|
|
|
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 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
|
|
|
|
help:
|
|
@echo "all - Builds all documentation targets"
|
|
@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
|