numam-spdk/doc
Jim Harris 1edd9bf3e4 blobfs: Add a lightweight filesystem built on the blobstore
This is the initial commit for "blobfs", a lightweight
filesystem built on top of the SPDK blobstore.

Also included in this patch:

1) a shim for using SPDK bdevs as the backing store for
   SPDK blobstore/blobfs
2) documentation for using blobfs as the storage engine
   with RocksDB
3) scripts for running a set of workloads and collecting
   profiling data with RocksDB and blobfs

See doc/blobfs/getting_started.md included in this commit
for more details on blobfs, including some of the current
limitations.


Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I2a6d3d4b87236730051228ed62c0c04e04c42c73
2017-03-24 14:15:45 -07:00
..
bdev bdev/aio: The user now provides the names of AIO bdevs 2017-03-20 15:18:03 -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 blobfs: Add a lightweight filesystem built on the blobstore 2017-03-24 14:15:45 -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 blobfs: Add a lightweight filesystem built on the blobstore 2017-03-24 14:15:45 -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

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.