summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorMartin Roth <gaumless@gmail.com>2023-05-29 23:02:10 -0600
committerFelix Singer <service+coreboot-gerrit@felixsinger.de>2023-06-02 22:45:28 +0000
commite441b3191771df3d1ec417d2ef73cad3f5f68cb5 (patch)
tree210c468acfd4e39cff16c9a97c243cdc6ddf0630 /Documentation
parent61f0a0882d0feb3c7bdee1967ccf163b5923c8ec (diff)
downloadcoreboot-e441b3191771df3d1ec417d2ef73cad3f5f68cb5.tar.gz
coreboot-e441b3191771df3d1ec417d2ef73cad3f5f68cb5.tar.bz2
coreboot-e441b3191771df3d1ec417d2ef73cad3f5f68cb5.zip
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 <gaumless@gmail.com> Change-Id: Ie61d44d87e8628e12d01f3355360e2a679b5ce85 Reviewed-on: https://review.coreboot.org/c/coreboot/+/75496 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Felix Singer <service+coreboot-gerrit@felixsinger.de>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/Makefile14
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 74e2bb858003..12f0ec73fb0a 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