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, david@redhat.com,
	Parav Pandit <parav@nvidia.com>
Subject: [PATCH v4 20/20] virtio-pmem: Maintain pmem device spec in separate directory
Date: Thu, 12 Jan 2023 23:22:54 +0200	[thread overview]
Message-ID: <20230112212254.763783-21-parav@nvidia.com> (raw)
In-Reply-To: <20230112212254.763783-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:
v3->v4:
- added missing pmem entry
- rename device-types/virtio-pmem to device-types/pmem
v2->v3:
- file name changed from device.tex to description.tex
- use input instead of import to insert a file
v1->v2:
- rebased
v0->v1:
- new patch
---
 conformance.tex                               | 20 ++-----------------
 content.tex                                   |  1 +
 .../pmem/description.tex                      |  0
 device-types/pmem/device-conformance.tex      |  9 +++++++++
 device-types/pmem/driver-conformance.tex      |  7 +++++++
 5 files changed, 19 insertions(+), 18 deletions(-)
 rename virtio-pmem.tex => device-types/pmem/description.tex (100%)
 create mode 100644 device-types/pmem/device-conformance.tex
 create mode 100644 device-types/pmem/driver-conformance.tex

diff --git a/conformance.tex b/conformance.tex
index b7171a6..01ccd69 100644
--- a/conformance.tex
+++ b/conformance.tex
@@ -151,14 +151,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/i2c/driver-conformance.tex}
 \input{device-types/scmi/driver-conformance.tex}
 \input{device-types/gpio/driver-conformance.tex}
-
-\conformance{\subsection}{PMEM Driver Conformance}\label{sec:Conformance / Driver Conformance / PMEM Driver Conformance}
-
-A PMEM driver MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{drivernormative:Device Types / PMEM Device / Device Initialization}
-\end{itemize}
+\input{device-types/pmem/driver-conformance.tex}
 
 \conformance{\section}{Device Conformance}\label{sec:Conformance / Device Conformance}
 
@@ -244,16 +237,7 @@ \section{Conformance Targets}\label{sec:Conformance / Conformance Targets}
 \input{device-types/i2c/device-conformance.tex}
 \input{device-types/scmi/device-conformance.tex}
 \input{device-types/gpio/device-conformance.tex}
-
-\conformance{\subsection}{PMEM Device Conformance}\label{sec:Conformance / Device Conformance / PMEM Device Conformance}
-
-A PMEM device MUST conform to the following normative statements:
-
-\begin{itemize}
-\item \ref{devicenormative:Device Types / PMEM Device / Device Initialization}
-\item \ref{devicenormative:Device Types / PMEM Device / Device Operation / Virtqueue flush}
-\item \ref{devicenormative:Device Types / PMEM Device / Device Operation / Virtqueue return}
-\end{itemize}
+\input{device-types/pmem/device-conformance.tex}
 
 \conformance{\section}{Legacy Interface: Transitional Device and Transitional Driver Conformance}\label{sec:Conformance / Legacy Interface: Transitional Device and Transitional Driver Conformance}
 A conformant implementation MUST be either transitional or
diff --git a/content.tex b/content.tex
index 5a77eb7..0118b8a 100644
--- a/content.tex
+++ b/content.tex
@@ -3021,6 +3021,7 @@ \chapter{Device Types}\label{sec:Device Types}
 \input{device-types/i2c/description.tex}
 \input{device-types/scmi/description.tex}
 \input{device-types/gpio/description.tex}
+\input{device-types/pmem/description.tex}
 
 \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits}
 
diff --git a/virtio-pmem.tex b/device-types/pmem/description.tex
similarity index 100%
rename from virtio-pmem.tex
rename to device-types/pmem/description.tex
diff --git a/device-types/pmem/device-conformance.tex b/device-types/pmem/device-conformance.tex
new file mode 100644
index 0000000..e06862c
--- /dev/null
+++ b/device-types/pmem/device-conformance.tex
@@ -0,0 +1,9 @@
+\conformance{\subsection}{PMEM Device Conformance}\label{sec:Conformance / Device Conformance / PMEM Device Conformance}
+
+A PMEM device MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{devicenormative:Device Types / PMEM Device / Device Initialization}
+\item \ref{devicenormative:Device Types / PMEM Device / Device Operation / Virtqueue flush}
+\item \ref{devicenormative:Device Types / PMEM Device / Device Operation / Virtqueue return}
+\end{itemize}
diff --git a/device-types/pmem/driver-conformance.tex b/device-types/pmem/driver-conformance.tex
new file mode 100644
index 0000000..620804c
--- /dev/null
+++ b/device-types/pmem/driver-conformance.tex
@@ -0,0 +1,7 @@
+\conformance{\subsection}{PMEM Driver Conformance}\label{sec:Conformance / Driver Conformance / PMEM Driver Conformance}
+
+A PMEM driver MUST conform to the following normative statements:
+
+\begin{itemize}
+\item \ref{drivernormative:Device Types / PMEM Device / Device Initialization}
+\end{itemize}
-- 
2.26.2


  parent reply	other threads:[~2023-01-12 21:22 UTC|newest]

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

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=20230112212254.763783-21-parav@nvidia.com \
    --to=parav@nvidia.com \
    --cc=cohuck@redhat.com \
    --cc=david@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