Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Dongli Zhang <dongli.zhang@oracle.com>
To:     linux-block@vger.kernel.org
Cc:     axboe@kernel.dk, linux-kernel@vger.kernel.org
Subject: [PATCH 1/1] blk-mq: fix comment as bt_tags_for_each() is not only for started request
Date:   Tue, 20 Oct 2020 15:41:32 -0700
Message-Id: <20201020224132.22539-1-dongli.zhang@oracle.com>
Precedence: bulk

Since the introduction of 'BT_TAG_ITER_STARTED' by commit 602380d28e28
("blk-mq: add blk_mq_all_tag_iter"), the bt_tags_for_each() is not only
used for started request, e.g., in below case:

blk_mq_hctx_has_requests()
-> blk_mq_all_tag_iter()
   -> __blk_mq_all_tag_iter() --> only BT_TAG_ITER_STATIC_RQS is set
      -> bt_tags_for_each()
         -> bt_tags_iter()

Signed-off-by: Dongli Zhang <dongli.zhang@oracle.com>
---
 block/blk-mq-tag.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/block/blk-mq-tag.c b/block/blk-mq-tag.c
index 9c92053e704d..43af5063fe2e 100644
--- a/block/blk-mq-tag.c
+++ b/block/blk-mq-tag.c
@@ -289,10 +289,10 @@ static bool bt_tags_iter(struct sbitmap *bitmap, unsigned int bitnr, void *data)
  * @tags:	Tag map to iterate over.
  * @bt:		sbitmap to examine. This is either the breserved_tags member
  *		or the bitmap_tags member of struct blk_mq_tags.
- * @fn:		Pointer to the function that will be called for each started
- *		request. @fn will be called as follows: @fn(rq, @data,
- *		@reserved) where rq is a pointer to a request. Return true
- *		to continue iterating tags, false to stop.
+ * @fn:		Pointer to the function that will be called for each request
+ *		depending on the value of @flags. @fn will be called as
+ *		follows: @fn(rq, @data, @reserved) where rq is a pointer to a
+ *		request. Return true to continue iterating tags, false to stop.
  * @data:	Will be passed as second argument to @fn.
  * @flags:	BT_TAG_ITER_*
  */
-- 
2.17.1