ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

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

Change-Id: I4d797294be35b2fbf7b39570ea3246eb71c8d8ce
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
This commit is contained in:
Daniel Verkamp 2016-08-08 16:35:11 -07:00
parent 181e568e7f
commit 0fc7daffe5
3 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGELOG.md
View File

@ -1,8 +1,9 @@
Changelog 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 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 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. in app/iscsi_tgt and a documented configuration file can be found at etc/spdk/spdk.conf.in.

6
README.md
View File

@ -17,7 +17,7 @@ handling overhead.
The development kit currently includes: The development kit currently includes:
* NVMe driver * NVMe driver
* I/OAT (DMA engine) driver * I/OAT (DMA engine) driver
* NVMf target * NVMe over Fabrics target
Documentation Documentation
============= =============
@ -38,13 +38,13 @@ To build SPDK, some dependencies must be installed.
Fedora/CentOS: Fedora/CentOS:
sudo dnf install -y gcc libpciaccess-devel CUnit-devel libaio-devel openssl-devel 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 sudo dnf install -y libibverbs-devel librdmacm-devel
Ubuntu/Debian: Ubuntu/Debian:
sudo apt-get install -y gcc libpciaccess-dev make libcunit1-dev libaio-dev libssl-dev 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 sudo apt-get install -y libibverbs-dev librdmacm-dev
FreeBSD: FreeBSD:

12
doc/nvmf/getting_started.txt
View File

@ -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 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 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 \section nvmf_prereqs Prerequisites
This guide starts by assuming that you can already build the standard SPDK distribution on your 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 platform. By default, the NVMe over Fabrics target is not built. To build nvmf_tgt there are some
dependencies. additional dependencies.
Fedora: Fedora:
\verbatim \verbatim
@ -68,7 +68,7 @@ Ubuntu:
apt-get install libibverbs-dev librdmacm-dev apt-get install libibverbs-dev librdmacm-dev
\endverbatim \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: enabling it on the `make` command line:
\verbatim \verbatim
@ -77,9 +77,9 @@ make CONFIG_RDMA=y <other config parameters>
Once built, the binary will be in `app/nvmf_tgt`. 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 file's primary purpose is to define subsystems. A fully documented example configuration file is
located at `etc/spdk/nvmf.conf.in`. located at `etc/spdk/nvmf.conf.in`.