ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc/getting_started: mention setup.sh help

Browse Source 
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>
This commit is contained in:
Dariusz Stojaczyk 2018-01-26 16:40:12 +01:00 committed by Jim Harris
parent d4822a7db5
commit 0eff26b3c7
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/getting_started.md
View File

@ -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. 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. 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 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} ~~~{.sh}
sudo scripts/setup.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 On Linux machines HUGEMEM will be rounded up to system-default huge page
size boundary. 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 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 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 with no arguments to see the help output. If your system has its IOMMU