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>
This commit is contained in:
parent
ea952fcaf2
commit
0269601f77
@ -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
|
||||
|
2
doc/.gitignore
vendored
Normal file
2
doc/.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
# changelog.md is generated by Makefile
|
||||
changelog.md
|
@ -782,6 +782,7 @@ WARN_LOGFILE =
|
||||
|
||||
INPUT = ../include/spdk \
|
||||
index.md \
|
||||
changelog.md \
|
||||
directory_structure.md \
|
||||
memory.md \
|
||||
porting.md \
|
||||
|
11
doc/Makefile
11
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
|
||||
|
@ -17,6 +17,7 @@ handling overhead.
|
||||
- @ref directory_structure
|
||||
- @ref memory
|
||||
- @ref porting
|
||||
- @ref changelog
|
||||
- [Public API header files](files.html)
|
||||
|
||||
## Modules {#modules}
|
||||
|
Loading…
Reference in New Issue
Block a user