Commit 4b1f79b5 authored by Daniel Verkamp's avatar Daniel Verkamp
Browse files

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: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent 4671dbd5

autobuild.sh

+2 −5
Original line number Diff line number Diff line
@@ -57,11 +57,8 @@ timing_enter doxygen 
if hash doxygen; then

	(cd "$rootdir"/doc; $MAKE $MAKEFLAGS)

	mkdir -p "$out"/doc

	for d in "$rootdir"/doc/output.*; do

		component=$(basename "$d" | sed -e 's/^output.//')

		mv "$d"/html "$out"/doc/$component

		rm -rf "$d"

	done

	mv "$rootdir"/doc/output/html "$out"/doc

	rm -rf "$rootdir"/doc/output

fi

timing_exit doxygen

doc/Doxyfile.nvme→doc/Doxyfile

+4 −2
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 
# title of most generated pages and in a few other places.

# The default value is: My Project.



PROJECT_NAME           = "SPDK Userspace NVMe Driver"

PROJECT_NAME           = "SPDK"



# The PROJECT_NUMBER tag can be used to enter a project or revision number. This

# could be handy for archiving the generated documentation or if some version
@@ -58,7 +58,7 @@ PROJECT_LOGO = 
# entered, it will be relative to the location where doxygen was started. If

# left blank the current directory will be used.



OUTPUT_DIRECTORY       = output.nvme

OUTPUT_DIRECTORY       = output



# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-

# directories (in 2 levels) under the output directory of each output format and
@@ -760,6 +760,8 @@ WARN_LOGFILE = 


INPUT                  = ../lib/nvme \

                         ../include/spdk \

                         mainpage.txt \

                         ioat.index.txt \

                         nvme.index.txt



# This tag can be used to specify the character encoding of the source files

doc/Doxyfile.ioat

deleted100644 → 0
+0 −2367

File deleted.

Preview size limit exceeded, changes collapsed.

doc/Makefile

+4 −7
Original line number Diff line number Diff line 
DOXYFILES = Doxyfile.ioat Doxyfile.nvme

OUTPUT_DIRS = $(patsubst Doxyfile.%,output.%,$(DOXYFILES))



all: doc



.PHONY: all doc clean



doc: $(OUTPUT_DIRS)

doc: output



output.%: Doxyfile.%

output: Doxyfile

	rm -rf $@

	doxygen $^

	doxygen Doxyfile



clean:

	rm -rf $(OUTPUT_DIRS)
 
	rm -rf output

doc/ioat.index.txt

+1 −1
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ 


/*!



\mainpage SPDK Userspace I/OAT Driver

\page ioat I/OAT Driver



\section interface Public Interface