From 58ca5c52ff23902d62f061b2adce0bf18b582b95 Mon Sep 17 00:00:00 2001 From: Ben Walker Date: Wed, 4 Jan 2017 14:40:14 -0700 Subject: [PATCH] doc: Convert ioat doc to markdown Change-Id: Ic0f8fa4aa57d6fc58813fcbb6d72ff5477ab293f Signed-off-by: Ben Walker --- doc/Doxyfile | 2 +- doc/index.md | 2 +- doc/ioat/index.md | 14 +++++++++++++ doc/ioat/index.txt | 51 ---------------------------------------------- 4 files changed, 16 insertions(+), 53 deletions(-) create mode 100644 doc/ioat/index.md delete mode 100644 doc/ioat/index.txt diff --git a/doc/Doxyfile b/doc/Doxyfile index 5ecab3be6..96cd4e902 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -761,7 +761,7 @@ WARN_LOGFILE = INPUT = ../include/spdk \ index.md \ directory_structure.md \ - ioat/index.txt \ + ioat/index.md \ nvme/index.md \ nvme/async_completion.md \ nvme/initialization.md \ diff --git a/doc/index.md b/doc/index.md index 11ff39730..6a1eeb2c8 100644 --- a/doc/index.md +++ b/doc/index.md @@ -19,5 +19,5 @@ which avoids kernel context switches and eliminates interrupt handling overhead. - @ref nvme - \ref nvmf -- \ref ioat +- @ref ioat - \ref iscsi diff --git a/doc/ioat/index.md b/doc/ioat/index.md new file mode 100644 index 000000000..1eb4a27f7 --- /dev/null +++ b/doc/ioat/index.md @@ -0,0 +1,14 @@ +# I/OAT Driver {#ioat} + +# Public Interface {#ioat_interface} + +- spdk/ioat.h + +# Key Functions {#ioat_key_functions} + +Function | Description +--------------------------------------- | ----------- +spdk_ioat_probe() | @copybrief spdk_ioat_probe() +spdk_ioat_get_dma_capabilities() | @copybrief spdk_ioat_get_dma_capabilities() +spdk_ioat_submit_copy() | @copybrief spdk_ioat_submit_copy() +spdk_ioat_submit_fill() | @copybrief spdk_ioat_submit_fill() diff --git a/doc/ioat/index.txt b/doc/ioat/index.txt deleted file mode 100644 index a6babd778..000000000 --- a/doc/ioat/index.txt +++ /dev/null @@ -1,51 +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. - */ - -/*! - -\page ioat I/OAT Driver - -\section ioat_interface Public Interface - -- spdk/ioat.h - -\section ioat_key_functions Key Functions - -Function | Description ---------------------------------------- | ----------- -spdk_ioat_probe() | \copybrief spdk_ioat_probe() -spdk_ioat_get_dma_capabilities() | \copybrief spdk_ioat_get_dma_capabilities() -spdk_ioat_submit_copy() | \copybrief spdk_ioat_submit_copy() -spdk_ioat_submit_fill() | \copybrief spdk_ioat_submit_fill() - -*/