From 34e43f602fb7570ce5adea4f0935c608614244f1 Mon Sep 17 00:00:00 2001 From: Martin Roth Date: Mon, 29 May 2023 23:05:09 -0600 Subject: [PATCH] Docs: Add a test target for the documentation The test target will run, but won't fail the build if there are issues. This is so it can be added to the jenkins build and run until it passes. At that point, it can be made to fail if there's an error. Signed-off-by: Martin Roth Change-Id: I5810643ee143f9db4f1cd388531161d4398d596c Reviewed-on: https://review.coreboot.org/c/coreboot/+/75497 Tested-by: build bot (Jenkins) Reviewed-by: Felix Singer --- Documentation/Makefile | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/Makefile b/Documentation/Makefile index 12f0ec73fb..17aec29450 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -55,12 +55,18 @@ distclean: clean livesphinx: $(MAKE) -f Makefile.sphinx livehtml SPHINXOPTS="$(SPHINXOPTS)" +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