Commit 869929a1 authored Dec 01, 2021 by Jacek Kalwas Committed by Tomasz Zawadzki Dec 02, 2021

thread: improve api description



behaviour for spdk_for_each_channel_continue was not clear when user
pass non 0 status, now it is clarified

Signed-off-by: Jacek Kalwas <jacek.kalwas@intel.com>
Change-Id: I1aa5b5226e1aaf150ef069743f363f46d6c19e6d
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10497


Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Community-CI: Mellanox Build Bot
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>

parent 6dcfa49f

include/spdk/thread.h

+2 −1

Original line number	Diff line number	Diff line
		@@ -748,7 +748,8 @@ void spdk_io_channel_get_io_device(struct spdk_io_channel ch);
		* Helper function to iterate all channels for spdk_for_each_channel().
		*
		* \param i I/O channel iterator.
		* \param status Status for the I/O channel iterator.
		* \param status Status for the I/O channel iterator;
		* for non 0 status remaining iterations are terminated.
		*/
		void spdk_for_each_channel_continue(struct spdk_io_channel_iter *i, int status);