d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk/doc
History
Pawel Wodkowski 2cccea55ed rpc/notifications: add notification support to RPC client and SPDK host. 
Two new RPC calls get_notification_types and get_notifications added.

Change-Id: Ia5288d83cc5e9f18ef1622d3f15b9fe3bbf640ed
Signed-off-by: Pawel Wodkowski <pawelx.wodkowski@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/436530
Reviewed-by: Vitaliy Mysak <vitaliy.mysak@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
2019-04-09 23:01:52 +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
app: rename traceflag cmdline option to logflag
2018-12-03 19:50:15 +00:00
bdev_module.md
bdev: Allow bdev module to finish start asynchronously
2019-03-20 15:05:09 +00:00
bdev_pg.md
doc: update a header file about bdev programming guide
2018-12-18 17:27:22 +00:00
bdev.md
docs/ocf: update configure option
2019-04-01 09:06:32 +00:00
blob.md
doc: fix typos in the doc directory
2018-08-27 19:38:10 +00:00
blobfs.md
test/ioat: remove unnecessary config entires
2018-08-30 14:45:48 +00:00
compression.md
doc/compression: fix a typo
2019-02-18 07:44:52 +00:00
concepts.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
concurrency.md
doc: fix typos in the doc directory
2018-08-27 19:38:10 +00:00
directory_structure.md
vhost: Getting Started for SPDK vhost
2017-03-29 13:09:57 -07:00
Doxyfile
doc: add documentation for gdb_macros
2019-02-21 18:04:34 +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
experimental_tools.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00: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: create a separate page for VPP
2019-01-07 04:21:39 +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: change "Modules" page name to "Driver Modules"
2018-08-22 18:11:24 +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/iscsi: fix a typo
2019-02-18 07:45:08 +00:00
jsonrpc_proxy.md
doc: update a payload example about rpc_client
2018-11-26 16:52:13 +00:00
jsonrpc.md
rpc/notifications: add notification support to RPC client and SPDK host.
2019-04-09 23:01:52 +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: describe dynamic memory management
2018-10-29 23:43:45 +00:00
misc.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +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
doc/nvmf: fixed io unit size typo
2019-03-21 17:26:20 +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: add documentation for gdb_macros
2019-02-21 18:04:34 +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: Add some documentation about SSD internals
2018-01-30 19:26:29 -05: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: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +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: fix typos in the doc directory
2018-08-27 19:38:10 +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: create a separate page for VPP
2019-01-07 04:21:39 +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.