diff options
author | Martin Roth <martinroth@google.com> | 2016-07-07 15:50:28 -0600 |
---|---|---|
committer | Martin Roth <martinroth@google.com> | 2017-03-23 21:19:34 +0100 |
commit | b1574e3b4a9200721afb4d251fedc4a1f0a6656b (patch) | |
tree | a0d47ab48671358596d39c75ac6ceca720f6e32a /Makefile | |
parent | 8e6e24913ea9fd30a03dee5a9f2af62aed4f9586 (diff) |
Documentation: Add doxygen_platform target
Create a doxygen target that builds documentation just for the platform
that is currently selected in Kconfig. This gives us something that is
much more useful to most people.
Change-Id: I25c3cdac2dd383b89df6389ba9011dac913a0a9b
Signed-off-by: Martin Roth <martinroth@google.com>
Reviewed-on: https://review.coreboot.org/15577
Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Tested-by: build bot (Jenkins)
Reviewed-by: Patrick Georgi <pgeorgi@google.com>
Diffstat (limited to 'Makefile')
-rw-r--r-- | Makefile | 10 |
1 files changed, 10 insertions, 0 deletions
@@ -91,6 +91,7 @@ help_coreboot help:: @echo ' clean - Remove coreboot build artifacts' @echo ' distclean - Remove build artifacts and config files' @echo ' doxygen - Build doxygen documentation for coreboot' + @echo ' doxyplatform - Build doxygen documentation for the current platform' @echo ' what-jenkins-does - Run platform build tests (Use CPUS=# for more cores)' @echo ' printall - print makefile info for debugging' @echo ' lint / lint-stable - run coreboot lint tools (all / minimal)' @@ -381,6 +382,15 @@ doxygen: doxygen_simple: $(DOXYGEN) Documentation/Doxyfile.coreboot_simple +doxyplatform doxygen_platform: $(obj)/project_filelist.txt + echo + echo "Building doxygen documentation for $(CONFIG_MAINBOARD_PART_NUMBER)" + export DOXYGEN_OUTPUT_DIR="$(DOXYGEN_OUTPUT_DIR)/$(CONFIG_MAINBOARD_VENDOR)/$(CONFIG_MAINBOARD_PART_NUMBER)"; \ + mkdir -p "$$DOXYGEN_OUTPUT_DIR"; \ + export DOXYFILES="$$(cat $(obj)/project_filelist.txt | grep -v '\.ld$$' | sed 's/\.aml/\.dsl/' | tr '\n' ' ')"; \ + export DOXYGEN_PLATFORM="$(CONFIG_MAINBOARD_DIR) ($(CONFIG_MAINBOARD_PART_NUMBER)) version $(KERNELVERSION)"; \ + $(DOXYGEN) Documentation/doxygen/Doxyfile.coreboot_platform + doxyclean: doxygen-clean doxygen-clean: rm -rf $(DOXYGEN_OUTPUT_DIR) |