doc: Convert nvmf doc to markdown (4aba7b49) · Commits · Public Repositories / spdk

doc/Doxyfile

+2 −2

Original line number	Diff line number	Diff line
		@@ -766,8 +766,8 @@ INPUT = ../include/spdk \
		nvme/async_completion.md \
		nvme/initialization.md \
		nvme/io_submission.md \
		nvmf/index.txt \
		nvmf/getting_started.txt \
		nvmf/index.md \
		nvmf/getting_started.md \
		iscsi/index.txt \
		iscsi/getting_started.txt

doc/index.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -18,6 +18,6 @@ which avoids kernel context switches and eliminates interrupt handling overhead.
		## Modules {#modules}

		- @ref nvme
		- \ref nvmf
		- @ref nvmf
		- @ref ioat
		- \ref iscsi

doc/nvmf/getting_started.txt→doc/nvmf/getting_started.md

+11 −47

Original line number	Diff line number	Diff line
		/*-
		* 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 nvmf_getting_started NVMe over Fabrics Target Getting Started Guide
		# Getting Started Guide {#nvmf_getting_started}

		The NVMe over Fabrics target is a user space application that presents block devices over the
		network using RDMA. It requires an RDMA-capable NIC with its corresponding OFED software package
		@@ -52,32 +18,32 @@ machine, the kernel will need to be a release candidate until the code is actual
		system running the SPDK target, however, you can run any modern flavor of Linux as required by your
		NIC vendor's OFED distribution.

		\section nvmf_prereqs Prerequisites
		# Prerequisites {#nvmf_prereqs}

		This guide starts by assuming that you can already build the standard SPDK distribution on your
		platform. By default, the NVMe over Fabrics target is not built. To build nvmf_tgt there are some
		additional dependencies.

		Fedora:
		\verbatim
		~~~{.sh}
		dnf install libibverbs-devel librdmacm-devel
		\endverbatim
		~~~

		Ubuntu:
		\verbatim
		~~~{.sh}
		apt-get install libibverbs-dev librdmacm-dev
		\endverbatim
		~~~

		Then build SPDK with RDMA enabled, either by editing CONFIG to enable CONFIG_RDMA or
		enabling it on the `make` command line:

		\verbatim
		~~~{.sh}
		make CONFIG_RDMA=y <other config parameters>
		\endverbatim
		~~~

		Once built, the binary will be in `app/nvmf_tgt`.

		\section nvmf_config Configuring NVMe over Fabrics Target
		# Configuring NVMe over Fabrics Target {#nvmf_config}

		A `nvmf_tgt`-specific configuration file is used to configure the NVMe over Fabrics target. This
		file's primary purpose is to define subsystems. A fully documented example configuration file is
		@@ -87,8 +53,6 @@ You should make a copy of the example configuration file, modify it to suit your
		then run the nvmf_tgt application and pass it the configuration file using the -c option. Right now,
		the target requires elevated privileges (root) to run.

		\verbatim
		~~~{.sh}
		app/nvmf_tgt/nvmf_tgt -c /path/to/nvmf.conf
		\endverbatim

		*/
		~~~

doc/nvmf/index.md

0 → 100644

+3 −0

Original line number	Diff line number	Diff line
		# NVMe over Fabrics {#nvmf}

		- @ref nvmf_getting_started

doc/nvmf/index.txt

deleted100644 → 0

+0 −40

Original line number	Diff line number	Diff line
		/*-
		* 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 nvmf NVMe over Fabrics

		- \ref nvmf_getting_started

		*/