d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
8a3620ffe0
numam-spdk/doc
History
Ziye Yang 972b78802c doc/nvmf: Revise the NVMe-oF target user guide 
We currently support both RDMA and tcp transport,
so need to revise the user guide doc to add some TCP
transport info.

Change-Id: Ic110a5c2ed1a678706adb5a80fc93bd6520c036d
Signed-off-by: Ziye Yang <optimistyzy@gmail.com>
Reviewed-on: https://review.gerrithub.io/c/438482
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Seth Howell <seth.howell5141@gmail.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
2019-01-18 17:14:29 +00:00
..
img doc/iscsi: update iscsi documentation 2018-08-27 21:30:32 +00:00
.gitignore doc: add output directory to .gitignore 2018-06-19 07:15:50 +00:00
about.md doc: Add an overview page for the project 2018-01-05 12:47:01 -05:00
applications.md app: rename traceflag cmdline option to logflag 2018-12-03 19:50:15 +00:00
bdev_module.md doc: fix up some bdev-related reference errors 2018-06-19 15:18:08 +00:00
bdev_pg.md doc: update a header file about bdev programming guide 2018-12-18 17:27:22 +00:00
bdev.md bdev/virtio: deprecate old bdev construct RPCs 2018-10-18 22:02:48 +00:00
blob.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
blobfs.md test/ioat: remove unnecessary config entires 2018-08-30 14:45:48 +00:00
compression.md doc: add document describing "reduce" compression algorithm 2018-11-07 18:11:49 +00:00
concepts.md doc: use Doxygen subpages for top-level groupings 2018-06-14 16:45:51 +00:00
concurrency.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
directory_structure.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
Doxyfile ftl: Initial headers 2019-01-11 09:15:39 +00:00
driver_modules.md doc: change "Modules" page name to "Driver Modules" 2018-08-22 18:11:24 +00:00
event.md lib: Return instead of exit in event 2018-03-08 11:47:01 -05:00
experimental_tools.md doc: use Doxygen subpages for top-level groupings 2018-06-14 16:45:51 +00:00
footer.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
ftl.md ftl: Initial headers 2019-01-11 09:15:39 +00:00
general.md doc: create a separate page for VPP 2019-01-07 04:21:39 +00:00
getting_started.md doc/getting_started: update the nvme example path 2018-10-23 18:00:24 +00:00
header.html doc: Remove mobile responsiveness 2018-12-10 15:56:50 +00:00
index.md doc: change "Modules" page name to "Driver Modules" 2018-08-22 18:11:24 +00:00
intro.md doc: use Doxygen subpages for top-level groupings 2018-06-14 16:45:51 +00:00
ioat.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
iscsi.md doc: create a separate page for VPP 2019-01-07 04:21:39 +00:00
jsonrpc_proxy.md doc: update a payload example about rpc_client 2018-11-26 16:52:13 +00:00
jsonrpc.md doc/jsonrpc: add info about nvmf_create_transport 2019-01-18 16:57:37 +00:00
lvol.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
Makefile doc/Makefile: include mk/spdk.common.mk 2018-06-19 17:29:06 +00:00
memory.md doc: describe dynamic memory management 2018-10-29 23:43:45 +00:00
misc.md doc: use Doxygen subpages for top-level groupings 2018-06-14 16:45:51 +00:00
nvme-cli.md nvme-cli: update md file for core_mask's description 2018-12-27 01:35:10 +00:00
nvme.md doc: describe dynamic memory management 2018-10-29 23:43:45 +00:00
nvmf_tgt_pg.md doc: Really minor updates to NVMe-oF programmers guide 2018-09-25 17:19:39 +00:00
nvmf_tracing.md doc/nvmf: add tracepoints user guide 2018-09-26 09:06:00 +00:00
nvmf.md doc/nvmf: Revise the NVMe-oF target user guide 2019-01-18 17:14:29 +00:00
peer_2_peer.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
performance_reports.md doc/perf_report: add bdev perf report 2018-11-01 21:14:12 +00:00
porting.md doc: move porting guide into doc/ and add to index 2017-01-17 16:25:04 -07:00
prog_guides.md ftl: Initial headers 2019-01-11 09:15:39 +00:00
README.md doc: Fix the verbage concerning prereqs 2018-02-14 17:38:48 -05:00
spdkcli.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
ssd_internals.md doc: Add some documentation about SSD internals 2018-01-30 19:26:29 -05:00
stylesheet.css doc: Remove mobile responsiveness 2018-12-10 15:56:50 +00:00
system_configuration.md Doc: Clarify the IOMMU configuration for User Space Drivers 2018-11-05 22:15:41 +00:00
template_pg.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
tools.md doc: use Doxygen subpages for top-level groupings 2018-06-14 16:45:51 +00:00
two.min.js doc: Add license header to two.js source 2018-08-06 16:27:58 +00:00
user_guides.md Doc: Clarify the IOMMU configuration for User Space Drivers 2018-11-05 22:15:41 +00:00
userspace.md doc: Fix link titles in userspace.md 2018-08-08 15:50:46 +00:00
vagrant.md configure: use mk/config.mk instead of CONFIG.local 2018-10-16 12:40:43 +00:00
vhost_processing.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
vhost.md doc/bdev: Update documentation with new delete commands 2018-07-20 20:43:25 +00:00
virtio.md doc: describe dynamic memory management 2018-10-29 23:43:45 +00:00
vpp_integration.md doc: create a separate page for VPP 2019-01-07 04:21:39 +00:00

README.md

SPDK Documentation

The current version of the SPDK documentation can be found online at http://www.spdk.io/doc/

Building the Documentation

To convert the documentation into HTML run make in the doc directory. The output will be located in doc/output/html. Before running make ensure all pre-requisites are installed. See Installing Prerequisites for more details.