From e441b3191771df3d1ec417d2ef73cad3f5f68cb5 Mon Sep 17 00:00:00 2001 From: Martin Roth Date: Mon, 29 May 2023 23:02:10 -0600 Subject: [PATCH] Docs: Add help target and .phony identifiers This change adds a help target so we can see what the valid targets are and what they do, and also identifies the phony targets. Signed-off-by: Martin Roth Change-Id: Ie61d44d87e8628e12d01f3355360e2a679b5ce85 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75496 Tested-by: build bot (Jenkins) Reviewed-by: Felix Singer --- Documentation/Makefile | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/Documentation/Makefile b/Documentation/Makefile index 74e2bb8580..12f0ec73fb 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -54,3 +54,17 @@ distclean: clean livesphinx: $(MAKE) -f Makefile.sphinx livehtml SPHINXOPTS="$(SPHINXOPTS)" + +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 + @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