numam-spdk/doc
Ben Walker a24d549038 bdev/nvme: bdev_nvme_attach_controller now has a multipath parameter
This parameter may have the values "disable" or "failover". The default
is failover to match existing behavior. In the future we expect to
change the default behavior to disable.

Further, we expect to add an "enable" option soon to do full multipath.

Change-Id: Iebbdc9b95f23101f18d64e085933463498e627be
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9343
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
2021-10-12 08:52:01 +00:00
..
img spdk_top: update spdk_top docs for spdk.io 2021-03-08 10:48:47 +00:00
.gitignore
about.md
accel_fw.md lib/idxd: only select idxd device that are on the same socket 2021-10-07 09:26:50 +00:00
applications.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
bdev_module.md doc: remove mentions of legacy config 2020-10-22 17:08:41 +00:00
bdev_pg.md
bdev.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
bdevperf.md markdownlint: enable rule MD032 2021-08-26 19:27:22 +00:00
blob.md markdownlint: enable rule MD046 2021-09-08 21:53:48 +00:00
blobfs.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
ci_tools.md doc: Add page describing OS distros used by the CI 2021-09-20 10:48:56 +00:00
compression.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
concepts.md
concurrency.md markdownlint: enable rule MD046 2021-09-08 21:53:48 +00:00
containers.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
distributions.md doc: Add page describing OS distros used by the CI 2021-09-20 10:48:56 +00:00
Doxyfile doc: Add page describing OS distros used by the CI 2021-09-20 10:48:56 +00:00
driver_modules.md
event.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
footer.html
ftl.md markdownlint: enable rule MD046 2021-09-08 21:53:48 +00:00
gdb_macros.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
general.md doc: added scheduler framework documentation 2021-01-29 18:21:13 +00:00
getting_started.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
header.html
idxd.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
index.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
intro.md deprecation: add a file to gather all deprecation notices 2021-04-26 06:55:03 +00:00
ioat.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
iscsi.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
jsonrpc_proxy.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
jsonrpc.md bdev/nvme: bdev_nvme_attach_controller now has a multipath parameter 2021-10-12 08:52:01 +00:00
libraries.md markdownlint: enable rule MD032 2021-08-26 19:27:22 +00:00
lvol.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
Makefile
memory.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
misc.md doc/rpms: add reference to rpms doc page 2021-06-22 23:47:52 +00:00
notify.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
nvme_spec.md doc: correct explanation of NVMe SQ command submission 2021-01-25 12:52:08 +00:00
nvme.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
nvmf_tgt_pg.md lib/nvmf: remove deprecated API 2021-03-18 14:43:08 +00:00
nvmf_tracing.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
nvmf.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
overview.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
peer_2_peer.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
performance_reports.md doc: add SPDK NVMe Bdev 21.07 performance report entry 2021-09-23 16:48:50 +00:00
pkgconfig.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
porting.md markdownlint: enable rule MD046 2021-09-08 21:53:48 +00:00
prog_guides.md
README.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
rpm.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
scheduler.md doc: added scheduler framework documentation 2021-01-29 18:21:13 +00:00
shfmt.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
spdk_top.md markdownlint: enable rule MD032 2021-08-26 19:27:22 +00:00
spdkcli.md markdownlint: enable rule MD006 2021-08-05 07:42:35 +00:00
ssd_internals.md
stylesheet.css
system_configuration.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
template_pg.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
tools.md test: remove spdk/nvme-cli references 2021-01-04 16:28:01 +00:00
two.min.js
usdt.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
user_guides.md doc: add a page for USDT 2021-06-08 08:27:15 +00:00
userspace.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
vagrant.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
vhost_processing.md markdownlint: enable rule MD040 2021-09-08 21:53:48 +00:00
vhost.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
virtio.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
vmd.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00

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.