From 0269601f77a2ccadf8601b76b87de8da9235afca Mon Sep 17 00:00:00 2001
From: Daniel Verkamp <daniel.verkamp@intel.com>
Date: Tue, 22 Aug 2017 16:13:22 -0700
Subject: [PATCH] doc: include changelog in documentation

This copies the top-level CHANGELOG.md into a temporary doc/changelog.md
file so it can add the Doxygen-specific {#changelog} name tag.

Change-Id: I2fb3087dc15036e58cb7719f67c434897c39821c
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-on: https://review.gerrithub.io/375251
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
---
 autobuild.sh   |  1 +
 doc/.gitignore |  2 ++
 doc/Doxyfile   |  1 +
 doc/Makefile   | 11 +++++++++--
 doc/index.md   |  1 +
 5 files changed, 14 insertions(+), 2 deletions(-)
 create mode 100644 doc/.gitignore

diff --git a/autobuild.sh b/autobuild.sh
index 7521326b6..0ae16937a 100755
--- a/autobuild.sh
+++ b/autobuild.sh
@@ -86,6 +86,7 @@ if [ $SPDK_BUILD_DOC -eq 1 ] && hash doxygen; then
 	if [ -f "$rootdir"/doc/output/latex/refman.pdf ]; then
 		mv "$rootdir"/doc/output/latex/refman.pdf "$out"/doc/spdk.pdf
 	fi
+	(cd "$rootdir"/doc; $MAKE $MAKEFLAGS clean) &>> "$out"/doxygen.log
 	rm -rf "$rootdir"/doc/output
 fi
 timing_exit doxygen
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 000000000..679389977
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,2 @@
+# changelog.md is generated by Makefile
+changelog.md
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 042167de0..617e8c676 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -782,6 +782,7 @@ WARN_LOGFILE           =
 
 INPUT                  = ../include/spdk \
                          index.md \
+                         changelog.md \
                          directory_structure.md \
                          memory.md \
                          porting.md \
diff --git a/doc/Makefile b/doc/Makefile
index 9a8536152..4079ff926 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -4,9 +4,16 @@ all: doc
 
 doc: output
 
-output: Doxyfile
+changelog.md: ../CHANGELOG.md
+	sed -e 's/^# Changelog/# Changelog {#changelog}/' \
+	    -e 's/^##/#/' \
+	    -e 's/^# \(\(v..\...\):.*\)/# \1 {#changelog-\2}/' \
+	    -e '/# v..\...:/s/\./-/2' \
+	    < $< > $@
+
+output: Doxyfile changelog.md
 	rm -rf $@
 	doxygen Doxyfile
 
 clean:
-	rm -rf output
+	rm -rf output changelog.md
diff --git a/doc/index.md b/doc/index.md
index 6654dccb9..63435bcf7 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -17,6 +17,7 @@ handling overhead.
  - @ref directory_structure
  - @ref memory
  - @ref porting
+ - @ref changelog
  - [Public API header files](files.html)
 
 ## Modules {#modules}