virtio-dev.lists.oasis-open.org archive mirror
 help / color / mirror / Atom feed
* [virtio-dev] [PATCH] device-types/multiple: replace queues with enqueues
@ 2023-04-11 20:03 Parav Pandit
  2023-04-19  1:54 ` [virtio-dev] " Parav Pandit
                   ` (2 more replies)
  0 siblings, 3 replies; 6+ messages in thread
From: Parav Pandit @ 2023-04-11 20:03 UTC (permalink / raw)
  To: mst, virtio-dev, pasic, cohuck; +Cc: virtio-comment, shahafs, Parav Pandit

Queue is a verb and noun both. Replacing it with enqueue avoids
ambiguity around plural queues noun vs verb; similar to virtio fs device
description.

Suggested-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
 device-types/blk/description.tex   | 2 +-
 device-types/gpio/description.tex  | 4 ++--
 device-types/i2c/description.tex   | 2 +-
 device-types/scsi/description.tex  | 2 +-
 device-types/vsock/description.tex | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/device-types/blk/description.tex b/device-types/blk/description.tex
index 517b012..f04c932 100644
--- a/device-types/blk/description.tex
+++ b/device-types/blk/description.tex
@@ -427,7 +427,7 @@ \subsubsection{Legacy Interface: Device Initialization}\label{sec:Device Types /
 
 \subsection{Device Operation}\label{sec:Device Types / Block Device / Device Operation}
 
-The driver queues requests to the virtqueues, and they are used by
+The driver enqueues requests to the virtqueues, and they are used by
 the device (not necessarily in order). Each request except
 VIRTIO_BLK_T_ZONE_APPEND is of form:
 
diff --git a/device-types/gpio/description.tex b/device-types/gpio/description.tex
index 8e5c7f0..d51fbe1 100644
--- a/device-types/gpio/description.tex
+++ b/device-types/gpio/description.tex
@@ -358,7 +358,7 @@ \subsubsection{requestq Operation: Set IRQ Type}\label{sec:Device Types / GPIO D
 \subsubsection{requestq Operation: Message Flow}\label{sec:Device Types / GPIO Device / requestq Operation / Message Flow}
 
 \begin{itemize}
-\item The driver queues \field{struct virtio_gpio_request} and
+\item The driver enqueues \field{struct virtio_gpio_request} and
     \field{virtio_gpio_response} buffers to the \field{requestq} virtqueue,
     after filling all fields of the \field{struct virtio_gpio_request} buffer as
     defined by the specific message type.
@@ -458,7 +458,7 @@ \subsection{Device Operation: eventq}\label{sec:Device Types / GPIO Device / eve
 
 The \field{eventq} virtqueue is used by the driver to unmask the interrupts and
 used by the device to notify the driver of newly sensed interrupts. In order to
-unmask interrupt on a GPIO line, the driver queues a pair of buffers,
+unmask interrupt on a GPIO line, the driver enqueues a pair of buffers,
 \field{struct virtio_gpio_irq_request} (filled by driver) and \field{struct
 virtio_gpio_irq_response} (to be filled by device later), to the \field{eventq}
 virtqueue. A separate pair of buffers must be queued for each GPIO line, the
diff --git a/device-types/i2c/description.tex b/device-types/i2c/description.tex
index 5d407cb..861529a 100644
--- a/device-types/i2c/description.tex
+++ b/device-types/i2c/description.tex
@@ -47,7 +47,7 @@ \subsection{Device Operation}\label{sec:Device Types / I2C Adapter Device / Devi
 
 \subsubsection{Device Operation: Request Queue}\label{sec:Device Types / I2C Adapter Device / Device Operation: Request Queue}
 
-The driver queues requests to the virtqueue, and they are used by the
+The driver enqueues requests to the virtqueue, and they are used by the
 device. The request is the representation of segments of an I2C
 transaction. Each request is of the form:
 
diff --git a/device-types/scsi/description.tex b/device-types/scsi/description.tex
index 904c4a7..478b558 100644
--- a/device-types/scsi/description.tex
+++ b/device-types/scsi/description.tex
@@ -158,7 +158,7 @@ \subsection{Device Operation}\label{sec:Device Types / SCSI Host Device / Device
 
 \subsubsection{Device Operation: Request Queues}\label{sec:Device Types / SCSI Host Device / Device Operation / Device Operation: Request Queues}
 
-The driver queues requests to an arbitrary request queue, and
+The driver enqueues requests to an arbitrary request queue, and
 they are used by the device on that same queue. It is the
 responsibility of the driver to ensure strict request ordering
 for commands placed on different queues, because they will be
diff --git a/device-types/vsock/description.tex b/device-types/vsock/description.tex
index 105bb30..07909d6 100644
--- a/device-types/vsock/description.tex
+++ b/device-types/vsock/description.tex
@@ -218,7 +218,7 @@ \subsubsection{Buffer Space Management}\label{sec:Device Types / Socket Device /
 \field{buf_alloc} and \field{fwd_cnt} fields.
 
 \subsubsection{Receive and Transmit}\label{sec:Device Types / Socket Device / Device Operation / Receive and Transmit}
-The driver queues outgoing packets on the tx virtqueue and incoming packet
+The driver enqueues outgoing packets on the tx virtqueue and incoming packet
 receive buffers on the rx virtqueue. Packets are of the following form:
 
 \begin{lstlisting}
-- 
2.26.2


---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org


^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [virtio-dev] RE: [PATCH] device-types/multiple: replace queues with enqueues
  2023-04-11 20:03 [virtio-dev] [PATCH] device-types/multiple: replace queues with enqueues Parav Pandit
@ 2023-04-19  1:54 ` Parav Pandit
  2023-04-19  7:17 ` [virtio-dev] " Michael S. Tsirkin
  2023-04-19 13:33 ` Cornelia Huck
  2 siblings, 0 replies; 6+ messages in thread
From: Parav Pandit @ 2023-04-19  1:54 UTC (permalink / raw)
  To: mst, virtio-dev, pasic, cohuck; +Cc: virtio-comment, Shahaf Shuler



> From: Parav Pandit <parav@nvidia.com>
> Sent: Tuesday, April 11, 2023 4:04 PM
> Queue is a verb and noun both. Replacing it with enqueue avoids ambiguity
> around plural queues noun vs verb; similar to virtio fs device description.
> 
> Suggested-by: Michael S. Tsirkin <mst@redhat.com>
> Signed-off-by: Parav Pandit <parav@nvidia.com>

Can you please take this reword change also forward?

---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [virtio-dev] Re: [PATCH] device-types/multiple: replace queues with enqueues
  2023-04-11 20:03 [virtio-dev] [PATCH] device-types/multiple: replace queues with enqueues Parav Pandit
  2023-04-19  1:54 ` [virtio-dev] " Parav Pandit
@ 2023-04-19  7:17 ` Michael S. Tsirkin
  2023-04-19 13:33 ` Cornelia Huck
  2 siblings, 0 replies; 6+ messages in thread
From: Michael S. Tsirkin @ 2023-04-19  7:17 UTC (permalink / raw)
  To: Parav Pandit; +Cc: virtio-dev, pasic, cohuck, virtio-comment, shahafs

On Tue, Apr 11, 2023 at 11:03:58PM +0300, Parav Pandit wrote:
> Queue is a verb and noun both. Replacing it with enqueue avoids
> ambiguity around plural queues noun vs verb; similar to virtio fs device
> description.
> 
> Suggested-by: Michael S. Tsirkin <mst@redhat.com>

Heh, kind of. but ok.

> Signed-off-by: Parav Pandit <parav@nvidia.com>

Take this example:
-The driver queues requests to the virtqueues, and they are used by
+The driver enqueues requests to the virtqueues, and they are used by
clearly an improvement.

we could be more formal and switch to "adds" or even "makes available"
but hey, small steps.

Acked-by: Michael S. Tsirkin <mst@redhat.com>

Cornelia I think this can go in directly. If you agree pls commit.

> ---
>  device-types/blk/description.tex   | 2 +-
>  device-types/gpio/description.tex  | 4 ++--
>  device-types/i2c/description.tex   | 2 +-
>  device-types/scsi/description.tex  | 2 +-
>  device-types/vsock/description.tex | 2 +-
>  5 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/device-types/blk/description.tex b/device-types/blk/description.tex
> index 517b012..f04c932 100644
> --- a/device-types/blk/description.tex
> +++ b/device-types/blk/description.tex
> @@ -427,7 +427,7 @@ \subsubsection{Legacy Interface: Device Initialization}\label{sec:Device Types /
>  
>  \subsection{Device Operation}\label{sec:Device Types / Block Device / Device Operation}
>  
> -The driver queues requests to the virtqueues, and they are used by
> +The driver enqueues requests to the virtqueues, and they are used by
>  the device (not necessarily in order). Each request except
>  VIRTIO_BLK_T_ZONE_APPEND is of form:
>  
> diff --git a/device-types/gpio/description.tex b/device-types/gpio/description.tex
> index 8e5c7f0..d51fbe1 100644
> --- a/device-types/gpio/description.tex
> +++ b/device-types/gpio/description.tex
> @@ -358,7 +358,7 @@ \subsubsection{requestq Operation: Set IRQ Type}\label{sec:Device Types / GPIO D
>  \subsubsection{requestq Operation: Message Flow}\label{sec:Device Types / GPIO Device / requestq Operation / Message Flow}
>  
>  \begin{itemize}
> -\item The driver queues \field{struct virtio_gpio_request} and
> +\item The driver enqueues \field{struct virtio_gpio_request} and
>      \field{virtio_gpio_response} buffers to the \field{requestq} virtqueue,
>      after filling all fields of the \field{struct virtio_gpio_request} buffer as
>      defined by the specific message type.
> @@ -458,7 +458,7 @@ \subsection{Device Operation: eventq}\label{sec:Device Types / GPIO Device / eve
>  
>  The \field{eventq} virtqueue is used by the driver to unmask the interrupts and
>  used by the device to notify the driver of newly sensed interrupts. In order to
> -unmask interrupt on a GPIO line, the driver queues a pair of buffers,
> +unmask interrupt on a GPIO line, the driver enqueues a pair of buffers,
>  \field{struct virtio_gpio_irq_request} (filled by driver) and \field{struct
>  virtio_gpio_irq_response} (to be filled by device later), to the \field{eventq}
>  virtqueue. A separate pair of buffers must be queued for each GPIO line, the
> diff --git a/device-types/i2c/description.tex b/device-types/i2c/description.tex
> index 5d407cb..861529a 100644
> --- a/device-types/i2c/description.tex
> +++ b/device-types/i2c/description.tex
> @@ -47,7 +47,7 @@ \subsection{Device Operation}\label{sec:Device Types / I2C Adapter Device / Devi
>  
>  \subsubsection{Device Operation: Request Queue}\label{sec:Device Types / I2C Adapter Device / Device Operation: Request Queue}
>  
> -The driver queues requests to the virtqueue, and they are used by the
> +The driver enqueues requests to the virtqueue, and they are used by the
>  device. The request is the representation of segments of an I2C
>  transaction. Each request is of the form:
>  
> diff --git a/device-types/scsi/description.tex b/device-types/scsi/description.tex
> index 904c4a7..478b558 100644
> --- a/device-types/scsi/description.tex
> +++ b/device-types/scsi/description.tex
> @@ -158,7 +158,7 @@ \subsection{Device Operation}\label{sec:Device Types / SCSI Host Device / Device
>  
>  \subsubsection{Device Operation: Request Queues}\label{sec:Device Types / SCSI Host Device / Device Operation / Device Operation: Request Queues}
>  
> -The driver queues requests to an arbitrary request queue, and
> +The driver enqueues requests to an arbitrary request queue, and
>  they are used by the device on that same queue. It is the
>  responsibility of the driver to ensure strict request ordering
>  for commands placed on different queues, because they will be
> diff --git a/device-types/vsock/description.tex b/device-types/vsock/description.tex
> index 105bb30..07909d6 100644
> --- a/device-types/vsock/description.tex
> +++ b/device-types/vsock/description.tex
> @@ -218,7 +218,7 @@ \subsubsection{Buffer Space Management}\label{sec:Device Types / Socket Device /
>  \field{buf_alloc} and \field{fwd_cnt} fields.
>  
>  \subsubsection{Receive and Transmit}\label{sec:Device Types / Socket Device / Device Operation / Receive and Transmit}
> -The driver queues outgoing packets on the tx virtqueue and incoming packet
> +The driver enqueues outgoing packets on the tx virtqueue and incoming packet
>  receive buffers on the rx virtqueue. Packets are of the following form:
>  
>  \begin{lstlisting}
> -- 
> 2.26.2


---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [virtio-dev] Re: [PATCH] device-types/multiple: replace queues with enqueues
  2023-04-11 20:03 [virtio-dev] [PATCH] device-types/multiple: replace queues with enqueues Parav Pandit
  2023-04-19  1:54 ` [virtio-dev] " Parav Pandit
  2023-04-19  7:17 ` [virtio-dev] " Michael S. Tsirkin
@ 2023-04-19 13:33 ` Cornelia Huck
  2023-04-19 13:35   ` [virtio-dev] " Parav Pandit
  2 siblings, 1 reply; 6+ messages in thread
From: Cornelia Huck @ 2023-04-19 13:33 UTC (permalink / raw)
  To: Parav Pandit, mst, virtio-dev, pasic
  Cc: virtio-comment, shahafs, Parav Pandit

On Tue, Apr 11 2023, Parav Pandit <parav@nvidia.com> wrote:

> Queue is a verb and noun both. Replacing it with enqueue avoids
> ambiguity around plural queues noun vs verb; similar to virtio fs device
> description.

Personally, I don't think this patch adds much, but I don't really mind
it, either.

>
> Suggested-by: Michael S. Tsirkin <mst@redhat.com>
> Signed-off-by: Parav Pandit <parav@nvidia.com>
> ---
>  device-types/blk/description.tex   | 2 +-
>  device-types/gpio/description.tex  | 4 ++--
>  device-types/i2c/description.tex   | 2 +-
>  device-types/scsi/description.tex  | 2 +-
>  device-types/vsock/description.tex | 2 +-
>  5 files changed, 6 insertions(+), 6 deletions(-)
>

(...)

> diff --git a/device-types/vsock/description.tex b/device-types/vsock/description.tex
> index 105bb30..07909d6 100644
> --- a/device-types/vsock/description.tex
> +++ b/device-types/vsock/description.tex
> @@ -218,7 +218,7 @@ \subsubsection{Buffer Space Management}\label{sec:Device Types / Socket Device /
>  \field{buf_alloc} and \field{fwd_cnt} fields.
>  
>  \subsubsection{Receive and Transmit}\label{sec:Device Types / Socket Device / Device Operation / Receive and Transmit}
> -The driver queues outgoing packets on the tx virtqueue and incoming packet
> +The driver enqueues outgoing packets on the tx virtqueue and incoming packet

"queues (...) on" reads natural to me, but I'd use "to" with
"enqueues"... can any native speakers comment?

>  receive buffers on the rx virtqueue. Packets are of the following form:
>  
>  \begin{lstlisting}


---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [virtio-dev] RE: [PATCH] device-types/multiple: replace queues with enqueues
  2023-04-19 13:33 ` Cornelia Huck
@ 2023-04-19 13:35   ` Parav Pandit
  2023-04-19 16:15     ` [virtio-dev] " Michael S. Tsirkin
  0 siblings, 1 reply; 6+ messages in thread
From: Parav Pandit @ 2023-04-19 13:35 UTC (permalink / raw)
  To: Cornelia Huck, mst, virtio-dev, pasic; +Cc: virtio-comment, Shahaf Shuler


> From: Cornelia Huck <cohuck@redhat.com>
> Sent: Wednesday, April 19, 2023 9:33 AM
> 
> On Tue, Apr 11 2023, Parav Pandit <parav@nvidia.com> wrote:
> 
> > Queue is a verb and noun both. Replacing it with enqueue avoids
> > ambiguity around plural queues noun vs verb; similar to virtio fs
> > device description.
> 
> Personally, I don't think this patch adds much, but I don't really mind it, either.
> 
> >
> > Suggested-by: Michael S. Tsirkin <mst@redhat.com>
> > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > ---
> >  device-types/blk/description.tex   | 2 +-
> >  device-types/gpio/description.tex  | 4 ++--
> >  device-types/i2c/description.tex   | 2 +-
> >  device-types/scsi/description.tex  | 2 +-
> > device-types/vsock/description.tex | 2 +-
> >  5 files changed, 6 insertions(+), 6 deletions(-)
> >
> 
> (...)
> 
> > diff --git a/device-types/vsock/description.tex
> > b/device-types/vsock/description.tex
> > index 105bb30..07909d6 100644
> > --- a/device-types/vsock/description.tex
> > +++ b/device-types/vsock/description.tex
> > @@ -218,7 +218,7 @@ \subsubsection{Buffer Space
> > Management}\label{sec:Device Types / Socket Device /  \field{buf_alloc} and
> \field{fwd_cnt} fields.
> >
> >  \subsubsection{Receive and Transmit}\label{sec:Device Types / Socket
> > Device / Device Operation / Receive and Transmit} -The driver queues
> > outgoing packets on the tx virtqueue and incoming packet
> > +The driver enqueues outgoing packets on the tx virtqueue and incoming
> > +packet
> 
> "queues (...) on" reads natural to me, but I'd use "to" with "enqueues"... 
Yes, I agree.
The driver enqueues outgoing packets to the tx virtqueue reads better to me.

> can any
> native speakers comment?
> 
> >  receive buffers on the rx virtqueue. Packets are of the following form:
> >
> >  \begin{lstlisting}


---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org


^ permalink raw reply	[flat|nested] 6+ messages in thread

* [virtio-dev] Re: [PATCH] device-types/multiple: replace queues with enqueues
  2023-04-19 13:35   ` [virtio-dev] " Parav Pandit
@ 2023-04-19 16:15     ` Michael S. Tsirkin
  0 siblings, 0 replies; 6+ messages in thread
From: Michael S. Tsirkin @ 2023-04-19 16:15 UTC (permalink / raw)
  To: Parav Pandit
  Cc: Cornelia Huck, virtio-dev, pasic, virtio-comment, Shahaf Shuler

On Wed, Apr 19, 2023 at 01:35:32PM +0000, Parav Pandit wrote:
> 
> > From: Cornelia Huck <cohuck@redhat.com>
> > Sent: Wednesday, April 19, 2023 9:33 AM
> > 
> > On Tue, Apr 11 2023, Parav Pandit <parav@nvidia.com> wrote:
> > 
> > > Queue is a verb and noun both. Replacing it with enqueue avoids
> > > ambiguity around plural queues noun vs verb; similar to virtio fs
> > > device description.
> > 
> > Personally, I don't think this patch adds much, but I don't really mind it, either.
> > 
> > >
> > > Suggested-by: Michael S. Tsirkin <mst@redhat.com>
> > > Signed-off-by: Parav Pandit <parav@nvidia.com>
> > > ---
> > >  device-types/blk/description.tex   | 2 +-
> > >  device-types/gpio/description.tex  | 4 ++--
> > >  device-types/i2c/description.tex   | 2 +-
> > >  device-types/scsi/description.tex  | 2 +-
> > > device-types/vsock/description.tex | 2 +-
> > >  5 files changed, 6 insertions(+), 6 deletions(-)
> > >
> > 
> > (...)
> > 
> > > diff --git a/device-types/vsock/description.tex
> > > b/device-types/vsock/description.tex
> > > index 105bb30..07909d6 100644
> > > --- a/device-types/vsock/description.tex
> > > +++ b/device-types/vsock/description.tex
> > > @@ -218,7 +218,7 @@ \subsubsection{Buffer Space
> > > Management}\label{sec:Device Types / Socket Device /  \field{buf_alloc} and
> > \field{fwd_cnt} fields.
> > >
> > >  \subsubsection{Receive and Transmit}\label{sec:Device Types / Socket
> > > Device / Device Operation / Receive and Transmit} -The driver queues
> > > outgoing packets on the tx virtqueue and incoming packet
> > > +The driver enqueues outgoing packets on the tx virtqueue and incoming
> > > +packet
> > 
> > "queues (...) on" reads natural to me, but I'd use "to" with "enqueues"... 
> Yes, I agree.
> The driver enqueues outgoing packets to the tx virtqueue reads better to me.

+1

> > can any
> > native speakers comment?
> > 
> > >  receive buffers on the rx virtqueue. Packets are of the following form:
> > >
> > >  \begin{lstlisting}


---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org


^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2023-04-19 16:15 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-04-11 20:03 [virtio-dev] [PATCH] device-types/multiple: replace queues with enqueues Parav Pandit
2023-04-19  1:54 ` [virtio-dev] " Parav Pandit
2023-04-19  7:17 ` [virtio-dev] " Michael S. Tsirkin
2023-04-19 13:33 ` Cornelia Huck
2023-04-19 13:35   ` [virtio-dev] " Parav Pandit
2023-04-19 16:15     ` [virtio-dev] " Michael S. Tsirkin

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).