Re: [PATCH v2 0/7] Rename queue index to queue number

["Michael S. Tsirkin" <mst@redhat.com>]

On Tue, Mar 21, 2023 at 06:10:29AM +0200, Parav Pandit wrote:
> 1. Currently, virtqueue is identified between driver and device
> interchangeably using either number of index terminology.
> 
> 2. Between PCI and MMIO transport the queue size (depth) is
> defined as queue_size and QueueNum respectively.
> 
> To avoid confusion and to have consistency, unify them to use as Number.
> 
> Solution:
> a. Use virtqueue number description, and rename MMIO register as QueueSize.
> b. Replace virtqueue index to virtqueue number
> c. RSS area of virtio net has inherited some logic, describe it
> using abstract rq_handle.
> 
> Patch summary:
> patch-1 renames index to number for pci transport
> patch-2 renames mmio register from Num to Size
> patch-3 renames index to number for mmio transport
> patch-4 renames num field to size for ccw transport
> patch-5 renames index field to queue_select for ccw transport
> patch-6 for virtio-net removes duplicate example from requirements
> patch-7 for virtio-net updates rss description to use vq number
> 
> This series only improves the documentation, it does not change any
> transport or device functionality.
> 
> Please review.
> This series fixes the issue [1].
> 
> [1] https://github.com/oasis-tcs/virtio-spec/issues/163

OK overall but I feel this lacks a definition of what a virtqueue number
is in some transport and device independent place.
Maybe in the virtqueues chapter?
Just "
Each virtqueue is identified by a 0 based virtqueue number. Thus
virtqueues are numbered 0,1,2 and so on.
"

will do.

> ---
> changelog:
> v1->v2:
> - added patches for virtio net for rss area
> - added patches for covering ccw transport
> - added missing entries to refer in mmio transport
> 
> Parav Pandit (7):
>   transport-pci: Refer to the vq by its number
>   transport-mmio: Rename QueueNum register
>   transport-mmio: Refer to the vq by its number
>   transport-ccw: Rename queue depth/size to other transports
>   transport-ccw: Refer to the vq by its number
>   virtio-net: Avoid duplicate receive queue example
>   virtio-net: Describe RSS using receive queue handle
> 
>  device-types/net/description.tex | 26 +++++++++++----
>  transport-ccw.tex                | 39 +++++++++++++++-------
>  transport-mmio.tex               | 56 +++++++++++++++++++-------------
>  transport-pci.tex                |  6 ++--
>  4 files changed, 84 insertions(+), 43 deletions(-)
> 
> -- 
> 2.26.2