Commit 0eff26b3 authored by Dariusz Stojaczyk's avatar Dariusz Stojaczyk Committed by Jim Harris
Browse files

doc/getting_started: mention `setup.sh help` 



The help message was introduced in patch
5f247660 [1].

[1] 5f247660 ("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: default avatarDariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-on: https://review.gerrithub.io/396591


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent d4822a7d

doc/getting_started.md

+7 −1
Original line number Diff line number Diff line
@@ -69,7 +69,7 @@ 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 a script to automate this process on both Linux and FreeBSD.

This script should be run as root. It only needs to be run once on the

system. *Make sure you aren't using an NVMe device as your boot device.*

system.



~~~{.sh}

sudo scripts/setup.sh
@@ -91,6 +91,12 @@ sudo HUGEMEM=4096 scripts/setup.sh 
On Linux machines HUGEMEM will be rounded up to system-default huge page

size boundary.



All available params can be viewed by running



~~~{.sh}

scripts/setup.sh help

~~~



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. If your system has its IOMMU