d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update the README to point users at the examples.

Browse Source 
This is very minimal and needs to be expanded, but
at least point the users at the examples as the next
place to go.

Change-Id: I74025f7addb994f97d01accb89d2e9bc870740bf
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
This commit is contained in:
Ben Walker 2016-03-08 14:26:03 -07:00 committed by Daniel Verkamp
parent add1515c86
commit badade1eed
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -88,6 +88,17 @@ Hugepages and Device Binding
Before running an SPDK application, some hugepages must be allocated and
any NVMe and I/OAT devices must be unbound from the native kernel drivers.
SPDK includes scripts to automate this process on both Linux and FreeBSD.
Both of these scripts should be run as root.
1) scripts/configure_hugepages.sh
2) scripts/setup.sh
Examples
========
Example code is located in the examples directory. The examples are compiled
automatically as part of the build process. Simply call any of the examples
with no arguments to see the help output. You'll likely need to run the examples
as a privileged user (root) unless you've done additional configuration
to grant your user permission to allocate huge pages and map devices through
vfio.