summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobert Schwebel <r.schwebel@pengutronix.de>2010-11-12 21:13:16 +0100
committerRobert Schwebel <r.schwebel@pengutronix.de>2010-11-15 09:57:26 +0100
commit4ce5028ecd5992e492b8f7bbfb20bf3eddb7d414 (patch)
treea6b76d8b3bb1883260b1b000066d657d41737f30
parent507480dd0acb640cacdd3978ade11e1b9df4ab1e (diff)
downloadbarebox-4ce5028ecd5992e492b8f7bbfb20bf3eddb7d414.tar.gz
doc: put barebox version into documentation
Currently the documentation does always claim to be version 1. We add the revision plus the git version to the manual. Signed-off-by: Robert Schwebel <r.schwebel@pengutronix.de>
-rw-r--r--.gitignore3
-rw-r--r--Doxyfile2
-rw-r--r--Makefile7
3 files changed, 9 insertions, 3 deletions
diff --git a/.gitignore b/.gitignore
index 2c580c6..4a45113 100644
--- a/.gitignore
+++ b/.gitignore
@@ -48,6 +48,9 @@ include/config
include/linux/compile.h
include/generated
+# Generated files
+Doxyfile.version
+
# stgit generated dirs
patches-*
diff --git a/Doxyfile b/Doxyfile
index d9ce22c..89151e3 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -31,7 +31,7 @@ PROJECT_NAME = barebox
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = 1
+@INCLUDE = Doxyfile.version
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
diff --git a/Makefile b/Makefile
index ae32b50..4e1c011 100644
--- a/Makefile
+++ b/Makefile
@@ -762,6 +762,9 @@ include/config/kernel.release: include/config/auto.conf FORCE
$(Q)rm -f $@
$(Q)echo $(kernelrelease) > $@
+Doxyfile.version: include/config/auto.conf FORCE
+ $(Q)rm -f $@
+ $(Q)echo "PROJECT_NUMBER = $(KERNELRELEASE)" > $@
# Things we need to do before we recursively start building the kernel
# or the modules are listed in "prepare".
@@ -973,7 +976,7 @@ endif # CONFIG_MODULES
CLEAN_DIRS += $(MODVERDIR)
CLEAN_FILES += barebox System.map include/generated/barebox_default_env.h \
.tmp_version .tmp_barebox* barebox.bin barebox.S \
- .tmp_kallsyms* barebox_default_env barebox.ldr
+ .tmp_kallsyms* barebox_default_env barebox.ldr Doxyfile.version
# Directories & files removed with 'make mrproper'
MRPROPER_DIRS += include/config include2 usr/include
@@ -1098,7 +1101,7 @@ help:
docs : htmldocs
-htmldocs:
+htmldocs: Doxyfile.version
@echo 'Running doxygen with local Doxyfile'
$(Q)doxygen Doxyfile