numam-spdk/doc
Hailiang Wang f062f79768 scripts: replace NRHUGE with HUGEMEM in setup.sh
This allows to use same command
for allocating hugepages on
systems with different hugepage
sizes.

The old NRHUGE variable can be
still set on Linux machines,
but is currently undocumented.

Change-Id: I1fba315d95e9aae8b6a8c9c445deb447fecc65dc
Signed-off-by: Hailiang Wang <hailiangx.e.wang@intel.com>
Signed-off-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-on: https://review.gerrithub.io/369546
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
2017-10-12 18:27:21 -04:00
..
.gitignore doc: include changelog in documentation 2017-08-28 13:44:13 -04:00
bdev.md lvol: Documentation 2017-09-14 19:31:02 -04:00
blob.md blob: Add support for crc of super block. 2017-09-20 19:56:57 -04:00
blobfs.md scripts: replace NRHUGE with HUGEMEM in setup.sh 2017-10-12 18:27:21 -04:00
directory_structure.md vhost: Getting Started for SPDK vhost 2017-03-29 13:09:57 -07:00
Doxyfile doc: add JSON-RPC docs for nvmf_tgt methods 2017-10-12 16:37:52 -04: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 scripts: replace NRHUGE with HUGEMEM in setup.sh 2017-10-12 18:27:21 -04:00
header.html doc: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
index.md doc: add JSON-RPC docs for nvmf_tgt methods 2017-10-12 16:37:52 -04:00
ioat.md doc: flatten Markdown docs into chapter-per-file 2017-04-30 07:58:26 -07:00
iscsi.md doc: add a section for user guides 2017-09-26 19:40:58 -04:00
jsonrpc.md doc: add JSON-RPC docs for nvmf_tgt methods 2017-10-12 16:37:52 -04:00
lvol.md lvol: Documentation 2017-09-14 19:31:02 -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: add the documentation for nvme-cli support 2017-07-19 13:52:14 -04:00
nvme.md doc: Improve NVMe documentation entry page 2017-06-22 15:49:28 -04:00
nvmf.md doc: add a section for user guides 2017-09-26 19:40:58 -04: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: simplify HTML header and stylesheet 2017-04-28 13:13:48 -07:00
vagrant.md doc/vagrant: add commands to run for proxyconf 2017-09-18 12:53:49 -04:00
vhost.md doc: update vhost known bugs section 2017-08-10 13:35:18 -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.