c06345bfaf
Replaced basic ASCII diagram with the complex SVG one. Also removed slightly misleading vhost introduction and replaced it with a doc/vhost_processing.md reference, which does a better job at explaining vhost. Vhost is a protocol intended to expose Virtio queues to an external process. While Virtio queues are defined by the Virtio protocol, it is still misleading to say vhost devices use Virtio protocol to communicate. They use Vhost-user protocol. Virtio shouldn't be mentioned unless we talk about QEMU or guest VM. Change-Id: I38ce4d3cc9e1c96339d9fa63b5e94019a17ccf9e Signed-off-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com> Reviewed-on: https://review.gerrithub.io/414816 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com> Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> |
||
|---|---|---|
| .. | ||
| img | ||
| .gitignore | ||
| about.md | ||
| bdev_module.md | ||
| bdev_pg.md | ||
| bdev.md | ||
| blob.md | ||
| blobfs.md | ||
| concurrency.md | ||
| directory_structure.md | ||
| Doxyfile | ||
| event.md | ||
| footer.html | ||
| getting_started.md | ||
| header.html | ||
| index.md | ||
| ioat.md | ||
| iscsi.md | ||
| jsonrpc.md | ||
| lvol.md | ||
| Makefile | ||
| memory.md | ||
| nvme-cli.md | ||
| nvme.md | ||
| nvmf_tgt_pg.md | ||
| nvmf.md | ||
| peer_2_peer.md | ||
| porting.md | ||
| README.md | ||
| spdkcli.md | ||
| ssd_internals.md | ||
| stylesheet.css | ||
| template_pg.md | ||
| userspace.md | ||
| vagrant.md | ||
| vhost_processing.md | ||
| vhost.md | ||
| virtio.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.