From 1fe67811bb8f5db3124797a7adaafb603f78ae83 Mon Sep 17 00:00:00 2001 From: Jacek Kalwas Date: Wed, 1 Dec 2021 05:17:31 -0500 Subject: [PATCH] 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 Change-Id: I1aa5b5226e1aaf150ef069743f363f46d6c19e6d Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10497 Community-CI: Broadcom CI Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins Reviewed-by: Konrad Sztyber Reviewed-by: Jim Harris Reviewed-by: Paul Luse Reviewed-by: Tomasz Zawadzki --- include/spdk/thread.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/spdk/thread.h b/include/spdk/thread.h index 45da532a8..f767adda7 100644 --- a/include/spdk/thread.h +++ b/include/spdk/thread.h @@ -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);