numam-spdk/doc/Makefile

SPDK_ROOT_DIR := $(abspath $(CURDIR)/..)
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk

all: doc
	@:

.PHONY: all doc clean

doc: output

changelog.md: ../CHANGELOG.md
	$(Q)sed -e 's/^# Changelog/# Changelog {#changelog}/' \
	    -e 's/^##/#/' \
	    -e 's/^# \(\(v..\...\):.*\)/# \1 {#changelog-\2}/' \
	    -e '/# v..\...:/s/\./-/2' \
	    < $< > $@

output: Doxyfile changelog.md $(wildcard *.md) $(wildcard ../include/spdk/*.h)
	$(Q)rm -rf $@
	$(Q)doxygen Doxyfile

clean:
	$(Q)rm -rf output changelog.md
doc/Makefile: include mk/spdk.common.mk This allows us to use the $(Q) variable in this Makefile. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I1f9c54fb8c995bdee9749683b409152472366cbc Reviewed-on: https://review.gerrithub.io/415872 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> 2018-06-18 14:59:02 +00:00			`SPDK_ROOT_DIR := $(abspath $(CURDIR)/..)`
			`include $(SPDK_ROOT_DIR)/mk/spdk.common.mk`

SPDK: Initial check-in Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2015-09-21 15:52:41 +00:00			`all: doc`
build/doc: add dependencies to 'output' rule Make the docs depend on all of the public header files and Markdown files. Without this, the docs never get rebuilt without a manual 'make clean'. While we're here, add '@:' to the 'all' rule to silence it. Change-Id: I304a1bb30464d2a0a60a1c117b7be1f7e543e15c Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-on: https://review.gerrithub.io/399954 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2018-02-14 21:59:51 +00:00			`@:`
SPDK: Initial check-in Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2015-09-21 15:52:41 +00:00
			`.PHONY: all doc clean`

doc: merge ioat and nvme into a single Doxyfile Add a top-level index page and convert the I/OAT and NVMe main pages into normal pages. Change-Id: I4e7c8d2fd43303a8aa56de921037dac96fe8a1a5 Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2016-03-25 16:54:24 +00:00			`doc: output`
SPDK: Initial check-in Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2015-09-21 15:52:41 +00:00
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> 2017-08-22 23:13:22 +00:00			`changelog.md: ../CHANGELOG.md`
doc/Makefile: include mk/spdk.common.mk This allows us to use the $(Q) variable in this Makefile. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I1f9c54fb8c995bdee9749683b409152472366cbc Reviewed-on: https://review.gerrithub.io/415872 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> 2018-06-18 14:59:02 +00:00			`$(Q)sed -e 's/^# Changelog/# Changelog {#changelog}/' \`
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> 2017-08-22 23:13:22 +00:00			`-e 's/^##/#/' \`
			`-e 's/^# \(\(v..\...\):.*\)/# \1 {#changelog-\2}/' \`
			`-e '/# v..\...:/s/\./-/2' \`
			`< $< > $@`

build/doc: add dependencies to 'output' rule Make the docs depend on all of the public header files and Markdown files. Without this, the docs never get rebuilt without a manual 'make clean'. While we're here, add '@:' to the 'all' rule to silence it. Change-Id: I304a1bb30464d2a0a60a1c117b7be1f7e543e15c Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-on: https://review.gerrithub.io/399954 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> 2018-02-14 21:59:51 +00:00			`output: Doxyfile changelog.md $(wildcard .md) $(wildcard ../include/spdk/.h)`
doc/Makefile: include mk/spdk.common.mk This allows us to use the $(Q) variable in this Makefile. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I1f9c54fb8c995bdee9749683b409152472366cbc Reviewed-on: https://review.gerrithub.io/415872 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> 2018-06-18 14:59:02 +00:00			`$(Q)rm -rf $@`
			`$(Q)doxygen Doxyfile`
SPDK: Initial check-in Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> 2015-09-21 15:52:41 +00:00
			`clean:`
doc/Makefile: include mk/spdk.common.mk This allows us to use the $(Q) variable in this Makefile. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: I1f9c54fb8c995bdee9749683b409152472366cbc Reviewed-on: https://review.gerrithub.io/415872 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> 2018-06-18 14:59:02 +00:00			`$(Q)rm -rf output changelog.md`