History

Ben Walker fcb333e5b5 blob: Add a design document This outlines the basic concepts in the blobstore. Change-Id: Ib44c3bd5c04ddb0cc06eeb0e50ae6ff1bdf94dd5 Signed-off-by: Ben Walker <benjamin.walker@intel.com>		2017-03-27 15:35:51 -07:00
..
bdev	bdev/aio: The user now provides the names of AIO bdevs	2017-03-20 15:18:03 -07:00
blob	blob: Add a design document	2017-03-27 15:35:51 -07:00
blobfs	blobfs: Add a lightweight filesystem built on the blobstore	2017-03-24 14:15:45 -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	doc: Add initial documentation for iscsi hotplug.	2017-03-17 16:06:26 -07:00
nvme	doc: Add initial documentation for nvme hotplug.	2017-03-17 16:06:20 -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	blob: Add a design document	2017-03-27 15:35:51 -07:00
footer.html	doc: update CSS layout to match spdk.io	2017-03-24 16:12:22 -07:00
header.html	doc: update CSS layout to match spdk.io	2017-03-24 16:12:22 -07:00
index.md	blob: Add a design document	2017-03-27 15:35:51 -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: update CSS layout to match spdk.io	2017-03-24 16:12:22 -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.