Commit 0269601f authored by Daniel Verkamp's avatar Daniel Verkamp
Browse files

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: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-on: https://review.gerrithub.io/375251


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent ea952fca

autobuild.sh

+1 −0
Original line number Diff line number Diff line
@@ -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

doc/.gitignore

0 → 100644
+2 −0
Original line number Diff line number Diff line 
# changelog.md is generated by Makefile

changelog.md

doc/Doxyfile

+1 −0
Original line number Diff line number Diff line
@@ -782,6 +782,7 @@ WARN_LOGFILE = 


INPUT                  = ../include/spdk \

                         index.md \

                         changelog.md \

                         directory_structure.md \

                         memory.md \

                         porting.md \

doc/Makefile

+9 −2
Original line number Diff line number Diff line
@@ -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

doc/index.md

+1 −0
Original line number Diff line number Diff line
@@ -17,6 +17,7 @@ handling overhead. 
 - @ref directory_structure

 - @ref memory

 - @ref porting

 - @ref changelog

 - [Public API header files](files.html)



## Modules {#modules}