[PATCH] block: mq: Add some minor doc for core structs

[PATCH] block: mq: Add some minor doc for core structs

[Linus Walleij]

As it came up in discussion on the mailing list that the semantic
meaning of 'blk_mq_ctx' and 'blk_mq_hw_ctx' isn't completely
obvious to everyone, let's add some minimal kerneldoc for a
starter.

Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
---
 block/blk-mq.h         | 3 +++
 include/linux/blk-mq.h | 3 +++
 2 files changed, 6 insertions(+)

diff --git a/block/blk-mq.h b/block/blk-mq.h
index 88c558f71819..89b5cd3a6c70 100644
--- a/block/blk-mq.h
+++ b/block/blk-mq.h
@@ -7,6 +7,9 @@
 
 struct blk_mq_tag_set;
 
+/**
+ * struct blk_mq_ctx - State for a software queue facing the submitting CPUs
+ */
 struct blk_mq_ctx {
 	struct {
 		spinlock_t		lock;
diff --git a/include/linux/blk-mq.h b/include/linux/blk-mq.h
index e3986f4b3461..ebc34a5686dc 100644
--- a/include/linux/blk-mq.h
+++ b/include/linux/blk-mq.h
@@ -9,6 +9,9 @@
 struct blk_mq_tags;
 struct blk_flush_queue;
 
+/**
+ * struct blk_mq_hw_ctx - State for a hardware queue facing the hardware block device
+ */
 struct blk_mq_hw_ctx {
 	struct {
 		spinlock_t		lock;
-- 
2.14.3

Re: [PATCH] block: mq: Add some minor doc for core structs

[Jens Axboe]

On 4/20/18 2:29 AM, Linus Walleij wrote:
> As it came up in discussion on the mailing list that the semantic
> meaning of 'blk_mq_ctx' and 'blk_mq_hw_ctx' isn't completely
> obvious to everyone, let's add some minimal kerneldoc for a
> starter.

Thanks Linus, applied.

-- 
Jens Axboe