Spdk/doc
Mike Gerdts adc2ca50e9 scripts: gdb needs a pretty printer for spinlocks
In debug builds, SPDK spinlocks will have stack traces that track where
they were allocated, last locked, and last unlocked. This adds gdb
pretty printers to make that information easily visible. See the updates
in doc/gdb_macros.md for details.

Signed-off-by: Mike Gerdts <mgerdts@nvidia.com>
Change-Id: I4f903c588d9384c4005eec01348fa5c2d3cab5db
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/16000
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Shuhei Matsumoto <smatsumoto@nvidia.com>
2023-05-02 22:32:01 +00:00
..
img vbdev_lvol: external snapshot rpc interface 2023-04-26 17:32:13 +00:00
.gitignore deprecation: add the md to documentation Makefile 2023-04-06 21:16:39 +00:00
about.md
accel_fw.md module/accel: Add accel_dpdk_cryptodev 2023-01-11 09:16:59 +00:00
applications.md trace: update trace help inside SPDK target 2022-09-27 19:41:17 +00:00
bdev_module.md doc/bdev_module: clarify claim v2 types 2023-02-14 09:04:55 +00:00
bdev_pg.md
bdev.md bdev/pmem: Removed bdev pmem implementation 2023-03-09 09:21:23 +00:00
bdevperf.md
blob.md blob: add IO channels for esnap clones 2023-03-28 03:57:35 +00:00
blobfs.md
ci_tools.md
compression.md
concepts.md
concurrency.md doc: mention SPDK spinlocks in concurrency.md 2022-12-21 09:34:34 +00:00
containers.md
distributions.md doc/distributions: don't mention Fedora version 2023-02-20 10:53:42 +00:00
Doxyfile deprecation: add the md to documentation Makefile 2023-04-06 21:16:39 +00:00
driver_modules.md
event.md
footer.html
ftl.md doc/ftl.md: fix ftl_l2p reference 2022-12-16 09:21:04 +00:00
gdb_macros.md scripts: gdb needs a pretty printer for spinlocks 2023-05-02 22:32:01 +00:00
general.md
getting_started.md doc: user --recursive in directions for cloning SPDK repo 2022-10-14 08:35:38 +00:00
header.html
idxd.md
index.md
intro.md
ioat.md
iscsi.md
jsonrpc_proxy.md
jsonrpc.md vbdev_lvol: add bdev_lvol_get_lvols RPC 2023-04-26 17:32:13 +00:00
libraries.md
lvol.md vbdev_lvol: add bdev_lvol_get_lvols RPC 2023-04-26 17:32:13 +00:00
Makefile deprecation: add the md to documentation Makefile 2023-04-06 21:16:39 +00:00
memory.md
misc.md
notify.md
nvme_multipath.md
nvme_spec.md
nvme.md scripts: add a ledctl wrapper script for NPEM 2023-02-23 08:33:57 +00:00
nvmf_multipath_howto.md bdevperf: promote bdevperf from test to example application 2022-11-16 09:52:41 +00:00
nvmf_tgt_pg.md
nvmf_tracing.md
nvmf.md doc: user --recursive in directions for cloning SPDK repo 2022-10-14 08:35:38 +00:00
overview.md
peer_2_peer.md
performance_reports.md doc: add NVMe-oF TCP CVL 23.01 performance report link 2023-04-07 16:32:52 +00:00
pkgconfig.md
porting.md
prog_guides.md
README.md
rpm.md
scheduler.md scheduler.md: update static scheduler description 2022-10-21 07:33:06 +00:00
shfmt.md
sma.md doc: updated SMA interface documentation 2023-03-23 08:27:09 +00:00
spdk_top.md docs/spdk_top: add a note about scheduler pop-up 2022-12-13 09:26:29 +00:00
spdkcli.md
ssd_internals.md
stylesheet.css
system_configuration.md
template_pg.md
tools.md
two.min.js
ublk.md doc: describe ublk target in user guide 2023-01-26 20:59:22 +00:00
usdt.md
user_guides.md doc: describe ublk target in user guide 2023-01-26 20:59:22 +00:00
userspace.md
vagrant.md misc: Fix spelling mistakes 2022-12-09 08:16:18 +00:00
vhost_processing.md
vhost.md doc: fix typo in vhost document 2022-11-21 12:01:05 +00:00
virtio.md
vmd.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.