d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
8e79b60b61
numam-spdk/doc
History
John Kariuki 8e79b60b61 doc/nvmf: fixed io unit size typo 
Update doc to fix typo in the io unit size for TCP.
Using an io unit size of 16348 results in an invalid io size error
which is resolved once you change the value to 16384

Change-Id: Id52715305a395d4b1f769568d4738bab4466ea27
Signed-off-by: John Kariuki <John.K.Kariuki@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/448315
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
2019-03-21 17:26:20 +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 changelog: added missing items for 19.01 2019-01-30 21:42:13 +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 ftl: usage documentation 2019-01-25 19:59:05 +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 bdev/nvme: Add configuration parameter to slow down polling 2019-03-19 07:27:44 +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/perf_report: add bdev perf report 2018-11-01 21:14:12 +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.