From 10525c9366c38d28fcb66eaab93c47401a96637e Mon Sep 17 00:00:00 2001 From: GangCao Date: Fri, 12 Jan 2018 02:45:39 -0500 Subject: [PATCH] doc: update the nvme-cli user guide Update the content to support Intel specific commands and add a note on the usage about spdk.conf file. Change-Id: Id9bcac3719c951d3f4e9f6fe922004b3c325fabb Signed-off-by: GangCao Reviewed-on: https://review.gerrithub.io/394563 Tested-by: SPDK Automated Test System Reviewed-by: Jim Harris Reviewed-by: Daniel Verkamp --- doc/nvme-cli.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/doc/nvme-cli.md b/doc/nvme-cli.md index ec0124a89..5569cc608 100644 --- a/doc/nvme-cli.md +++ b/doc/nvme-cli.md @@ -2,7 +2,8 @@ # nvme-cli with SPDK Getting Started Guide -Now nvme-cli can support both kernel driver and SPDK user mode driver for most of its available commands. +Now nvme-cli can support both kernel driver and SPDK user mode driver for most of its available commands and +Intel specific commands. 1. Clone the nvme-cli repository from the SPDK GitHub fork. Make sure you check out the spdk branch. ~~~{.sh} @@ -40,7 +41,12 @@ This nvme-cli will access those devices from that running SPDK application. Example: ./nvme smart-log 0000:01:00.0 ~~~ -9. Execute "/scripts/setup.sh reset" with the "root" account and update "spdk=0" in spdk.conf to +9. Run the "./nvme intel" commands for Intel specific commands against Intel NVMe SSD. +~~~{.sh} +Example: ./nvme intel internal-log 0000:08:00.0 +~~~ + +10. Execute "/scripts/setup.sh reset" with the "root" account and update "spdk=0" in spdk.conf to use the kernel driver if wanted. ## Use scenarios @@ -69,5 +75,8 @@ b. Change the mem_size to a proper size. ~~~ ## Note -To run the newly built nvme-cli, either explicitly run as "./nvme" or added it into the $PATH to avoid invoke -other already installed version. +1. To run the newly built nvme-cli, either explicitly run as "./nvme" or added it into the $PATH to avoid +invoke other already installed version. + +2. To run the newly built nvme-cli with SPDK support in arbitrary directory, copy "spdk.conf" to that +directory from the nvme cli folder and update the configuration as suggested.