History

Konrad Sztyber 97b0c5d327 doc/nvmf: add note about the issues with RDMA on E810 NICs

Added note to the nvmf documentation about an issue [1] with destroying
qpairs on E810 cards in RoCE mode.  The note needs to be removed once
the issue is resolved.

[1] https://github.com/spdk/spdk/issues/1840

Signed-off-by: Konrad Sztyber <konrad.sztyber@intel.com>
Change-Id: Ie03a7a662391bd738848f71e582748a334a6ffd5
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/7577
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI
Community-CI: Mellanox Build Bot
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-by: John Kariuki <John.K.Kariuki@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>

2021-04-23 18:10:57 +00:00

img

spdk_top: update spdk_top docs for spdk.io

2021-03-08 10:48:47 +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

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: Add spdk_bdev_open_ext function

2019-08-26 19:07:56 +00:00

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

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: 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

doc: Add doc about building RPMs

2021-04-19 12:56:09 +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

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

doc: Remove mobile responsiveness

2018-12-10 15:56:50 +00:00

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

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: remove mentions of legacy config

2020-10-22 17:08:41 +00:00

jsonrpc_proxy.md

RPC: rename rpc get_bdevs to bdev_get_bdevs

2019-09-13 22:39:15 +00:00

jsonrpc.md

event/rpc: replace spaces with underscores in framework_get_scheduler

2021-04-23 18:09:23 +00:00

libraries.md

docs: Improve documentation around linkage requirements

2021-03-18 14:37:46 +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: 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/nvmf: fix broken link

2020-11-02 11:16:57 +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

doc: Finish overview page

2019-05-09 04:33:19 +00:00

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

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

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

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

configure: remove --with-igb-uio-driver option

2021-01-22 08:47:48 +00:00

template_pg.md

doc: fix typos in the doc directory

2018-08-27 19:38:10 +00:00

tools.md

test: remove spdk/nvme-cli references

2021-01-04 16:28:01 +00:00

two.min.js

doc: Add license header to two.js source

2018-08-06 16:27:58 +00:00

user_guides.md

build: generate pkg-config files for SPDK

2021-01-21 09:46:32 +00:00

userspace.md

doc: Fix link titles in userspace.md

2018-08-08 15:50:46 +00:00

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.