Commit 0fc7daff authored by Daniel Verkamp's avatar Daniel Verkamp
Browse files

Replace "NVMf" with "NVMe over Fabrics" in docs 



Use the final official spec name rather than a non-standard
abbreviation.

Change-Id: I4d797294be35b2fbf7b39570ea3246eb71c8d8ce
Signed-off-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
parent 181e568e

CHANGELOG.md

+3 −2
Original line number Diff line number Diff line 
Changelog

=========



v16.08: iSCSI target, NVMf maturity

-----------------------------------

v16.08: iSCSI target, NVMe over Fabrics maturity

------------------------------------------------



This release adds a userspace iSCSI target. The iSCSI target is capable of exporting

NVMe devices over a network using the iSCSI protocol. The application is located

in app/iscsi_tgt and a documented configuration file can be found at etc/spdk/spdk.conf.in.

README.md

+3 −3
Original line number Diff line number Diff line
@@ -17,7 +17,7 @@ handling overhead. 
The development kit currently includes:

* NVMe driver

* I/OAT (DMA engine) driver

* NVMf target

* NVMe over Fabrics target



Documentation

=============
@@ -38,13 +38,13 @@ To build SPDK, some dependencies must be installed. 
Fedora/CentOS:



    sudo dnf install -y gcc libpciaccess-devel CUnit-devel libaio-devel openssl-devel

    # Additional dependencies for NVMf:

    # Additional dependencies for NVMe over Fabrics:

    sudo dnf install -y libibverbs-devel librdmacm-devel



Ubuntu/Debian:



    sudo apt-get install -y gcc libpciaccess-dev make libcunit1-dev libaio-dev libssl-dev

    # Additional dependencies for NVMf:

    # Additional dependencies for NVMe over Fabrics:

    sudo apt-get install -y libibverbs-dev librdmacm-dev



FreeBSD:

doc/nvmf/getting_started.txt

+6 −6
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ 
 */



/**

 * \page nvmf_getting_started NVMf Getting Started Guide

 * \page nvmf_getting_started NVMe over Fabrics Target Getting Started Guide



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
@@ -55,8 +55,8 @@ NIC vendor's OFED distribution. 
\section nvmf_prereqs Prerequisites



This guide starts by assuming that you can already build the standard SPDK distribution on your

platform. By default, the NVMf target is not built. To build NVMf there are some additional

dependencies.

platform. By default, the NVMe over Fabrics target is not built. To build nvmf_tgt there are some

additional dependencies.



Fedora:

\verbatim
@@ -68,7 +68,7 @@ Ubuntu: 
apt-get install libibverbs-dev librdmacm-dev

\endverbatim



Then build SPDK with the NVMf target enabled, either by editing CONFIG to enable CONFIG_RDMA or

Then build SPDK with RDMA enabled, either by editing CONFIG to enable CONFIG_RDMA or

enabling it on the `make` command line:



\verbatim
@@ -77,9 +77,9 @@ make CONFIG_RDMA=y <other config parameters> 


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



\section nvmf_config Configuring NVMf

\section nvmf_config Configuring NVMe over Fabrics Target



An NVMf specific configuration file is used to configure, or 'provision', the NVMf target. This 

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

located at `etc/spdk/nvmf.conf.in`.