From: tone-zhang <tone.zhang@arm.com>
Date: Fri, 1 Jun 2018 09:39:24 +0000 (+0000)
Subject: doc: update the description for SPDK in bluestore-config-ref.rst
X-Git-Tag: v14.0.1~1178^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=78012eed1bf125ec37afa7605fa64cc798036e18;p=ceph.git

doc: update the description for SPDK in bluestore-config-ref.rst

Add more information to show the device initialization in SPDK.

Signed-off-by: tone-zhang <tone.zhang@arm.com>
---

diff --git a/doc/rados/configuration/bluestore-config-ref.rst b/doc/rados/configuration/bluestore-config-ref.rst
index 8c7e4284c63..966d0143754 100644
--- a/doc/rados/configuration/bluestore-config-ref.rst
+++ b/doc/rados/configuration/bluestore-config-ref.rst
@@ -301,8 +301,18 @@ set with::
 SPDK Usage
 ==================
 
-If you want to use SPDK driver for NVME SSD, you need to specify NVMe serial
-number here with "spdk:" prefix for ``bluestore_block_path``.
+If you want to use SPDK driver for NVME SSD, you need to ready your system.
+Please refer to `SPDK document`__ for more detailes.
+
+.. __: http://www.spdk.io/doc/getting_started.html#getting_started_examples
+
+SPDK offers a script to configure the device automatically. Users can run the
+script as root::
+
+  $ sudo src/spdk/scripts/setup.sh
+
+Then you need to specify NVMe serial number here with "spdk:" prefix for
+``bluestore_block_path``.
 
 For example, users can find the serial number with::