History

Ben Walker 706c57bf2f doc: Add an example of using two.js to draw a diagram

Change-Id: I50a525ac46ac011af81625fa0f095b1f3d981aba
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.gerrithub.io/414891
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>

2018-07-16 22:31:38 +00:00

img

doc/lvol: add inflate doc

2018-07-02 19:32:13 +00:00

.gitignore

doc: add output directory to .gitignore

2018-06-19 07:15:50 +00:00

about.md

doc: Add an overview page for the project

2018-01-05 12:47:01 -05:00

bdev_module.md

doc: fix up some bdev-related reference errors

2018-06-19 15:18:08 +00:00

bdev_pg.md

doc: Programming guide for block device abstraction layer

2018-02-02 17:37:30 -05:00

bdev.md

doc/jsonrpc: add RPC for all bdev types

2018-07-13 20:28:50 +00:00

blob.md

doc: Add an example of using two.js to draw a diagram

2018-07-16 22:31:38 +00:00

blobfs.md

test: move test/lib/blobfs under test/blobfs

2018-03-23 19:45:09 -04:00

concepts.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

concurrency.md

thread: Move threading abstraction code out of util

2018-06-12 15:24:07 +00:00

directory_structure.md

vhost: Getting Started for SPDK vhost

2017-03-29 13:09:57 -07:00

Doxyfile

doc: Embed two.js for use in drawing diagrams

2018-07-16 22:31:38 +00:00

event.md

lib: Return instead of exit in event

2018-03-08 11:47:01 -05:00

experimental_tools.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

footer.html

doc: simplify HTML header and stylesheet

2017-04-28 13:13:48 -07:00

general.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

getting_started.md

test/unit: move unittest.sh and dependencies here.

2018-03-13 18:44:34 -04:00

header.html

doc: Embed two.js for use in drawing diagrams

2018-07-16 22:31:38 +00:00

index.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

intro.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

ioat.md

doc: flatten Markdown docs into chapter-per-file

2017-04-30 07:58:26 -07:00

iscsi.md

doc: fix up some bdev-related reference errors

2018-06-19 15:18:08 +00:00

jsonrpc.md

doc/jsonrpc: add RPC for all bdev types

2018-07-13 20:28:50 +00:00

lvol.md

doc/lvol: add inflate doc

2018-07-02 19:32:13 +00:00

Makefile

doc/Makefile: include mk/spdk.common.mk

2018-06-19 17:29:06 +00:00

memory.md

Add documentation explaining memory management

2017-06-15 14:11:58 -04:00

misc.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

modules.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

nvme-cli.md

doc: update the nvme-cli user guide

2018-01-17 17:28:31 -05:00

nvme.md

doc/nvme: fix typo in NVMe index page

2018-02-14 17:45:53 -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: update readme to include nqn definition

2018-04-23 16:17:09 +00:00

peer_2_peer.md

docs: Add documentation for peer-2-peer

2018-03-02 13:47:46 -05:00

performance_reports.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

porting.md

doc: move porting guide into doc/ and add to index

2017-01-17 16:25:04 -07:00

prog_guides.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

README.md

doc: Fix the verbage concerning prereqs

2018-02-14 17:38:48 -05:00

spdkcli.md

spdkcli: initial version with bdev management

2018-04-20 13:25:21 -04:00

ssd_internals.md

doc: Add some documentation about SSD internals

2018-01-30 19:26:29 -05:00

stylesheet.css

doc: enable Doxygen tree view navigation

2017-10-31 18:00:12 -04:00

template_pg.md

doc: Programmer's guide template and example for blobstore

2018-03-19 11:40:08 -04:00

tools.md

doc: use Doxygen subpages for top-level groupings

2018-06-14 16:45:51 +00:00

two.min.js

doc: Embed two.js for use in drawing diagrams

2018-07-16 22:31:38 +00:00

user_guides_common.md

doc/user guide: add common user guide page

2018-07-12 23:31:59 +00:00

user_guides.md

doc/user guide: add common user guide page

2018-07-12 23:31:59 +00:00

userspace.md

doc: Add an overview of user space drivers

2018-01-17 15:11:22 -05:00

vagrant.md

test: move lib/nvme up one directory

2018-03-27 00:46:52 -04:00

vhost_processing.md

doc/vhost_processing: replace the ASCII diagram with an SVG one

2018-05-30 17:40:04 +00:00

vhost.md

doc/user guide: add common user guide page

2018-07-12 23:31:59 +00:00

virtio.md

doc/virtio: mention 2MB hugepage support

2018-04-25 17:25:49 +00: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 run make in the doc directory. The output will be located in doc/output/html. Before running make ensure all pre-requisites are installed. See Installing Prerequisites for more details.