[4/8] block: Fix blk_mq_*_map_queues() kernel-doc headers
diff mbox series

Message ID 20190531000053.64053-5-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
This patch avoids that the kernel-doc script complains about these
function headers when building with W=1.

Cc: Hannes Reinecke <hare@suse.com>
Cc: Keith Busch <keith.busch@intel.com>
Fixes: ed76e329d74a ("blk-mq: abstract out queue map") # v5.0.
Fixes: e42b3867de4b ("blk-mq-rdma: pass in queue map to blk_mq_rdma_map_queues") # v5.0.
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 block/blk-mq-pci.c    | 2 +-
 block/blk-mq-rdma.c   | 4 ++--
 block/blk-mq-virtio.c | 4 ++--
 3 files changed, 5 insertions(+), 5 deletions(-)

Comments

Chaitanya Kulkarni May 31, 2019, 2:01 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:
> This patch avoids that the kernel-doc script complains about these
> function headers when building with W=1.
> 
> Cc: Hannes Reinecke <hare@suse.com>
> Cc: Keith Busch <keith.busch@intel.com>
> Fixes: ed76e329d74a ("blk-mq: abstract out queue map") # v5.0.
> Fixes: e42b3867de4b ("blk-mq-rdma: pass in queue map to blk_mq_rdma_map_queues") # v5.0.
> Signed-off-by: Bart Van Assche <bvanassche@acm.org>
> ---
>   block/blk-mq-pci.c    | 2 +-
>   block/blk-mq-rdma.c   | 4 ++--
>   block/blk-mq-virtio.c | 4 ++--
>   3 files changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/block/blk-mq-pci.c b/block/blk-mq-pci.c
> index ad4545a2a98b..b595a94c4d16 100644
> --- a/block/blk-mq-pci.c
> +++ b/block/blk-mq-pci.c
> @@ -13,7 +13,7 @@
>   
>   /**
>    * blk_mq_pci_map_queues - provide a default queue mapping for PCI device
> - * @set:	tagset to provide the mapping for
> + * @qmap:	CPU to hardware queue map.
>    * @pdev:	PCI device associated with @set.
>    * @offset:	Offset to use for the pci irq vector
>    *
> diff --git a/block/blk-mq-rdma.c b/block/blk-mq-rdma.c
> index cc921e6ba709..14f968e58b8f 100644
> --- a/block/blk-mq-rdma.c
> +++ b/block/blk-mq-rdma.c
> @@ -8,8 +8,8 @@
>   
>   /**
>    * blk_mq_rdma_map_queues - provide a default queue mapping for rdma device
> - * @set:	tagset to provide the mapping for
> - * @dev:	rdma device associated with @set.
> + * @map:	CPU to hardware queue map.
> + * @dev:	rdma device to provide a mapping for.
>    * @first_vec:	first interrupt vectors to use for queues (usually 0)
>    *
>    * This function assumes the rdma device @dev has at least as many available
> diff --git a/block/blk-mq-virtio.c b/block/blk-mq-virtio.c
> index 75a52c18a8f6..488341628256 100644
> --- a/block/blk-mq-virtio.c
> +++ b/block/blk-mq-virtio.c
> @@ -11,8 +11,8 @@
>   
>   /**
>    * blk_mq_virtio_map_queues - provide a default queue mapping for virtio device
> - * @set:	tagset to provide the mapping for
> - * @vdev:	virtio device associated with @set.
> + * @qmap:	CPU to hardware queue map.
> + * @vdev:	virtio device to provide a mapping for.
>    * @first_vec:	first interrupt vectors to use for queues (usually 0)
>    *
>    * This function assumes the virtio device @vdev has at least as many available
>

Patch
diff mbox series

diff --git a/block/blk-mq-pci.c b/block/blk-mq-pci.c
index ad4545a2a98b..b595a94c4d16 100644
--- a/block/blk-mq-pci.c
+++ b/block/blk-mq-pci.c
@@ -13,7 +13,7 @@ 
 
 /**
  * blk_mq_pci_map_queues - provide a default queue mapping for PCI device
- * @set:	tagset to provide the mapping for
+ * @qmap:	CPU to hardware queue map.
  * @pdev:	PCI device associated with @set.
  * @offset:	Offset to use for the pci irq vector
  *
diff --git a/block/blk-mq-rdma.c b/block/blk-mq-rdma.c
index cc921e6ba709..14f968e58b8f 100644
--- a/block/blk-mq-rdma.c
+++ b/block/blk-mq-rdma.c
@@ -8,8 +8,8 @@ 
 
 /**
  * blk_mq_rdma_map_queues - provide a default queue mapping for rdma device
- * @set:	tagset to provide the mapping for
- * @dev:	rdma device associated with @set.
+ * @map:	CPU to hardware queue map.
+ * @dev:	rdma device to provide a mapping for.
  * @first_vec:	first interrupt vectors to use for queues (usually 0)
  *
  * This function assumes the rdma device @dev has at least as many available
diff --git a/block/blk-mq-virtio.c b/block/blk-mq-virtio.c
index 75a52c18a8f6..488341628256 100644
--- a/block/blk-mq-virtio.c
+++ b/block/blk-mq-virtio.c
@@ -11,8 +11,8 @@ 
 
 /**
  * blk_mq_virtio_map_queues - provide a default queue mapping for virtio device
- * @set:	tagset to provide the mapping for
- * @vdev:	virtio device associated with @set.
+ * @qmap:	CPU to hardware queue map.
+ * @vdev:	virtio device to provide a mapping for.
  * @first_vec:	first interrupt vectors to use for queues (usually 0)
  *
  * This function assumes the virtio device @vdev has at least as many available