Spdk/doc
Pawel Wodkowski 261b5de903 doc/vhost: add '-numa' to QEMU memory configuration
This is quite important as QEMU vhost-user will report cryptic error
message that there is no shared memory to use.

Change-Id: Iad63962d4a3deed557db0b3420960aef557a3f86
Signed-off-by: Pawel Wodkowski <pawelx.wodkowski@intel.com>
Reviewed-on: https://review.gerrithub.io/399451
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2018-02-13 13:34:07 -05:00
..
.gitignore
about.md doc: Add an overview page for the project 2018-01-05 12:47:01 -05:00
bdev_module.md doc: Programming guide for block device abstraction layer 2018-02-02 17:37:30 -05:00
bdev_pg.md doc: Programming guide for block device abstraction layer 2018-02-02 17:37:30 -05:00
bdev.md doc: Expand the intro section of the bdev documentation. 2018-01-17 15:11:22 -05:00
blob.md blob: add used blobid bit array for valid blobids 2017-12-21 12:28:21 -05:00
blobfs.md
concurrency.md doc: Integrate concurrency and event framework docs 2018-02-02 17:41:20 -05:00
directory_structure.md
Doxyfile doc: Add the SPDK NVMe-oF Target Programming Guide 2018-02-02 17:41:20 -05:00
event.md doc: Integrate concurrency and event framework docs 2018-02-02 17:41:20 -05:00
footer.html
getting_started.md doc/getting_started: mention setup.sh help 2018-01-26 14:54:30 -05:00
header.html
index.md doc: Add the SPDK NVMe-oF Target Programming Guide 2018-02-02 17:41:20 -05:00
ioat.md
iscsi.md doc: Remove stray Intel (R) 2018-01-17 15:11:22 -05:00
jsonrpc.md doc/jsonrpc: remove "core" from nvmf_tgt methods 2018-02-07 23:22:57 -05:00
lvol.md lvol: set default cluster size to 4MiB 2018-01-31 15:37:26 -05:00
Makefile
memory.md
nvme-cli.md doc: update the nvme-cli user guide 2018-01-17 17:28:31 -05:00
nvme.md doc/nvme: update the NVMe driver user guide 2018-01-30 15:57:36 -05:00
nvmf_tgt_pg.md doc: Add the SPDK NVMe-oF Target Programming Guide 2018-02-02 17:41:20 -05:00
nvmf.md doc/nvmf: clean up and reorder the nvmf_tgt docs 2018-01-24 15:40:04 -05:00
porting.md
README.md
ssd_internals.md doc: Add some documentation about SSD internals 2018-01-30 19:26:29 -05:00
stylesheet.css
userspace.md doc: Add an overview of user space drivers 2018-01-17 15:11:22 -05:00
vagrant.md
vhost.md doc/vhost: add '-numa' to QEMU memory configuration 2018-02-13 13:34:07 -05:00
virtio.md doc/virtio: minor doc updates 2018-01-30 19:13:56 -05:00

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, install Doxygen and mscgen and run make in the doc directory. The output will be located in doc/output/html.