erebion/coreboot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

UPSTREAM: Documentation: Add doxygen_platform target

Browse source 
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.

BUG=none
BRANCH=none
TEST=none

Change-Id: I898a4044b8f42388a4b4bf82db762ef79ad69309
Signed-off-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Commit-Id: b1574e3b4a
Original-Change-Id: I25c3cdac2dd383b89df6389ba9011dac913a0a9b
Original-Signed-off-by: Martin Roth <martinroth@google.com>
Original-Reviewed-on: https://review.coreboot.org/15577
Original-Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com>
Original-Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Original-Tested-by: build bot (Jenkins)
Original-Reviewed-by: Patrick Georgi <pgeorgi@google.com>
Reviewed-on: https://chromium-review.googlesource.com/459668
This commit is contained in:
Martin Roth 2016-07-07 15:50:28 -06:00 • committed by chrome-bot
commit 77e6c4e112
2 changed files with 329 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
Makefile
View file

@ -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)