Spdk/doc
Dariusz Stojaczyk 0eff26b3c7 doc/getting_started: mention setup.sh help
The help message was introduced in patch
5f247660d7 [1].

[1] 5f247660d7 ("setup.sh: add help message")

While here, also removed "Make sure you aren't using an NVMe
device as your boot device." note. This is no longer the case,
as we're now checking for active mountpoints before unbinding
NVMe devices.

Change-Id: I722fc25d095640505e6afe05cae4f9c39c40922e
Signed-off-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-on: https://review.gerrithub.io/396591
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
2018-01-26 14:54:30 -05:00
..
.gitignore doc: include changelog in documentation 2017-08-28 13:44:13 -04:00
about.md doc: Add an overview page for the project 2018-01-05 12:47:01 -05:00
bdev.md doc: Expand the intro section of the bdev documentation. 2018-01-17 15:11:22 -05:00
blob.md blob: add used blobid bit array for valid blobids 2017-12-21 12:28:21 -05:00
blobfs.md scripts: replace NRHUGE with HUGEMEM in setup.sh 2017-10-12 18:27:21 -04:00
concurrency.md doc: Attempt to explain I/O channels 2018-01-17 15:11:22 -05:00
directory_structure.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
Doxyfile doc: Attempt to explain I/O channels 2018-01-17 15:11:22 -05:00
event.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
footer.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
getting_started.md doc/getting_started: mention setup.sh help 2018-01-26 14:54:30 -05:00
header.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
index.md doc: Attempt to explain I/O channels 2018-01-17 15:11:22 -05:00
ioat.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
iscsi.md doc: Remove stray Intel (R) 2018-01-17 15:11:22 -05:00
jsonrpc.md doc/jsonrpc: add bdev RPC method documentation 2017-12-14 11:58:47 -05:00
lvol.md lvol: updated documentation. 2017-10-26 15:04:27 -04:00
Makefile doc: include changelog in documentation 2017-08-28 13:44:13 -04:00
memory.md Add documentation explaining memory management 2017-06-15 14:11:58 -04:00
nvme-cli.md doc: update the nvme-cli user guide 2018-01-17 17:28:31 -05:00
nvme.md doc: Improve NVMe documentation entry page 2017-06-22 15:49:28 -04:00
nvmf.md doc/nvmf: clean up and reorder the nvmf_tgt docs 2018-01-24 15:40:04 -05:00
porting.md doc: move porting guide into doc/ and add to index 2017-01-17 16:25:04 -07:00
README.md Change doc link to new spdk.io/doc location 2016-12-19 15:57:12 -07:00
stylesheet.css doc: enable Doxygen tree view navigation 2017-10-31 18:00:12 -04:00
userspace.md doc: Add an overview of user space drivers 2018-01-17 15:11:22 -05:00
vagrant.md scripts/vagrant: add vagrant-libvirt provider 2017-12-04 17:36:45 -05:00
vhost.md doc/vhost: updated user guide 2018-01-23 16:49:05 -05:00
virtio.md bdev_virtio: added doc page 2017-10-20 19:44:23 -04:00

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, install Doxygen and mscgen and run make in the doc directory. The output will be located in doc/output/html.