d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
016d933793
numam-spdk/doc
History
Tomasz Zawadzki 030ec62a00 doc: move SPDKCLI to tools section 
SPDKCLI is not considered experimental, so it was moved
to tools section.

Since it was last one in "Experimental tools",
that section is now removed.

Change-Id: I27ada7e2964c756e997abafe1fabfa5b5fd0d9bf
Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/457198
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
2019-06-17 10:10:59 +00:00
..
img doc/iscsi: update iscsi documentation 2018-08-27 21:30:32 +00:00
.gitignore doc: add output directory to .gitignore 2018-06-19 07:15:50 +00:00
about.md doc: Add an overview page for the project 2018-01-05 12:47:01 -05:00
applications.md rpc: rename RPC get_rpc_methods to rpc_get_methods 2019-05-27 12:52:53 +00:00
bdev_module.md doc: fix location of SPDK_BDEV_MODULE_REGISTER macro 2019-05-14 22:28:30 +00:00
bdev_pg.md doc: update a header file about bdev programming guide 2018-12-18 17:27:22 +00:00
bdev.md rpc: rename RPC get_rpc_methods to rpc_get_methods 2019-05-27 12:52:53 +00:00
blob.md doc/blobstore: remove non-exist description for "hello_nvme_blob" 2019-06-05 05:27:50 +00:00
blobfs.md test/ioat: remove unnecessary config entires 2018-08-30 14:45:48 +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: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
Doxyfile doc: move SPDKCLI to tools section 2019-06-17 10:10:59 +00:00
driver_modules.md doc: change "Modules" page name to "Driver Modules" 2018-08-22 18:11:24 +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 bdev/ftl: treat null UUID as no UUID 2019-03-26 12:01:48 +00:00
gdb_macros.md doc: add documentation for gdb_macros 2019-02-21 18:04:34 +00:00
general.md doc: Rename directory_structure.md to overview.md 2019-05-09 04:33:19 +00:00
getting_started.md doc/getting_started: update the nvme example path 2018-10-23 18:00:24 +00:00
header.html doc: Remove mobile responsiveness 2018-12-10 15:56:50 +00:00
index.md doc: move SPDKCLI to tools section 2019-06-17 10:10:59 +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 test: don't call python explicitly 2019-05-08 14:22:19 +00:00
jsonrpc_proxy.md doc: update a payload example about rpc_client 2018-11-26 16:52:13 +00:00
jsonrpc.md ocf: RPC add WriteBack to allowed cache modes 2019-06-07 18:18:42 +00:00
lvol.md lvol: add option to change clear method for lvol store creation 2019-02-28 20:50:27 +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 doc: use Doxygen subpages for top-level groupings 2018-06-14 16:45:51 +00:00
notify.md lib/notify: rename spdk_notify_get_events to spdk_notify_foreach_event 2019-05-07 06:11:27 +00:00
nvme_spec.md doc: Add concept page on submitting I/O to an NVMe device 2019-05-09 04:33:19 +00:00
nvme-cli.md nvme-cli: update md file for core_mask's description 2018-12-27 01:35:10 +00:00
nvme.md doc: add a description of limitation for multi-process usage 2019-01-28 02:35:11 +00:00
nvmf_tgt_pg.md doc: Really minor updates to NVMe-oF programmers guide 2018-09-25 17:19:39 +00:00
nvmf_tracing.md doc/nvmf_tracing: fix a typo 2019-02-18 07:45:28 +00:00
nvmf.md NVMF: Add model number as parameter to construct_nvmf_subsystem (-d option). 2019-04-23 16:51:16 +00:00
overview.md doc: Finish overview page 2019-05-09 04:33:19 +00:00
peer_2_peer.md nvme: Update p2p DMA documentation to indicate how to check for support 2019-02-06 16:01:56 +00:00
performance_reports.md doc: Add link to 19.01.1 NVMe-oF perf results. 2019-04-01 23:59:27 +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
spdkcli.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +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 Doc: Clarify the IOMMU configuration for User Space Drivers 2018-11-05 22:15:41 +00:00
template_pg.md doc: fix typos in the doc directory 2018-08-27 19:38:10 +00:00
tools.md doc: move SPDKCLI to tools section 2019-06-17 10:10:59 +00:00
two.min.js doc: Add license header to two.js source 2018-08-06 16:27:58 +00:00
user_guides.md Doc: Clarify the IOMMU configuration for User Space Drivers 2018-11-05 22:15:41 +00:00
userspace.md doc: Fix link titles in userspace.md 2018-08-08 15:50:46 +00:00
vagrant.md configure: use mk/config.mk instead of CONFIG.local 2018-10-16 12:40:43 +00:00
vhost_processing.md doc: Improve title of vhost concepts page 2019-05-08 12:26:29 +00:00
vhost.md doc/bdev: Update documentation with new delete commands 2018-07-20 20:43:25 +00:00
virtio.md doc: describe dynamic memory management 2018-10-29 23:43:45 +00:00
vpp_integration.md doc/vpp: update vpp document and configuration 2019-06-07 18:27:53 +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.