numam-spdk/doc
Ben Walker d40b934652 doc: Improve NVMe documentation entry page
Give a higher level overview of the NVMe driver, plus point
to the examples and the fio plugin up front.

Change-Id: Ifded628a79c2a648e024698410e2c2a164fe08eb
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.gerrithub.io/364843
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-06-22 15:49:28 -04:00
..
bdev.md doc/bdev: update the AIO configuration example 2017-06-07 14:02:46 -04:00
blob.md io_channel: Remove per-channel priority 2017-05-26 13:42:19 -04:00
blobfs.md rocksdb: Add the RocksDB Env to the SPDK repository 2017-06-13 11:38:06 -04:00
directory_structure.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
Doxyfile Add documentation explaining memory management 2017-06-15 14:11:58 -04:00
event.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
footer.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
header.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
index.md Add documentation explaining memory management 2017-06-15 14:11:58 -04:00
ioat.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
iscsi.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
Makefile doc: merge ioat and nvme into a single Doxyfile 2016-03-25 09:59:39 -07:00
memory.md Add documentation explaining memory management 2017-06-15 14:11:58 -04:00
nvme.md doc: Improve NVMe documentation entry page 2017-06-22 15:49:28 -04:00
nvmf.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
porting.md doc: move porting guide into doc/ and add to index 2017-01-17 16:25:04 -07:00
README.md Change doc link to new spdk.io/doc location 2016-12-19 15:57:12 -07:00
stylesheet.css doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
vhost.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07: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.