Discussion of the implementations of VIRTIO specification
 help / color / mirror / Atom feed
From: Parav Pandit <parav@nvidia.com>
To: mst@redhat.com, virtio-dev@lists.oasis-open.org, cohuck@redhat.com
Cc: virtio-comment@lists.oasis-open.org, Parav Pandit <parav@nvidia.com>
Subject: [PATCH v3 11/20] virtio-vsock: Maintain socket device spec in separate directory
Date: Wed, 11 Jan 2023 01:03:49 +0200	[thread overview]
Message-ID: <20230110230358.528098-12-parav@nvidia.com> (raw)
In-Reply-To: <20230110230358.528098-1-parav@nvidia.com>

Place device specification, its driver and device
conformance into its own directory to have self contained device
specification.

Fixes: https://github.com/oasis-tcs/virtio-spec/issues/153
Signed-off-by: Parav Pandit <parav@nvidia.com>
---
changelog:
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file
v0->v1:
- new patch
---
 conformance.tex                               | 48 +------------------
 content.tex                                   |  2 +-
 .../virtio-vsock/description.tex              |  0
 .../virtio-vsock/device-conformance.tex       |  9 ++++
 .../virtio-vsock/driver-conformance.tex       | 10 ++++
 5 files changed, 22 insertions(+), 47 deletions(-)
 rename virtio-vsock.tex => device-types/virtio-vsock/description.tex (100%)
 create mode 100644 device-types/virtio-vsock/device-conformance.tex
 create mode 100644 device-types/virtio-vsock/driver-conformance.tex

diff --git a/conformance.tex b/conformance.tex
index 662a5a1..40cbbfa 100644
--- a/conformance.tex
+++ b/conformance.tex
@@ -142,17 +142,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-scsi/driver-conformance.tex}
 \input{device-types/virtio-input/driver-conformance.tex}
 \input{device-types/virtio-crypto/driver-conformance.tex}
-
-\conformance{\subsection}{Socket Driver Conformance}\label{sec:Conformance / Driver Conformance / Socket Driver Conformance}
-
-A socket driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / Socket Device / Feature bits}
-\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Buffer Space Management}
-\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Receive and Transmit}
-\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Device Events}
-\end{itemize}
+\input{device-types/virtio-vsock/driver-conformance.tex}
 
 \conformance{\subsection}{File System Driver Conformance}\label{sec:Conformance / Driver Conformance / File System Driver Conformance}
 
@@ -328,41 +318,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/virtio-gpu/device-conformance.tex}
 \input{device-types/virtio-input/device-conformance.tex}
 \input{device-types/virtio-crypto/device-conformance.tex}
-
-\conformance{\subsection}{Crypto Device Conformance}\label{sec:Conformance / Device Conformance / Crypto Device Conformance}
-
-A Crypto device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Crypto Device / Device configuration layout}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: create session}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / Control Virtqueue / Session operation / Session operation: destroy session}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / HASH Service Operation}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / MAC Service Operation}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / Symmetric algorithms Operation}
-\item \ref{devicenormative:Device Types / Crypto Device / Device Operation / AEAD Service Operation}
-\end{itemize}
-=======
-\import{device-types/virtio-network/}{device-conformance}
-\import{device-types/virtio-block/}{device-conformance}
-\import{device-types/virtio-console/}{device-conformance}
-\import{device-types/virtio-entropy/}{device-conformance}
-\import{device-types/virtio-mem-balloon/}{device-conformance}
-\import{device-types/virtio-scsi/}{device-conformance}
-\import{device-types/virtio-gpu/}{device-conformance}
-\import{device-types/virtio-input/}{device-conformance}
-\import{device-types/virtio-crypto/}{device-conformance}
->>>>>>> a695ea2... virtio-crypto: Maintain crypto device spec in separate directory
-
-\conformance{\subsection}{Socket Device Conformance}\label{sec:Conformance / Device Conformance / Socket Device Conformance}
-
-A socket device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / Socket Device / Feature bits}
-\item \ref{devicenormative:Device Types / Socket Device / Device Operation / Buffer Space Management}
-\item \ref{devicenormative:Device Types / Socket Device / Device Operation / Receive and Transmit}
-\end{itemize}
+\input{device-types/virtio-vsock/device-conformance.tex}
 
 \conformance{\subsection}{File System Device Conformance}\label{sec:Conformance / Device Conformance / File System Device Conformance}
 
diff --git a/content.tex b/content.tex
index f7cbecb..5a4e70a 100644
--- a/content.tex
+++ b/content.tex
@@ -3012,7 +3012,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/virtio-gpu/description.tex}
 \input{device-types/virtio-input/description.tex}
 \input{device-types/virtio-crypto/description.tex}
-\input{virtio-vsock.tex}
+\input{device-types/virtio-vsock/description.tex}
 \input{virtio-fs.tex}
 \input{virtio-rpmb.tex}
 \input{virtio-iommu.tex}
diff --git a/virtio-vsock.tex b/device-types/virtio-vsock/description.tex
similarity index 100%
rename from virtio-vsock.tex
rename to device-types/virtio-vsock/description.tex
diff --git a/device-types/virtio-vsock/device-conformance.tex b/device-types/virtio-vsock/device-conformance.tex
new file mode 100644
index 0000000..93b0c4d
--- /dev/null
+++ b/device-types/virtio-vsock/device-conformance.tex
@@ -0,0 +1,9 @@
+\conformance{\subsection}{Socket Device Conformance}\label{sec:Conformance / Device Conformance / Socket Device Conformance}
+
+A socket device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / Socket Device / Feature bits}
+\item \ref{devicenormative:Device Types / Socket Device / Device Operation / Buffer Space Management}
+\item \ref{devicenormative:Device Types / Socket Device / Device Operation / Receive and Transmit}
+\end{itemize}
diff --git a/device-types/virtio-vsock/driver-conformance.tex b/device-types/virtio-vsock/driver-conformance.tex
new file mode 100644
index 0000000..988b0c3
--- /dev/null
+++ b/device-types/virtio-vsock/driver-conformance.tex
@@ -0,0 +1,10 @@
+\conformance{\subsection}{Socket Driver Conformance}\label{sec:Conformance / Driver Conformance / Socket Driver Conformance}
+
+A socket driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / Socket Device / Feature bits}
+\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Buffer Space Management}
+\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Receive and Transmit}
+\item \ref{drivernormative:Device Types / Socket Device / Device Operation / Device Events}
+\end{itemize}
-- 
2.26.2


  parent reply	other threads:[~2023-01-10 23:03 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-10 23:03 [PATCH v3 00/20] Split device spec to its individual files Parav Pandit
2023-01-10 23:03 ` [PATCH v3 01/20] virtio-network: Maintain network device spec in separate directory Parav Pandit
2023-01-10 23:03 ` [PATCH v3 02/20] virtio-network: Fix spelling errors Parav Pandit
2023-01-10 23:03 ` [PATCH v3 03/20] virtio-block: Maintain block device spec in separate directory Parav Pandit
2023-01-10 23:03 ` [PATCH v3 04/20] virtio-console: Maintain console " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 05/20] virtio-entropy: Maintain entropy " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 06/20] virtio-mem-balloon: Maintain mem balloon " Parav Pandit
2023-01-11 14:14   ` [virtio-dev] " David Hildenbrand
2023-01-11 14:55     ` Michael S. Tsirkin
2023-01-11 15:01     ` Parav Pandit
2023-01-11 15:42       ` David Hildenbrand
2023-01-11 15:56         ` [virtio-comment] " Cornelia Huck
2023-01-11 16:01           ` Parav Pandit
2023-01-11 16:22             ` Michael S. Tsirkin
2023-01-11 16:32               ` Parav Pandit
2023-01-10 23:03 ` [PATCH v3 07/20] virtio-scsi: Maintain scsi host " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 08/20] virtio-gpu: Maintain gpu " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 09/20] virtio-input: Maintain input " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 10/20] virtio-crypto: Maintain crypto " Parav Pandit
2023-01-10 23:03 ` Parav Pandit [this message]
2023-01-11 11:04   ` [virtio-comment] Re: [PATCH v3 11/20] virtio-vsock: Maintain socket " Cornelia Huck
2023-01-10 23:03 ` [PATCH v3 12/20] virtio-fs: Maintain file system " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 13/20] virtio-rpmb: Maintain rpmb " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 14/20] virtio-iommu: Maintain iommu " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 15/20] virtio-sound: Maintain sound " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 16/20] virtio-mem: Maintain memory " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 17/20] virtio-i2c: Maintain i2c " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 18/20] virtio-scmi: Maintain scmi " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 19/20] virtio-gpio: Maintain gpio " Parav Pandit
2023-01-11 10:52   ` [virtio-dev] " Cornelia Huck
2023-01-11 13:40     ` [virtio-comment] " Parav Pandit
2023-01-10 23:03 ` [PATCH v3 20/20] virtio-pmem: Maintain pmem " Parav Pandit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230110230358.528098-12-parav@nvidia.com \
    --to=parav@nvidia.com \
    --cc=cohuck@redhat.com \
    --cc=mst@redhat.com \
    --cc=virtio-comment@lists.oasis-open.org \
    --cc=virtio-dev@lists.oasis-open.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox