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>

autobuild.sh

@@ -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

@@ -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/Makefile

@@ -1,15 +1,12 @@
-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

@@ -33,7 +33,7 @@
 
 /*!
 
-\mainpage SPDK Userspace I/OAT Driver
+\page ioat I/OAT Driver
 
 \section interface Public Interface
 

doc/mainpage.txt

@@ -0,0 +1,43 @@
+/*-
+ *   BSD LICENSE
+ *
+ *   Copyright (c) Intel Corporation.
+ *   All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in
+ *       the documentation and/or other materials provided with the
+ *       distribution.
+ *     * Neither the name of Intel Corporation nor the names of its
+ *       contributors may be used to endorse or promote products derived
+ *       from this software without specific prior written permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/*!
+
+\mainpage SPDK Documentation
+
+\section modules Modules
+
+- \ref nvme
+- \ref ioat
+
+*/

doc/nvme.index.txt

@@ -33,7 +33,7 @@
 
 /*!
 
-\mainpage SPDK Userspace NVMe Driver
+\page nvme NVMe Driver
 
 \section interface Public Interface