From: Robert Schwebel <r.schwebel@pengutronix.de>
To: barebox@lists.infradead.org
Subject: [PATCH 3/3] doc: put barebox version into documentation
Date: Mon, 15 Nov 2010 10:02:27 +0100 [thread overview]
Message-ID: <1289811747-28742-4-git-send-email-r.schwebel@pengutronix.de> (raw)
In-Reply-To: <1289811747-28742-1-git-send-email-r.schwebel@pengutronix.de>
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>
---
.gitignore | 3 +++
Doxyfile | 2 +-
Makefile | 7 +++++--
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
--
1.7.2.3
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
prev parent reply other threads:[~2010-11-15 9:03 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-11-15 9:02 More documentation updates Robert Schwebel
2010-11-15 9:02 ` [PATCH 1/3] doc: sort list alphabetically Robert Schwebel
2010-11-15 9:02 ` [PATCH 2/3] doc: add missing commands Robert Schwebel
2010-11-15 9:02 ` Robert Schwebel [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1289811747-28742-4-git-send-email-r.schwebel@pengutronix.de \
--to=r.schwebel@pengutronix.de \
--cc=barebox@lists.infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox