History

Jim Harris 12cc5e2e50 doc: use SPDK_TRACE_ARG_TYPE #defines Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Idcffe9ae197fc0257b89ca0854fe722fbf1ca916 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7761 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com>		2021-05-07 11:35:38 +00:00
..
img	spdk_top: update spdk_top docs for spdk.io	2021-03-08 10:48:47 +00:00
.gitignore
about.md	Fix Markdown MD026 linter warnings - trailing punctuation in header	2020-02-17 10:07:21 +00:00
accel_fw.md	doc/accel_fw: update docs to reflect updated configuration	2021-02-05 21:19:37 +00:00
applications.md	env: replace master_core with main_core	2020-12-03 09:41:07 +00:00
bdev_module.md	doc: remove mentions of legacy config	2020-10-22 17:08:41 +00:00
bdev_pg.md
bdev.md	doc: fix bdev_nvme_cuse_register reference for bdev.md	2021-04-01 11:17:53 +00:00
bdevperf.md	doc: add bdevperf doc section	2020-07-30 18:19:10 +00:00
blob.md	Doc/Blob: fix a typo in the document	2020-12-30 07:52:19 +00:00
blobfs.md	rocksdb: Switch default RocksDB branch to latest (6.15.fb)	2021-03-15 08:53:39 +00:00
ci_tools.md	doc: Add "CI Tools" section	2020-12-28 13:08:12 +00:00
compression.md
concepts.md
concurrency.md	doc: Update docs about new thread model	2020-06-22 10:13:56 +00:00
containers.md	docs/containers: point to actual release	2020-05-14 10:57:07 +00:00
Doxyfile	deprecation: add a file to gather all deprecation notices	2021-04-26 06:55:03 +00:00
driver_modules.md	doc: add IDXD docs and changelog entry	2020-04-23 15:48:32 +00:00
event.md
footer.html
ftl.md	build: Example applications build to build/example	2020-06-15 15:27:16 +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: added scheduler framework documentation	2021-01-29 18:21:13 +00:00
getting_started.md	build: Example applications build to build/example	2020-06-15 15:27:16 +00:00
header.html
idxd.md	idxd: add batch capability to accel framework and IDXD back-end	2020-07-10 07:31:09 +00:00
index.md	doc: Rename #index label to #mainpage	2021-04-01 11:18:53 +00:00
intro.md	deprecation: add a file to gather all deprecation notices	2021-04-26 06:55:03 +00:00
ioat.md
iscsi.md	doc: remove mentions of legacy config	2020-10-22 17:08:41 +00:00
jsonrpc_proxy.md
jsonrpc.md	sock: Deprecate enable_zerocopy_send in sock_impl_set_options RPC	2021-04-27 08:13:32 +00:00
libraries.md	docs: Improve documentation around linkage requirements	2021-03-18 14:37:46 +00:00
lvol.md
Makefile
memory.md
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: correct explanation of NVMe SQ command submission	2021-01-25 12:52:08 +00:00
nvme.md	docs/cuse: Improve details of nvme-cuse documentation	2020-12-28 13:09:00 +00:00
nvmf_tgt_pg.md	lib/nvmf: remove deprecated API	2021-03-18 14:43:08 +00:00
nvmf_tracing.md	doc: use SPDK_TRACE_ARG_TYPE #defines	2021-05-07 11:35:38 +00:00
nvmf.md	doc/nvmf: add note about the issues with RDMA on E810 NICs	2021-04-23 18:10:57 +00:00
overview.md
peer_2_peer.md	build: Example applications build to build/example	2020-06-15 15:27:16 +00:00
performance_reports.md	doc: add link to SPDK 21.01 NVMe Bdev performance report	2021-04-22 14:51:08 +00:00
pkgconfig.md	docs: Improve documentation around linkage requirements	2021-03-18 14:37:46 +00:00
porting.md
prog_guides.md
README.md
rpm.md	doc: Add doc about building RPMs	2021-04-19 12:56:09 +00:00
scheduler.md	doc: added scheduler framework documentation	2021-01-29 18:21:13 +00:00
shfmt.md	doc: Add "CI Tools" section	2020-12-28 13:08:12 +00:00
spdk_top.md	spdk_top: update spdk_top docs for spdk.io	2021-03-08 10:48:47 +00:00
spdkcli.md	doc: remove mentions of legacy config	2020-10-22 17:08:41 +00:00
ssd_internals.md
stylesheet.css
system_configuration.md	configure: remove --with-igb-uio-driver option	2021-01-22 08:47:48 +00:00
template_pg.md
tools.md	test: remove spdk/nvme-cli references	2021-01-04 16:28:01 +00:00
two.min.js
user_guides.md	build: generate pkg-config files for SPDK	2021-01-21 09:46:32 +00:00
userspace.md
vagrant.md	build: Example applications build to build/example	2020-06-15 15:27:16 +00:00
vhost_processing.md	doc: Fix Markdown MD032 linter warnings	2020-02-06 09:46:06 +00:00
vhost.md	env: replace master_core with main_core	2020-12-03 09:41:07 +00:00
virtio.md	doc: Fix Markdown MD032 linter warnings	2020-02-06 09:46:06 +00:00
vmd.md	scripts: replace PCI_WHITELIST with PCI_ALLOWED	2020-12-03 09:41:07 +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.