diff --git a/deprecation.md b/deprecation.md index c0ea61f7d..a92effb0d 100644 --- a/deprecation.md +++ b/deprecation.md @@ -1,6 +1,6 @@ # Deprecation -## ABI and API Deprecation {#deprecation} +## ABI and API Deprecation This document details the policy for maintaining stability of SPDK ABI and API. @@ -17,7 +17,7 @@ Deprecated code paths must be registered with `SPDK_DEPRECATION_REGISTER()` and log at the warn level when `SPDK_LOG_DEPRECATED()` is called, subject to rate limits. The tags can be matched with the level 4 headers below. -## Deprecation Notices {#deprecation-notices} +## Deprecation Notices ### PMDK diff --git a/doc/.gitignore b/doc/.gitignore index e28511785..eb505d495 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,3 +1,4 @@ -# changelog.md is generated by Makefile +# changelog.md and deprecation.md is generated by Makefile changelog.md +deprecation.md output/ diff --git a/doc/Doxyfile b/doc/Doxyfile index 76d54bacc..691ef6e85 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -813,7 +813,7 @@ INPUT += \ compression.md \ concurrency.md \ containers.md \ - ../deprecation.md \ + deprecation.md \ distributions.md \ event.md \ ftl.md \ diff --git a/doc/Makefile b/doc/Makefile index 21ddd7822..13dc66303 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -13,6 +13,10 @@ all: doc doc: output +deprecation.md: ../deprecation.md + $(Q)sed -e 's/^# Deprecation/# Deprecation {#deprecation}/' \ + < $< > $@ + changelog.md: ../CHANGELOG.md $(Q)sed -e 's/^# Changelog/# Changelog {#changelog}/' \ -e 's/^##/#/' \ @@ -20,9 +24,9 @@ changelog.md: ../CHANGELOG.md -e '/# v..\...:/s/\./-/2' \ < $< > $@ -output: Doxyfile changelog.md $(wildcard *.md) $(wildcard ../include/spdk/*.h) +output: Doxyfile changelog.md deprecation.md $(wildcard *.md) $(wildcard ../include/spdk/*.h) $(Q)rm -rf $@ $(Q)doxygen Doxyfile clean: - $(Q)rm -rf output changelog.md + $(Q)rm -rf output changelog.md deprecation.md