numam-spdk/doc
Ben Walker d39c4443d4 bdev/nvme: Remove OCSSD support
As far as we're aware, this is not in use by anyone. OCSSD has largely
been replaced by ZNS and no OCSSD drives made it to the market.

Change-Id: I020ee277da5292f8c4777f224acafd87586f8238
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/9328
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Mellanox Build Bot
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
2021-09-03 08:07:25 +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 markdownlint: enable rule MD025 2021-08-26 19:27:22 +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 markdownlint: enable rule MD038 2021-08-27 18:09:20 +00:00
bdevperf.md markdownlint: enable rule MD032 2021-08-26 19:27:22 +00:00
blob.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
blobfs.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
ci_tools.md doc: Add "CI Tools" section 2020-12-28 13:08:12 +00:00
compression.md
concepts.md
concurrency.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
containers.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
Doxyfile doc: add a page for USDT 2021-06-08 08:27:15 +00:00
driver_modules.md doc: add IDXD docs and changelog entry 2020-04-23 15:48:32 +00:00
event.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +00:00
footer.html
ftl.md bdev/nvme: Remove OCSSD support 2021-09-03 08:07:25 +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 MD025 2021-08-26 19:27:22 +00:00
jsonrpc_proxy.md markdownlint: enable rule MD013 - line_length 2021-08-05 07:42:35 +00:00
jsonrpc.md bdev/nvme: Remove OCSSD support 2021-09-03 08:07:25 +00:00
libraries.md markdownlint: enable rule MD032 2021-08-26 19:27:22 +00:00
lvol.md markdownlint: enable rule MD025 2021-08-26 19:27:22 +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 MD025 2021-08-26 19:27:22 +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 MD025 2021-08-26 19:27:22 +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 Vhost 21.07 performance report link 2021-09-02 13:54:51 +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 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 MD025 2021-08-26 19:27:22 +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 MD007 2021-08-05 07:42:35 +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 MD025 2021-08-26 19:27:22 +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.