From 0eff26b3c71b8e8515d489b15374cac5e73efa50 Mon Sep 17 00:00:00 2001 From: Dariusz Stojaczyk Date: Fri, 26 Jan 2018 16:40:12 +0100 Subject: [PATCH] doc/getting_started: mention `setup.sh help` 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 Reviewed-on: https://review.gerrithub.io/396591 Tested-by: SPDK Automated Test System Reviewed-by: Daniel Verkamp Reviewed-by: Jim Harris --- doc/getting_started.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/doc/getting_started.md b/doc/getting_started.md index ac37b38f3..447bbcccd 100644 --- a/doc/getting_started.md +++ b/doc/getting_started.md @@ -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