diff --git a/doc/Doxyfile b/doc/Doxyfile index 640482d309..67ae879a5f 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -759,7 +759,7 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = ../include/spdk \ - mainpage.txt \ + index.md \ directory_structure.txt \ ioat/index.txt \ nvme/index.txt \ diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 0000000000..2130a122bd --- /dev/null +++ b/doc/index.md @@ -0,0 +1,23 @@ +# Storage Performance Development Kit {#index} + +# Introduction {#intro} + +- [SPDK on GitHub](https://github.com/spdk/spdk/) +- [SPDK.io](http://www.spdk.io/) + +The Storage Performance Development Kit (SPDK) provides a set of tools and libraries +for writing high performance, scalable, user-mode storage applications. +It achieves high performance by moving all of the necessary drivers +into userspace and operating in a polled mode instead of relying on interrupts, +which avoids kernel context switches and eliminates interrupt handling overhead. + +## General Information {#general} + + - \ref directory_structure + +## Modules {#modules} + +- \ref nvme +- \ref nvmf +- \ref ioat +- \ref iscsi diff --git a/doc/mainpage.txt b/doc/mainpage.txt deleted file mode 100644 index 11a7bd6320..0000000000 --- a/doc/mainpage.txt +++ /dev/null @@ -1,60 +0,0 @@ -/*- - * 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 intro Storage Performance Development Kit - -- SPDK on GitHub -- SPDK.io - -The Storage Performance Development Kit (SPDK) provides a set of tools and libraries -for writing high performance, scalable, user-mode storage applications. -It achieves high performance by moving all of the necessary drivers -into userspace and operating in a polled mode instead of relying on interrupts, -which avoids kernel context switches and eliminates interrupt handling overhead. - -\section general General Information - - - \ref directory_structure - -\section modules Modules - -- \ref nvme -- \ref nvmf -- \ref ioat -- \ref iscsi - -*/