d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
numam-spdk/doc
History
Jim Harris f2d4c77797 doc: fix up some bdev-related reference errors 
This includes removing use of lib/bdev/<module_name>
which confused Doxygen into thinking it was an xml/html tag.

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

Reviewed-on: https://review.gerrithub.io/415851
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
2018-06-19 15:18:08 +00:00
..
img
doc/lvol: add diagrams to clone-snapshot doc
2018-06-04 17:17:23 +00:00
.gitignore
doc: add output directory to .gitignore
2018-06-19 07:15:50 +00:00
about.md
…
bdev_module.md
doc: fix up some bdev-related reference errors
2018-06-19 15:18:08 +00:00
bdev_pg.md
…
bdev.md
doc: fix up some bdev-related reference errors
2018-06-19 15:18:08 +00:00
blob.md
doc: Programmer's guide template and example for blobstore
2018-03-19 11:40:08 -04: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
thread: Move threading abstraction code out of util
2018-06-12 15:24:07 +00:00
directory_structure.md
…
Doxyfile
Doxyfile: set WARN_IF_UNDOCUMENTED = no
2018-06-19 15:18:08 +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
…
general.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
getting_started.md
test/unit: move unittest.sh and dependencies here.
2018-03-13 18:44:34 -04:00
header.html
…
index.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
intro.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
ioat.md
…
iscsi.md
doc: fix up some bdev-related reference errors
2018-06-19 15:18:08 +00:00
jsonrpc.md
doc: fix up some bdev-related reference errors
2018-06-19 15:18:08 +00:00
lvol.md
doc: reorganize programmer guides in index.md
2018-06-06 17:21:20 +00:00
Makefile
…
memory.md
…
misc.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
modules.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
nvme-cli.md
…
nvme.md
…
nvmf_tgt_pg.md
…
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: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
porting.md
…
prog_guides.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
README.md
…
spdkcli.md
spdkcli: initial version with bdev management
2018-04-20 13:25:21 -04:00
ssd_internals.md
…
stylesheet.css
…
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
user_guides.md
doc: use Doxygen subpages for top-level groupings
2018-06-14 16:45:51 +00:00
userspace.md
…
vagrant.md
test: move lib/nvme up one directory
2018-03-27 00:46:52 -04:00
vhost_processing.md
doc/vhost_processing: replace the ASCII diagram with an SVG one
2018-05-30 17:40:04 +00:00
vhost.md
doc: fix up some bdev-related reference errors
2018-06-19 15:18:08 +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.