RE: [PATCH v12 01/10] content: Add vq index text

[Parav Pandit <parav@nvidia.com>]

> From: Michael S. Tsirkin <mst@redhat.com>
> Sent: Wednesday, April 5, 2023 1:26 AM
> 
> On Wed, Apr 05, 2023 at 04:06:48AM +0300, Parav Pandit wrote:
> > Introduce vq index and its range so that subsequent patches can refer
> > to it.
> >
> > Fixes: https://github.com/oasis-tcs/virtio-spec/issues/163
> > Reviewed-by: Cornelia Huck <cohuck@redhat.com>
> > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > ---
> > changelog:
> > v11->v12:
> > - renamed 'number' to 'index'
> > v9->v10:
> > - added braces around vq number wording
> > - added vqn as another term for vq number
> > v8->v9:
> > - added inclusive when describing the vq number range
> > - skipped comment to put virtqueue number wording first because we
> >   prefer to use shorter vq number as much as possible
> > v5->v6:
> > - moved description close to introduction, it was in middle of
> >   queue data transfer description
> > v2->v3:
> > - new patch
> > ---
> >  content.tex | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/content.tex b/content.tex index cff548a..e64115c 100644
> > --- a/content.tex
> > +++ b/content.tex
> > @@ -298,6 +298,10 @@ \section{Virtqueues}\label{sec:Basic Facilities
> > of a Virtio Device / Virtqueues}  virtqueues\footnote{For example, the
> > simplest network device has one virtqueue for  transmit and one for receive.}.
> >
> > +Each virtqueue is identified by a vq index (also referred to as a
> > +virtqueue index); vq index range is from 0 to 65535 inclusive.
> > +
> 
> It's the other way around: start with full name, then abbreviation.
> Each virtqueue is identified by virtqueue index (sometimes abbreviated to vq
> index). A virtqueue index range ...
>
Ok. developers end up using "virtqueue index" because of addition to "sometimes".
But fine.. will change.
 
> are there more abbreviations we want to mention here? vq_idx?
> 
We don't have any user of vq_idx, so will drop for now.

> 
> >  Driver makes requests available to device by adding  an available
> > buffer to the queue, i.e., adding a buffer  describing the request to
> > a virtqueue, and optionally triggering
> > --
> > 2.26.2