History

Jim Harris 4a74580112 bdev: add a getting started guide For now, this contains the documentation for configuring block devices in configuration files. This file can then be used a common reference for other getting started guides - iscsi, vhost and nvmf targets. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Ie6f6c0b3f36dd3fdf418b904462c81a1696b9694		2017-03-16 05:43:28 -07:00
..
bdev	bdev: add a getting started guide	2017-03-16 05:43:28 -07:00
event	event: move component descriptions to doc/ and rewrite	2017-01-31 14:50:29 -07:00
ioat	doc: Convert ioat doc to markdown	2017-01-05 08:33:59 -07:00
iscsi	bdev: add a getting started guide	2017-03-16 05:43:28 -07:00
nvme	doc: add a page about NVMe library NVMe-oF support	2017-02-23 17:49:17 -07:00
nvmf	nvmf: Added infiniband/RDMA prerequisites and core assignment configuration	2017-03-06 15:51:58 -07:00
directory_structure.md	doc: Convert directory structure to markdown	2017-01-05 08:33:59 -07:00
Doxyfile	bdev: add a getting started guide	2017-03-16 05:43:28 -07:00
footer.html	doc: update footer to match spdk.io	2017-02-17 15:18:30 -07:00
header.html	doc: add Roadmap link to header	2017-02-17 15:18:30 -07:00
index.md	bdev: add a getting started guide	2017-03-16 05:43:28 -07:00
Makefile	doc: merge ioat and nvme into a single Doxyfile	2016-03-25 09:59:39 -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: cut out whitespace between header and content	2017-01-30 14:08:06 -07: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, install Doxygen and mscgen and run make in the doc directory. The output will be located in doc/output/html.