d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
9744ba01a2
numam-spdk/doc
History
Jim Harris 9744ba01a2 doc: change "Modules" page name to "Driver Modules" 
This eliminates conflict with Doxygen auto-generated
"Modules" page.

Signed-off-by: Jim Harris <james.r.harris@intel.com>
Change-Id: I571839240405ec0dc952b6a4f7ed65baab4cc42c

Reviewed-on: https://review.gerrithub.io/423165
Chandler-Test-Pool: SPDK Automated Test System <sys_sgsw@intel.com>
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
2018-08-22 18:11:24 +00:00
..
img doc/lvol: add inflate doc 2018-07-02 19:32:13 +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/applications.md: fix app param table not displaying correctly 2018-08-22 17:29:09 +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/nvme: update docs and jsonrpc with delete_nvme_controller 2018-07-26 22:07:50 +00:00
blob.md doc/blob: fix typo errors 2018-08-21 00:54:40 +00:00
blobfs.md test: move test/lib/blobfs under test/blobfs 2018-03-23 19:45:09 -04:00
concepts.md doc: use Doxygen subpages for top-level groupings 2018-06-14 16:45:51 +00:00
concurrency.md doc: Update concurrency doc with new name for thread.h 2018-08-08 15:50:46 +00:00
directory_structure.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
Doxyfile doc: change "Modules" page name to "Driver Modules" 2018-08-22 18:11:24 +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 doc: fix up some bdev-related reference errors 2018-06-19 15:18:08 +00:00
jsonrpc.md doc: fix example for construct_nvmf_subsystem method 2018-07-30 15:40:15 +00:00
lvol.md docs/lvol: added decouple parent lvol bdev info 2018-07-17 17:43:49 +00:00
Makefile doc/Makefile: include mk/spdk.common.mk 2018-06-19 17:29:06 +00:00
memory.md Add documentation explaining memory management 2017-06-15 14:11:58 -04: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: Add the SPDK NVMe-oF Target Programming Guide 2018-02-02 17:41:20 -05:00
nvmf.md doc/nvmf: update readme to include nqn definition 2018-04-23 16:17:09 +00:00
peer_2_peer.md docs: Add documentation for peer-2-peer 2018-03-02 13:47:46 -05: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 spdkcli: initial version with bdev management 2018-04-20 13:25:21 -04: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: Programmer's guide template and example for blobstore 2018-03-19 11:40:08 -04: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 test: move lib/nvme up one directory 2018-03-27 00:46:52 -04:00
vhost_processing.md doc/vhost_processing: outline the differences between virtio and vhost 2018-08-01 19:12:09 +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.