d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk/doc
History
Yanbo Zhou 4f43b353bc doc/jsonrpc: update response from get_bdevs_iostat method 
Update these information due to 'get_bdevs_iostat' has been
added more outputs from the following commits:

https://review.gerrithub.io/c/spdk/spdk/+/418117
https://review.gerrithub.io/c/spdk/spdk/+/419031

Change-Id: Ic94b871dc1a737253aa843b7fb9fdf667419bf59
Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/424365
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: GangCao <gang.cao@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
2018-09-04 18:49:56 +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
doc: document --limit-coredump command line option
2018-08-29 16:39:19 +00:00
bdev_module.md
doc: fix up some bdev-related reference errors
2018-06-19 15:18:08 +00:00
bdev_pg.md
doc/bdev: fix minor typo and format issues
2018-08-16 00:32:02 +00:00
bdev.md
doc: fix typos in the doc directory
2018-08-27 19:38:10 +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
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 comment explaining order of INPUT file list
2018-08-29 16:39:19 +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
general.md
doc: Move link to API headers to Programmer Guides section
2018-08-08 15:50:46 +00:00
getting_started.md
test/unit: move unittest.sh and dependencies here.
2018-03-13 18:44:34 -04:00
header.html
doc: Embed two.js for use in drawing diagrams
2018-07-16 22:31:38 +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
app: deprecate ReactorMask from ini config file
2018-08-30 03:41:01 +00:00
jsonrpc.md
doc/jsonrpc: update response from get_bdevs_iostat method
2018-09-04 18:49:56 +00:00
lvol.md
doc: fix typos in the doc directory
2018-08-27 19:38:10 +00:00
Makefile
doc/Makefile: include mk/spdk.common.mk
2018-06-19 17:29:06 +00:00
memory.md
doc: fix typos in the doc directory
2018-08-27 19:38:10 +00:00
misc.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
nvme-cli.md
doc: update the nvme-cli user guide
2018-01-17 17:28:31 -05:00
nvme.md
perf: cleanup cmdline params for consistency
2018-08-20 16:28:01 +00:00
nvmf_tgt_pg.md
doc: fix typos in the doc directory
2018-08-27 19:38:10 +00:00
nvmf.md
doc: fix typos in the doc directory
2018-08-27 19:38:10 +00:00
peer_2_peer.md
doc: fix typos in the doc directory
2018-08-27 19:38:10 +00:00
performance_reports.md
doc/performance_report: add NVMe-oF performance report
2018-08-15 17:33:48 +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: Move link to API headers to Programmer Guides section
2018-08-08 15:50:46 +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: enable Doxygen tree view navigation
2017-10-31 18:00:12 -04: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: Make the application command page an application overview
2018-08-08 15:50:46 +00:00
userspace.md
doc: Fix link titles in userspace.md
2018-08-08 15:50:46 +00:00
vagrant.md
doc: fix typos in the doc directory
2018-08-27 19:38:10 +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/virtio: mention 2MB hugepage support
2018-04-25 17:25:49 +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.