util: updated doc of spdk_put_io_channel

Patch 5533c3d2 changed spdk_put_io_channel behavior without updating the
docs. This patch fixes that.

Fixes: 5533c3d208 ("util: defer put_io_channel")

Change-Id: I587ce13f3caa4caa9d39e4ab85a197beea883f94
Signed-off-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-on: https://review.gerrithub.io/369720
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Ben Walker <benjamin.walker@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
This commit is contained in:
Dariusz Stojaczyk 2017-07-17 11:01:58 +02:00 committed by Daniel Verkamp
parent 5177ed40c4
commit ebaa8ff7f9

View File

@ -128,12 +128,12 @@ void spdk_io_device_unregister(void *io_device);
struct spdk_io_channel *spdk_get_io_channel(void *io_device);
/**
* \brief Releases a reference to an I/O channel.
* \brief Releases a reference to an I/O channel. This happens asynchronously.
*
* Must be called from the same thread that called spdk_get_io_channel() for the specified
* I/O channel. If this releases the last reference to the I/O channel, The destroy_cb
* function specified in spdk_io_device_register() will be invoked to release any
* associated resources.
* Actual release will happen on the same thread that called spdk_get_io_channel() for the
* specified I/O channel. If this releases the last reference to the I/O channel, The
* destroy_cb function specified in spdk_io_device_register() will be invoked to release
* any associated resources.
*/
void spdk_put_io_channel(struct spdk_io_channel *ch);