summaryrefslogtreecommitdiff
path: root/Makefile
diff options
context:
space:
mode:
authorMartin Roth <gaumless@gmail.com>2014-12-29 14:56:19 -0700
committerMartin Roth <gaumless@gmail.com>2015-01-08 21:59:17 +0100
commitd7689e4ad588ee1affee1d4edb3e5b0bd8098b0a (patch)
tree07d7388ffa84b776c5f8562a26ecb606e415f1dd /Makefile
parentf4cb4128adea4b8ebdd92ae05d7d8e733e35eb1c (diff)
downloadcoreboot-d7689e4ad588ee1affee1d4edb3e5b0bd8098b0a.tar.xz
Doxygen: add a "simple" output config and make target
This is a doxygen target I'm using for cleaning up the coreboot doxygen output. It runs in about a minute instead of.... a lot longer, and only generates documentation for the coreboot/src directory, excluding vendorcode. It was requested that the comments be stripped to make it easier to read. This was done through the following command (split for gerrit): head -n 1 Doxyfile.coreboot_simple > Doxyfile.tmp ; cat Doxyfile.coreboot_simple | sed 's|^\s*#.*$||' | sed '/^$/d' | sed 's|[[:space:]]\+$||' >> Doxyfile.tmp ; mv Doxyfile.tmp Doxyfile.coreboot_simple I'm including the command here because any time the file is updated with the doxygen wizard, it will need to be run again. It might be desirable to turn this into a script in the documentation directory. Change-Id: Ic0cbbcd21aa647e80a037481546bdcd2aab8949e Signed-off-by: Martin Roth <gaumless@gmail.com> Reviewed-on: http://review.coreboot.org/8068 Tested-by: build bot (Jenkins) Reviewed-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile5
1 files changed, 4 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 6ef9838919..017ca47ad7 100644
--- a/Makefile
+++ b/Makefile
@@ -263,6 +263,9 @@ doxy: doxygen
doxygen:
$(DOXYGEN) documentation/Doxyfile.coreboot
+doxygen_simple:
+ $(DOXYGEN) documentation/Doxyfile.coreboot_simple
+
doxyclean: doxygen-clean
doxygen-clean:
rm -rf $(DOXYGEN_OUTPUT_DIR)
@@ -279,4 +282,4 @@ clean-cscope:
distclean: clean
rm -f .config .config.old ..config.tmp .kconfig.d .tmpconfig* .ccwrap .xcompile
-.PHONY: $(PHONY) clean clean-for-update clean-cscope cscope distclean doxygen doxy
+.PHONY: $(PHONY) clean clean-for-update clean-cscope cscope distclean doxygen doxy doxygen_simple