[virtio-comment] [PATCH] packed-ring.tex: link conformance statements

[virtio-comment] [PATCH] packed-ring.tex: link conformance statements

[Michael S. Tsirkin]

Link conformance statements into conformance chapter.

Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
---
 conformance.tex |  9 +++++++++
 packed-ring.tex | 16 +++++-----------
 2 files changed, 14 insertions(+), 11 deletions(-)

diff --git a/conformance.tex b/conformance.tex
index 9807c30..663e7c3 100644
--- a/conformance.tex
+++ b/conformance.tex
@@ -85,6 +85,12 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Updating idx}
 \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Notifying The Device}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / PAcked Virtqueues / The Virtqueue Descriptor Table}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table / Indirect Descriptors}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
+\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Sending Available Buffer Notifications}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Initialization}
 \item \ref{drivernormative:General Initialization And Device Operation / Device Cleanup}
 \item \ref{drivernormative:Reserved Feature Bits}
@@ -340,6 +346,9 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table}
+\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
 \item \ref{devicenormative:Basic Facilities of a Virtio Device / Shared Memory Regions}
 \item \ref{devicenormative:Reserved Feature Bits}
 \end{itemize}
diff --git a/packed-ring.tex b/packed-ring.tex
index 2accc23..47f58a8 100644
--- a/packed-ring.tex
+++ b/packed-ring.tex
@@ -407,14 +407,12 @@ \subsubsection{Structure Size and Alignment}
 can be queued at any given time.}.  The Queue Size value does not
 have to be a power of 2.
 
-\drivernormative{\subsection}{Virtqueues}{Basic Facilities of a
-Virtio Device / Packed Virtqueues}
+\drivernormative{\subsection}{Virtqueues}{Basic Facilities of a Virtio Device / Packed Virtqueues}
 The driver MUST ensure that the physical address of the first byte
 of each virtqueue part is a multiple of the specified alignment value
 in the above table.
 
-\devicenormative{\subsection}{Virtqueues}{Basic Facilities of a
-Virtio Device / Packed Virtqueues}
+\devicenormative{\subsection}{Virtqueues}{Basic Facilities of a Virtio Device / Packed Virtqueues}
 The device MUST start processing driver descriptors in the order
 in which they appear in the ring.
 The device MUST start writing device descriptors into the ring in
@@ -485,8 +483,7 @@ \subsection{Event Suppression Structure Format}\label{sec:Basic
 A driver MAY send multiple available buffer notifications without making
 any new descriptors available to the device.
 
-\drivernormative{\subsection}{Scatter-Gather Support}{Basic Facilities of a
-Virtio Device / Packed Virtqueues / Scatter-Gather Support}
+\drivernormative{\subsection}{Scatter-Gather Support}{Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
 A driver MUST NOT create a descriptor list longer than allowed
 by the device.
 
@@ -508,8 +505,7 @@ \subsection{Event Suppression Structure Format}\label{sec:Basic
 before all subsequent descriptors comprising the list are made
 available.
 
-\devicenormative{\subsection}{Scatter-Gather Support}{Basic Facilities of a
-Virtio Device / Packed Virtqueues / Scatter-Gather Support}
+\devicenormative{\subsection}{Scatter-Gather Support}{Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
 The device MUST use descriptors in a list chained by the
 VIRTQ_DESC_F_NEXT flag in the same order that they
 were made available by the driver.
@@ -591,9 +587,7 @@ \subsubsection{Placing Available Buffers Into The Descriptor Ring}\label{sec:Bas
 access the descriptor and any following descriptors the driver created and the
 memory they refer to immediately.
 
-\drivernormative{\paragraph}{Updating flags}{Basic Facilities of
-a Virtio Device / Packed Virtqueues / Supplying Buffers to The
-Device / Updating flags}
+\drivernormative{\paragraph}{Updating flags}{Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
 The driver MUST perform a suitable memory barrier before the
 \field{flags} update, to ensure the
 device sees the most up-to-date copy.
-- 
MST


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/

[virtio] Re: [virtio-comment] [PATCH] packed-ring.tex: link conformance statements

[Cornelia Huck]

On Tue, Apr 19 2022, "Michael S. Tsirkin" <mst@redhat.com> wrote:

> Link conformance statements into conformance chapter.
>
> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
> ---
>  conformance.tex |  9 +++++++++
>  packed-ring.tex | 16 +++++-----------
>  2 files changed, 14 insertions(+), 11 deletions(-)
>
> diff --git a/conformance.tex b/conformance.tex
> index 9807c30..663e7c3 100644
> --- a/conformance.tex
> +++ b/conformance.tex
> @@ -85,6 +85,12 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
>  \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
>  \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Updating idx}
>  \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Notifying The Device}
> +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
> +\item \ref{drivernormative:Basic Facilities of a Virtio Device / PAcked Virtqueues / The Virtqueue Descriptor Table}

I wonder whether we could use the opportunity to fix that "PAcked" typo
here as well.

> +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
> +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table / Indirect Descriptors}
> +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
> +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Sending Available Buffer Notifications}
>  \item \ref{drivernormative:General Initialization And Device Operation / Device Initialization}
>  \item \ref{drivernormative:General Initialization And Device Operation / Device Cleanup}
>  \item \ref{drivernormative:Reserved Feature Bits}
> @@ -340,6 +346,9 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
>  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}
>  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}
>  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
> +\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
> +\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table}
> +\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
>  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Shared Memory Regions}
>  \item \ref{devicenormative:Reserved Feature Bits}
>  \end{itemize}

I guess it is ok to link this up as an editorial update; the statements
are pre-existing, and an implementation that does not know the feature
bit remains compliant.


---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that 
generates this mail.  Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php 

Re: [virtio-comment] [PATCH] packed-ring.tex: link conformance statements

[Michael S. Tsirkin]

On Tue, Apr 19, 2022 at 05:11:47PM +0200, Cornelia Huck wrote:
> On Tue, Apr 19 2022, "Michael S. Tsirkin" <mst@redhat.com> wrote:
> 
> > Link conformance statements into conformance chapter.
> >
> > Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
> > ---
> >  conformance.tex |  9 +++++++++
> >  packed-ring.tex | 16 +++++-----------
> >  2 files changed, 14 insertions(+), 11 deletions(-)
> >
> > diff --git a/conformance.tex b/conformance.tex
> > index 9807c30..663e7c3 100644
> > --- a/conformance.tex
> > +++ b/conformance.tex
> > @@ -85,6 +85,12 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
> >  \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
> >  \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Updating idx}
> >  \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Notifying The Device}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / PAcked Virtqueues / The Virtqueue Descriptor Table}
> 
> I wonder whether we could use the opportunity to fix that "PAcked" typo
> here as well.

It's just a ref but if you like it, sure, make it a patch on top.

> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table / Indirect Descriptors}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Sending Available Buffer Notifications}
> >  \item \ref{drivernormative:General Initialization And Device Operation / Device Initialization}
> >  \item \ref{drivernormative:General Initialization And Device Operation / Device Cleanup}
> >  \item \ref{drivernormative:Reserved Feature Bits}
> > @@ -340,6 +346,9 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
> >  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}
> >  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}
> >  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
> > +\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
> > +\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table}
> > +\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
> >  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Shared Memory Regions}
> >  \item \ref{devicenormative:Reserved Feature Bits}
> >  \end{itemize}
> 
> I guess it is ok to link this up as an editorial update; the statements
> are pre-existing, and an implementation that does not know the feature
> bit remains compliant.

I agree.

-- 
MST

[virtio] Re: [virtio-comment] [PATCH] packed-ring.tex: link conformance statements

[Cornelia Huck]

On Tue, Apr 19 2022, "Michael S. Tsirkin" <mst@redhat.com> wrote:

> Link conformance statements into conformance chapter.
>
> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
> ---
>  conformance.tex |  9 +++++++++
>  packed-ring.tex | 16 +++++-----------
>  2 files changed, 14 insertions(+), 11 deletions(-)

Thanks, pushed as an editorial update.


---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that 
generates this mail.  Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php 

Re: [virtio-dev] Re: [virtio-comment] [PATCH] packed-ring.tex: link conformance statements

[Halil Pasic]

On Tue, 19 Apr 2022 17:11:47 +0200
Cornelia Huck <cohuck@redhat.com> wrote:

> On Tue, Apr 19 2022, "Michael S. Tsirkin" <mst@redhat.com> wrote:
> 
> > Link conformance statements into conformance chapter.
> >
> > Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
> > ---
> >  conformance.tex |  9 +++++++++
> >  packed-ring.tex | 16 +++++-----------
> >  2 files changed, 14 insertions(+), 11 deletions(-)
> >
> > diff --git a/conformance.tex b/conformance.tex
> > index 9807c30..663e7c3 100644
> > --- a/conformance.tex
> > +++ b/conformance.tex
> > @@ -85,6 +85,12 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
> >  \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
> >  \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Updating idx}
> >  \item \ref{drivernormative:Basic Facilities of a Virtio Device / Virtqueues / Supplying Buffers to The Device / Notifying The Device}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / PAcked Virtqueues / The Virtqueue Descriptor Table}  
> 
> I wonder whether we could use the opportunity to fix that "PAcked" typo
> here as well.
> 
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table / Indirect Descriptors}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Updating flags}
> > +\item \ref{drivernormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Supplying Buffers to The Device / Sending Available Buffer Notifications}
> >  \item \ref{drivernormative:General Initialization And Device Operation / Device Initialization}
> >  \item \ref{drivernormative:General Initialization And Device Operation / Device Cleanup}
> >  \item \ref{drivernormative:Reserved Feature Bits}
> > @@ -340,6 +346,9 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
> >  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Used Buffer Notification Suppression}
> >  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Used Ring}
> >  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Virtqueues / Available Buffer Notification Suppression}
> > +\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues}
> > +\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / The Virtqueue Descriptor Table}
> > +\item \ref{devicenormative:Basic Facilities of a Virtio Device / Packed Virtqueues / Scatter-Gather Support}
> >  \item \ref{devicenormative:Basic Facilities of a Virtio Device / Shared Memory Regions}
> >  \item \ref{devicenormative:Reserved Feature Bits}
> >  \end{itemize}  
> 
> I guess it is ok to link this up as an editorial update; the statements
> are pre-existing, and an implementation that does not know the feature
> bit remains compliant.
> 

I tend to agree
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: virtio-dev-unsubscribe@lists.oasis-open.org
> For additional commands, e-mail: virtio-dev-help@lists.oasis-open.org
> 

Re: [virtio-comment] [PATCH] packed-ring.tex: link conformance statements

[Michael S. Tsirkin]

On Wed, Apr 20, 2022 at 12:02:03PM +0200, Cornelia Huck wrote:
> On Tue, Apr 19 2022, "Michael S. Tsirkin" <mst@redhat.com> wrote:
> 
> > Link conformance statements into conformance chapter.
> >
> > Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
> > ---
> >  conformance.tex |  9 +++++++++
> >  packed-ring.tex | 16 +++++-----------
> >  2 files changed, 14 insertions(+), 11 deletions(-)
> 
> Thanks, pushed as an editorial update.

I guess we need to now update cl-os.tex with these editorial changes, right?

-- 
MST

Re: [virtio-comment] [PATCH] packed-ring.tex: link conformance statements

[Cornelia Huck]

On Wed, Apr 20 2022, "Michael S. Tsirkin" <mst@redhat.com> wrote:

> On Wed, Apr 20, 2022 at 12:02:03PM +0200, Cornelia Huck wrote:
>> On Tue, Apr 19 2022, "Michael S. Tsirkin" <mst@redhat.com> wrote:
>> 
>> > Link conformance statements into conformance chapter.
>> >
>> > Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
>> > ---
>> >  conformance.tex |  9 +++++++++
>> >  packed-ring.tex | 16 +++++-----------
>> >  2 files changed, 14 insertions(+), 11 deletions(-)
>> 
>> Thanks, pushed as an editorial update.
>
> I guess we need to now update cl-os.tex with these editorial changes, right?

I already did (well, I hope I didn't miss any.)


This publicly archived list offers a means to provide input to the
OASIS Virtual I/O Device (VIRTIO) TC.

In order to verify user consent to the Feedback License terms and
to minimize spam in the list archive, subscription is required
before posting.

Subscribe: virtio-comment-subscribe@lists.oasis-open.org
Unsubscribe: virtio-comment-unsubscribe@lists.oasis-open.org
List help: virtio-comment-help@lists.oasis-open.org
List archive: https://lists.oasis-open.org/archives/virtio-comment/
Feedback License: https://www.oasis-open.org/who/ipr/feedback_license.pdf
List Guidelines: https://www.oasis-open.org/policies-guidelines/mailing-lists
Committee: https://www.oasis-open.org/committees/virtio/
Join OASIS: https://www.oasis-open.org/join/