d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
b94155c853
numam-spdk/doc
History
Stephen Bates b94155c853 docs: Add documentation for peer-2-peer 
In 35a331a9 we added a new API that enables peer-2-peer (P2P) copies
between NVMe SSDs using Controller Memory Buffers (CMBs) that support
DMA operations. Add documentation for the API, the example application
(cmb_copy) and for P2P setup and operation.

Note that this new API is currently marked experimental.

Change-Id: Ifeedb86d5b72b3aa7a6803b87c4d4709c54108f8
Signed-off-by: Stephen Bates <sbates@raithlin.com>
Reviewed-on: https://review.gerrithub.io/401961
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-03-02 13:47:46 -05:00
..
.gitignore doc: include changelog in documentation 2017-08-28 13:44:13 -04:00
about.md doc: Add an overview page for the project 2018-01-05 12:47:01 -05:00
bdev_module.md doc: Programming guide for block device abstraction layer 2018-02-02 17:37:30 -05:00
bdev_pg.md doc: Programming guide for block device abstraction layer 2018-02-02 17:37:30 -05:00
bdev.md doc: Expand the intro section of the bdev documentation. 2018-01-17 15:11:22 -05:00
blob.md blob: add used blobid bit array for valid blobids 2017-12-21 12:28:21 -05:00
blobfs.md scripts: replace NRHUGE with HUGEMEM in setup.sh 2017-10-12 18:27:21 -04:00
concurrency.md doc: Integrate concurrency and event framework docs 2018-02-02 17:41:20 -05:00
directory_structure.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
Doxyfile docs: Add documentation for peer-2-peer 2018-03-02 13:47:46 -05:00
event.md doc: Integrate concurrency and event framework docs 2018-02-02 17:41:20 -05:00
footer.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
getting_started.md doc/getting_started: mention setup.sh help 2018-01-26 14:54:30 -05:00
header.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
index.md docs: Add documentation for peer-2-peer 2018-03-02 13:47:46 -05:00
ioat.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
iscsi.md doc: Remove stray Intel (R) 2018-01-17 15:11:22 -05:00
jsonrpc.md nvmf: add Namespace deletion RPC support 2018-03-02 13:39:23 -05:00
lvol.md lvol: set default cluster size to 4MiB 2018-01-31 15:37:26 -05:00
Makefile build/doc: add dependencies to 'output' rule 2018-02-15 11:10:55 -05:00
memory.md Add documentation explaining memory management 2017-06-15 14:11:58 -04: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: clean up and reorder the nvmf_tgt docs 2018-01-24 15:40:04 -05:00
peer_2_peer.md docs: Add documentation for peer-2-peer 2018-03-02 13:47:46 -05:00
porting.md doc: move porting guide into doc/ and add to index 2017-01-17 16:25:04 -07:00
README.md doc: Fix the verbage concerning prereqs 2018-02-14 17:38:48 -05: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
userspace.md doc: Add an overview of user space drivers 2018-01-17 15:11:22 -05:00
vagrant.md scripts/vagrant: add vagrant-libvirt provider 2017-12-04 17:36:45 -05:00
vhost.md doc/vhost: add '-numa' to QEMU memory configuration 2018-02-13 13:34:07 -05:00
virtio.md doc/virtio: minor doc updates 2018-01-30 19:13:56 -05: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.