Commit 4f0f474f authored by Tomasz Zawadzki's avatar Tomasz Zawadzki
Browse files

doc/cuse: updated docs to reflect current state 



nvme-cuse is no longer considered experimental,
now enabled on all Linux systems, and is part of
pkgdep.sh defaults.

Signed-off-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: Id65669e9b8ada3c971fc148c0cf265ba0685eb97
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/21461


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: default avatarJim Harris <jim.harris@samsung.com>
Reviewed-by: default avatarKonrad Sztyber <konrad.sztyber@intel.com>
parent d9330ec0

doc/bdev.md

+0 −3
Original line number Diff line number Diff line
@@ -442,9 +442,6 @@ The SPDK NVMe bdev driver provides the multipath feature. Please refer to 


### NVMe bdev character device {#bdev_config_nvme_cuse}



This feature is considered as experimental. You must configure with --with-nvme-cuse

option to enable this RPC.



Example commands



`rpc.py bdev_nvme_cuse_register -n Nvme3`

doc/jsonrpc.md

+0 −2
Original line number Diff line number Diff line
@@ -4668,7 +4668,6 @@ Example response: 
### bdev_nvme_cuse_register {#rpc_bdev_nvme_cuse_register}



Register CUSE device on NVMe controller.

This feature is considered as experimental.



#### Parameters
@@ -4704,7 +4703,6 @@ Example response: 
### bdev_nvme_cuse_unregister {#rpc_bdev_nvme_cuse_unregister}



Unregister CUSE device on NVMe controller.

This feature is considered as experimental.



#### Parameters

doc/nvme.md

+2 −4
Original line number Diff line number Diff line
@@ -329,12 +329,10 @@ This interface reserves one additional qpair for sending down the I/O for each c 


#### Enabling cuse support for NVMe



Cuse support is disabled by default. To enable support for NVMe-CUSE devices first

install required dependencies

Cuse support is enabled by default on Linux. Make sure to install required dependencies:

~~~{.sh}

sudo scripts/pkgdep.sh --fuse

sudo scripts/pkgdep.sh

~~~

Then compile SPDK with "./configure --with-nvme-cuse".



#### Creating NVMe-CUSE device