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

doc: add a section for user guides

Browse Source 
Change-Id: I8982bf656adc4fec6990cdd95e5ece71fb0a953b
Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-on: https://review.gerrithub.io/379907
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Daniel Verkamp 2017-09-25 16:26:56 -07:00 committed by Jim Harris
parent 130d278adf
commit c94bb669ca
3 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/index.md
View File

@ -6,6 +6,12 @@
- @ref changelog - @ref changelog
- [Source Code (GitHub)](https://github.com/spdk/spdk/) - [Source Code (GitHub)](https://github.com/spdk/spdk/)
# User Guides {#user_guides}
- @ref iscsi_getting_started
- @ref nvmf_getting_started
- @ref blobfs_getting_started
# General Information {#general} # General Information {#general}
- @ref directory_structure - @ref directory_structure

2
doc/iscsi.md
View File

@ -1,6 +1,6 @@
# iSCSI Target {#iscsi} # iSCSI Target {#iscsi}
# Getting Started Guide {#iscsi_getting_started} # iSCSI Target Getting Started Guide {#iscsi_getting_started}
The Intel(R) Storage Performance Development Kit iSCSI target application is named `iscsi_tgt`. The Intel(R) Storage Performance Development Kit iSCSI target application is named `iscsi_tgt`.
This following section describes how to run iscsi from your cloned package. This following section describes how to run iscsi from your cloned package.

2
doc/nvmf.md
View File

@ -3,7 +3,7 @@
@sa @ref nvme_fabrics_host @sa @ref nvme_fabrics_host
# Getting Started Guide {#nvmf_getting_started} # NVMe-oF Target Getting Started Guide {#nvmf_getting_started}
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