Commit 39240a9e authored by Cunyin Chang's avatar Cunyin Chang Committed by Jim Harris
Browse files

doc: Add notice about release share memory. 



Change-Id: Ic6f536c9e08ee22e7bbdc2e7e46f2395086e7786
Signed-off-by: default avatarCunyin Chang <cunyin.chang@intel.com>
Reviewed-on: https://review.gerrithub.io/369329


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent db4eeb9c

doc/iscsi.md

+4 −0
Original line number Diff line number Diff line
@@ -13,6 +13,10 @@ Ubuntu 14.04, 15.04, and 15.10, Fedora 21, 22, and 23, and CentOS 7. 


Once built, the binary will be in `app/iscsi_tgt`.



If you want to kill the application by using signal, make sure use the SIGTERM, then the application

will release all the shared memory resource before exit, the SIGKILL will make the shared memory

resource have no chance to be released by applications, you may need to release the resource manually.



## Configuring iSCSI Target {#iscsi_config}



A `iscsi_tgt` specific configuration file is used to configure the iSCSI target. A fully documented

doc/nvmf.md

+4 −0
Original line number Diff line number Diff line
@@ -23,6 +23,10 @@ machine, the kernel will need to be a release candidate until the code is actual 
system running the SPDK target, however, you can run any modern flavor of Linux as required by your

NIC vendor's OFED distribution.



If you want to kill the application using signal, make sure use the SIGTERM, then the application

will release all the share memory resource before exit, the SIGKILL will make the share memory

resource have no chance to be released by application, you may need to release the resource manually.



## Prerequisites {#nvmf_prereqs}



This guide starts by assuming that you can already build the standard SPDK distribution on your

doc/vhost.md

+4 −0
Original line number Diff line number Diff line
@@ -11,6 +11,10 @@ VMs and process I/O submitted to devices attached to those controllers. 
The base SPDK build instructions are located in README.md in the SPDK root directory.

This guide assumes familiarity with building SPDK using the default options.



If you want to kill the application using signal, make sure use the SIGTERM, then the application

will release all the share memory resource before exit, the SIGKILL will make the share memory

resource have no chance to be released by application, you may need to release the resource manually.



## Supported Guest Operating Systems



The guest OS must contain virtio drivers. The SPDK vhost target has been tested