Spdk/doc
Ben Walker 6b1e4e732d Drop libpciaccess and switch to DPDK PCI
This patch also drops support for automatically unbinding
devices from the kernel - run scripts/setup.sh first.

Our generic pci interface is now hidden behind include/spdk/pci.h
and implemented in lib/util/pci.c. We no longer wrap the calls
in nvme_impl.h or ioat_impl.h. The implementation now only uses
DPDK and the libpciaccess dependency has been removed. If using
a version of DPDK earlier than 16.07, enumerating devices
by class code isn't available and only Intel SSDs will be
discovered. DPDK 16.07 adds enumeration by class code and all
NVMe devices will be correctly discovered.

Change-Id: I0e8bac36b5ca57df604a2b310c47342c67dc9f3c
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
2016-10-04 15:59:00 -07:00
..
ioat doc: organize Key Functions into tables 2016-08-15 16:07:26 -07:00
iscsi Drop libpciaccess and switch to DPDK PCI 2016-10-04 15:59:00 -07:00
nvme nvme: Change the deallocate interface to generic dsm 2016-10-04 14:36:09 -07:00
nvmf doc: replace another "NVMf" with NVMe over Fabrics 2016-08-15 16:07:26 -07:00
Doxyfile iscsi: add document description about iSCSI target 2016-09-02 09:21:58 -07:00
footer.html docs: Update header and footer links in documentation 2016-07-01 14:51:35 -07:00
header.html docs: Update header and footer links in documentation 2016-07-01 14:51:35 -07:00
mainpage.txt iscsi: add document description about iSCSI target 2016-09-02 09:21:58 -07:00
Makefile doc: merge ioat and nvme into a single Doxyfile 2016-03-25 09:59:39 -07:00
README.md doc: add README.md for Doxygen and online docs 2016-10-03 14:23:15 -07:00
stylesheet.css doc: use spdk.io stylesheets 2016-03-25 14:00:15 -07:00

SPDK Documentation

The current version of the SPDK documentation can be found online at http://www.spdk.io/spdk/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.