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

doc: update the nvme-cli user guide

Browse Source 
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 <gang.cao@intel.com>
Reviewed-on: https://review.gerrithub.io/394563
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
This commit is contained in:
GangCao 2018-01-12 02:45:39 -05:00 committed by Jim Harris
parent 6d4d942b2a
commit 10525c9366
1 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/nvme-cli.md
View File

@ -2,7 +2,8 @@
# nvme-cli with SPDK Getting Started Guide # 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. 1. Clone the nvme-cli repository from the SPDK GitHub fork. Make sure you check out the spdk branch.
~~~{.sh} ~~~{.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 Example: ./nvme smart-log 0000:01:00.0
~~~ ~~~
9. Execute "<spdk_folder>/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 "<spdk_folder>/scripts/setup.sh reset" with the "root" account and update "spdk=0" in spdk.conf to
use the kernel driver if wanted. use the kernel driver if wanted.
## Use scenarios ## Use scenarios
@ -69,5 +75,8 @@ b. Change the mem_size to a proper size.
~~~ ~~~
## Note ## Note
To run the newly built nvme-cli, either explicitly run as "./nvme" or added it into the $PATH to avoid invoke 1. To run the newly built nvme-cli, either explicitly run as "./nvme" or added it into the $PATH to avoid
other already installed version. 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.