d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
03e3fc4f58
numam-spdk/doc
History
Maciej Szwed ade2aa25ac doc: Add description for pluggable RPCs 
Signed-off-by: Maciej Szwed <maciej.szwed@intel.com>
Change-Id: Iddc4d592aa3a750cb0a977ec9c5257518626e27b

Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/2420
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: John Kariuki <John.K.Kariuki@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Community-CI: Mellanox Build Bot
2020-06-08 09:34:26 +00:00
..
img doc/nvme: nvme character device documentation 2019-10-31 14:04:38 +00:00
.gitignore doc: add output directory to .gitignore 2018-06-19 07:15:50 +00:00
about.md Fix Markdown MD026 linter warnings - trailing punctuation in header 2020-02-17 10:07:21 +00:00
applications.md Fix Markdown MD012 linter warnings - multiple blank lines 2020-02-17 10:07:21 +00:00
bdev_module.md doc: fix location of SPDK_BDEV_MODULE_REGISTER macro 2019-05-14 22:28:30 +00:00
bdev_pg.md bdev: Add spdk_bdev_open_ext function 2019-08-26 19:07:56 +00:00
bdev.md doc: using 4096 block size when bdev_aio_create 2020-05-19 09:44:13 +00:00
blob.md Fix Markdown MD026 linter warnings - trailing punctuation in header 2020-02-17 10:07:21 +00:00
blobfs.md doc/blobfs: Update rocksdb version 2019-07-08 08:42:46 +00:00
compression.md doc/compression: fix diagrams 2019-06-06 05:35:25 +00:00
concepts.md doc: Add concept page on submitting I/O to an NVMe device 2019-05-09 04:33:19 +00:00
concurrency.md doc: Fix Markdown MD032 linter warnings 2020-02-06 09:46:06 +00:00
containers.md docs/containers: point to actual release 2020-05-14 10:57:07 +00:00
Doxyfile doc: add library documentation. 2020-06-08 09:33:58 +00:00
driver_modules.md doc: add IDXD docs and changelog entry 2020-04-23 15:48:32 +00:00
event.md lib: Return instead of exit in event 2018-03-08 11:47:01 -05:00
footer.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
ftl.md Fix Markdown MD014 linter warnings 2020-04-07 08:37:20 +00:00
gdb_macros.md Fix Markdown MD026 linter warnings - trailing punctuation in header 2020-02-17 10:07:21 +00:00
general.md doc: Rename directory_structure.md to overview.md 2019-05-09 04:33:19 +00:00
getting_started.md scripts/pkgdep.sh: Add flag for developer tools installation 2020-02-18 14:42:16 +00:00
header.html doc: Remove mobile responsiveness 2018-12-10 15:56:50 +00:00
idxd.md doc: add IDXD docs and changelog entry 2020-04-23 15:48:32 +00:00
index.md Fix Markdown MD022 linter warnings - headers blank lines 2020-02-17 10:07:21 +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 some typos and align indent when setup.sh --help 2020-05-18 10:14:56 +00:00
jsonrpc_proxy.md RPC: rename rpc get_bdevs to bdev_get_bdevs 2019-09-13 22:39:15 +00:00
jsonrpc.md doc: Add description for pluggable RPCs 2020-06-08 09:34:26 +00:00
libraries.md doc: add library documentation. 2020-06-08 09:33:58 +00:00
lvol.md RPC: rename rpc get_bdevs to bdev_get_bdevs 2019-09-13 22:39:15 +00:00
Makefile doc/Makefile: include mk/spdk.common.mk 2018-06-19 17:29:06 +00:00
memory.md doc: Improve title of memory management concept page 2019-05-08 12:26:29 +00:00
misc.md docs: add section for containers 2020-01-24 20:16:58 +00:00
notify.md Fix Markdown MD022 linter warnings - headers blank lines 2020-02-17 10:07:21 +00:00
nvme_spec.md doc: Add concept page on submitting I/O to an NVMe device 2019-05-09 04:33:19 +00:00
nvme-cli.md doc: Fix Markdown MD032 linter warnings 2020-02-06 09:46:06 +00:00
nvme.md doc/nvme: remove dynamic creation/deletion of namespaces limitation 2020-06-05 09:01:44 +00:00
nvmf_tgt_pg.md doc: Really minor updates to NVMe-oF programmers guide 2018-09-25 17:19:39 +00:00
nvmf_tracing.md doc/nvmf_tracing: fix a typo 2019-02-18 07:45:28 +00:00
nvmf.md scripts/pkgdep.sh: Add flag for RDMA dependencies 2020-02-18 14:42:16 +00:00
overview.md doc: Finish overview page 2019-05-09 04:33:19 +00:00
peer_2_peer.md nvme: Change mapping semantics of controller memory buffer 2020-04-16 08:14:18 +00:00
performance_reports.md docs: fix 20.01 nvmf perf link 2020-05-07 18:52:59 +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/notify: add missing links about notify 2019-05-07 06:11:45 +00:00
README.md doc: Fix the verbage concerning prereqs 2018-02-14 17:38:48 -05:00
spdkcli.md doc: Fix Markdown MD032 linter warnings 2020-02-06 09:46:06 +00:00
ssd_internals.md doc: Rename directory_structure.md to overview.md 2019-05-09 04:33:19 +00:00
stylesheet.css doc: Remove mobile responsiveness 2018-12-10 15:56:50 +00:00
system_configuration.md doc: update system_config to include igb_uio. 2020-02-13 09:51:54 +00:00
template_pg.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
tools.md doc: move SPDKCLI to tools section 2019-06-17 10:10:59 +00:00
two.min.js doc: Add license header to two.js source 2018-08-06 16:27:58 +00:00
user_guides.md doc: add library documentation. 2020-06-08 09:33:58 +00:00
userspace.md doc: Fix link titles in userspace.md 2018-08-08 15:50:46 +00:00
vagrant.md doc: Fix Markdown MD032 linter warnings 2020-02-06 09:46:06 +00:00
vhost_processing.md doc: Fix Markdown MD032 linter warnings 2020-02-06 09:46:06 +00:00
vhost.md doc: fix some typos and align indent when setup.sh --help 2020-05-18 10:14:56 +00:00
virtio.md doc: Fix Markdown MD032 linter warnings 2020-02-06 09:46:06 +00:00
vmd.md doc/vmd: means to check LED management support 2019-12-18 09:38:25 +00:00
vpp_integration.md Fix Markdown MD026 linter warnings - trailing punctuation in header 2020-02-17 10:07:21 +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.