[8/8] blk-mq: Document the blk_mq_hw_queue_to_node() arguments
diff mbox series

Message ID 20190531000053.64053-9-bvanassche@acm.org
State New
Headers show
Series
  • Improve block layer function documentation
Related show

Commit Message

Bart Van Assche May 31, 2019, midnight UTC
Document the meaning of the blk_mq_hw_queue_to_node() arguments.

Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 block/blk-mq-cpumap.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

Comments

Chaitanya Kulkarni May 31, 2019, 2:04 a.m. UTC | #1
Looks good.

Reviewed-by: Chaitanya Kulkarni <chiatanya.kulkarni@wdc.com>

On 5/30/19 5:01 PM, Bart Van Assche wrote:
> Document the meaning of the blk_mq_hw_queue_to_node() arguments.
> 
> Signed-off-by: Bart Van Assche <bvanassche@acm.org>
> ---
>   block/blk-mq-cpumap.c | 6 +++++-
>   1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/block/blk-mq-cpumap.c b/block/blk-mq-cpumap.c
> index 0afa4dc48365..f945621a0e8f 100644
> --- a/block/blk-mq-cpumap.c
> +++ b/block/blk-mq-cpumap.c
> @@ -60,7 +60,11 @@ int blk_mq_map_queues(struct blk_mq_queue_map *qmap)
>   }
>   EXPORT_SYMBOL_GPL(blk_mq_map_queues);
>   
> -/*
> +/**
> + * blk_mq_hw_queue_to_node - Look up the memory node for a hardware queue index
> + * @qmap: CPU to hardware queue map.
> + * @index: hardware queue index.
> + *
>    * We have no quick way of doing reverse lookups. This is only used at
>    * queue init time, so runtime isn't important.
>    */
>

Patch
diff mbox series

diff --git a/block/blk-mq-cpumap.c b/block/blk-mq-cpumap.c
index 0afa4dc48365..f945621a0e8f 100644
--- a/block/blk-mq-cpumap.c
+++ b/block/blk-mq-cpumap.c
@@ -60,7 +60,11 @@  int blk_mq_map_queues(struct blk_mq_queue_map *qmap)
 }
 EXPORT_SYMBOL_GPL(blk_mq_map_queues);
 
-/*
+/**
+ * blk_mq_hw_queue_to_node - Look up the memory node for a hardware queue index
+ * @qmap: CPU to hardware queue map.
+ * @index: hardware queue index.
+ *
  * We have no quick way of doing reverse lookups. This is only used at
  * queue init time, so runtime isn't important.
  */