Discussion of the implementations of VIRTIO specification
 help / color / mirror / Atom feed
From: "Michael S. Tsirkin" <mst@redhat.com>
To: Parav Pandit <parav@nvidia.com>
Cc: virtio-dev@lists.oasis-open.org, virtio-comment@lists.oasis-open.org
Subject: [virtio-comment] Re: [PATCH v1 00/20] Split device spec to its individual files
Date: Tue, 3 Jan 2023 06:01:08 -0500	[thread overview]
Message-ID: <20230103055831-mutt-send-email-mst@kernel.org> (raw)
In-Reply-To: <20230101180824.325172-1-parav@nvidia.com>

On Sun, Jan 01, 2023 at 08:08:04PM +0200, Parav Pandit wrote:
> Relatively several of the recent device specifications are maintained
> in their own specification file. Such separate files enables better
> maintenance of the specification overall.
> However, several of the initial virtio device specifications
> are located in single file.
> 
> Hence, split them into their individual files.
> 
> Additionally, each device's driver and device conformance is
> present in one giant conformance file all together.
> 
> As Michael suggest's move this device and driver conformance
> section adjacent to device specification in each device specific
> directory. This further makes device specification self-contained.
> 
> Added patch to fix spelling errors in network device
> specification which was inherited from its previous file
> location.
> 
> Patches do not change any part of the specification outcome
> except fixing the spelling errors.
> It only changes how the specification is maintained.
> 
> patch summary:
> -------------
> patch 1 to 7 creates new files for moving devices spec out of
> content and conformance files.
> patch 8 to 20 move existing dedicated file spec to new directory
> and creates per device,driver conformance file for each device.
> 
> changelog:
> ----------
> v0->v1:
> - move device spec to their own directory
> - added split files for conformance and placed them adjacent to
>   device spec
> - added patch to fix spelling errors in network device
> 

I personally slightly prefer a flat hierarchy.  So e.g.
virtio-network.tex and virtio-network-conformance.tex
matters when navigating in the web browser where going
up and down a folder is infuriatingly slow.

> Parav Pandit (20):
>   virtio-network: Maintain network device spec in separate directory
>   virtio-network: Fix spelling errors
>   virtio-block: Maintain block device spec in separate directory
>   virtio-console: Maintain console device spec in separate directory
>   virtio-entropy: Maintain entropy device spec in separate directory
>   virtio-mem-balloon: Maintain mem balloon device spec in separate
>     directory
>   virtio-scsi: Maintain scsi host device spec in separate directory
>   virtio-gpu: Maintain gpu device spec in separate directory
>   virtio-input: Maintain input device spec in separate directory
>   virtio-crypto: Maintain crypto device spec in separate directory
>   virtio-vsock: Maintain socket device spec in separate directory
>   virtio-fs: Maintain file system device spec in separate directory
>   virtio-rpmb: Maintain rpmb device spec in separate directory
>   virtio-iommu: Maintain iommu device spec in separate directory
>   virtio-sound: Maintain sound device spec in separate directory
>   virtio-mem: Maintain memory device spec in separate directory
>   virtio-i2c: Maintain i2c device spec in separate directory
>   virtio-scmi: Maintain scmi device spec in separate directory
>   virtio-gpio: Maintain gpio device spec in separate directory
>   virtio-pmem: Maintain pmem device spec in separate directory
> 
>  conformance.tex                               |  453 +-
>  content.tex                                   | 4560 +----------------
>  .../virtio-block/device-conformance.tex       |    8 +
>  device-types/virtio-block/device.tex          | 1315 +++++
>  .../virtio-block/driver-conformance.tex       |    8 +
>  .../virtio-console/device-conformance.tex     |    8 +
>  device-types/virtio-console/device.tex        |  231 +
>  .../virtio-console/driver-conformance.tex     |    8 +
>  .../virtio-crypto/device-conformance.tex      |   13 +
>  .../virtio-crypto/device.tex                  |    0
>  .../virtio-crypto/driver-conformance.tex      |   14 +
>  .../virtio-entropy/device-conformance.tex     |    7 +
>  device-types/virtio-entropy/device.tex        |   42 +
>  .../virtio-entropy/driver-conformance.tex     |    7 +
>  device-types/virtio-fs/device-conformance.tex |    9 +
>  .../virtio-fs/device.tex                      |    0
>  device-types/virtio-fs/driver-conformance.tex |   10 +
>  .../virtio-gpio/device-conformance.tex        |    9 +
>  .../virtio-gpio/device.tex                    |    0
>  .../virtio-gpio/driver-conformance.tex        |    9 +
>  .../virtio-gpu/device-conformance.tex         |    8 +
>  .../virtio-gpu/device.tex                     |    0
>  .../virtio-i2c/device-conformance.tex         |    7 +
>  .../virtio-i2c/device.tex                     |    0
>  .../virtio-i2c/driver-conformance.tex         |    7 +
>  .../virtio-input/device-conformance.tex       |    8 +
>  .../virtio-input/device.tex                   |    0
>  .../virtio-input/driver-conformance.tex       |    8 +
>  .../virtio-iommu/device-conformance.tex       |   16 +
>  .../virtio-iommu/device.tex                   |    0
>  .../virtio-iommu/driver-conformance.tex       |   17 +
>  .../virtio-mem-balloon/device-conformance.tex |   12 +
>  device-types/virtio-mem-balloon/device.tex    |  634 +++
>  .../virtio-mem-balloon/driver-conformance.tex |   12 +
>  .../virtio-mem/device-conformance.tex         |   13 +
>  .../virtio-mem/device.tex                     |    0
>  .../virtio-mem/driver-conformance.tex         |   13 +
>  .../virtio-network/device-conformance.tex     |   16 +
>  device-types/virtio-network/device.tex        | 1596 ++++++
>  .../virtio-network/driver-conformance.tex     |   17 +
>  .../virtio-pmem/device-conformance.tex        |    9 +
>  .../virtio-pmem/device.tex                    |    0
>  .../virtio-pmem/driver-conformance.tex        |    7 +
>  .../virtio-rpmb/device-conformance.tex        |   13 +
>  .../virtio-rpmb/device.tex                    |    0
>  .../virtio-rpmb/driver-conformance.tex        |    7 +
>  .../virtio-scmi/device-conformance.tex        |   10 +
>  .../virtio-scmi/device.tex                    |    0
>  .../virtio-scmi/driver-conformance.tex        |    8 +
>  .../virtio-scsi/device-conformance.tex        |   10 +
>  device-types/virtio-scsi/device.tex           |  709 +++
>  .../virtio-scsi/driver-conformance.tex        |    9 +
>  .../virtio-sound/device-conformance.tex       |   16 +
>  .../virtio-sound/device.tex                   |    0
>  .../virtio-sound/driver-conformance.tex       |   13 +
>  .../virtio-vsock/device-conformance.tex       |    9 +
>  .../virtio-vsock/device.tex                   |    0
>  .../virtio-vsock/driver-conformance.tex       |   10 +
>  virtio.tex                                    |    1 +
>  59 files changed, 4965 insertions(+), 4961 deletions(-)
>  create mode 100644 device-types/virtio-block/device-conformance.tex
>  create mode 100644 device-types/virtio-block/device.tex
>  create mode 100644 device-types/virtio-block/driver-conformance.tex
>  create mode 100644 device-types/virtio-console/device-conformance.tex
>  create mode 100644 device-types/virtio-console/device.tex
>  create mode 100644 device-types/virtio-console/driver-conformance.tex
>  create mode 100644 device-types/virtio-crypto/device-conformance.tex
>  rename virtio-crypto.tex => device-types/virtio-crypto/device.tex (100%)
>  create mode 100644 device-types/virtio-crypto/driver-conformance.tex
>  create mode 100644 device-types/virtio-entropy/device-conformance.tex
>  create mode 100644 device-types/virtio-entropy/device.tex
>  create mode 100644 device-types/virtio-entropy/driver-conformance.tex
>  create mode 100644 device-types/virtio-fs/device-conformance.tex
>  rename virtio-fs.tex => device-types/virtio-fs/device.tex (100%)
>  create mode 100644 device-types/virtio-fs/driver-conformance.tex
>  create mode 100644 device-types/virtio-gpio/device-conformance.tex
>  rename virtio-gpio.tex => device-types/virtio-gpio/device.tex (100%)
>  create mode 100644 device-types/virtio-gpio/driver-conformance.tex
>  create mode 100644 device-types/virtio-gpu/device-conformance.tex
>  rename virtio-gpu.tex => device-types/virtio-gpu/device.tex (100%)
>  create mode 100644 device-types/virtio-i2c/device-conformance.tex
>  rename virtio-i2c.tex => device-types/virtio-i2c/device.tex (100%)
>  create mode 100644 device-types/virtio-i2c/driver-conformance.tex
>  create mode 100644 device-types/virtio-input/device-conformance.tex
>  rename virtio-input.tex => device-types/virtio-input/device.tex (100%)
>  create mode 100644 device-types/virtio-input/driver-conformance.tex
>  create mode 100644 device-types/virtio-iommu/device-conformance.tex
>  rename virtio-iommu.tex => device-types/virtio-iommu/device.tex (100%)
>  create mode 100644 device-types/virtio-iommu/driver-conformance.tex
>  create mode 100644 device-types/virtio-mem-balloon/device-conformance.tex
>  create mode 100644 device-types/virtio-mem-balloon/device.tex
>  create mode 100644 device-types/virtio-mem-balloon/driver-conformance.tex
>  create mode 100644 device-types/virtio-mem/device-conformance.tex
>  rename virtio-mem.tex => device-types/virtio-mem/device.tex (100%)
>  create mode 100644 device-types/virtio-mem/driver-conformance.tex
>  create mode 100644 device-types/virtio-network/device-conformance.tex
>  create mode 100644 device-types/virtio-network/device.tex
>  create mode 100644 device-types/virtio-network/driver-conformance.tex
>  create mode 100644 device-types/virtio-pmem/device-conformance.tex
>  rename virtio-pmem.tex => device-types/virtio-pmem/device.tex (100%)
>  create mode 100644 device-types/virtio-pmem/driver-conformance.tex
>  create mode 100644 device-types/virtio-rpmb/device-conformance.tex
>  rename virtio-rpmb.tex => device-types/virtio-rpmb/device.tex (100%)
>  create mode 100644 device-types/virtio-rpmb/driver-conformance.tex
>  create mode 100644 device-types/virtio-scmi/device-conformance.tex
>  rename virtio-scmi.tex => device-types/virtio-scmi/device.tex (100%)
>  create mode 100644 device-types/virtio-scmi/driver-conformance.tex
>  create mode 100644 device-types/virtio-scsi/device-conformance.tex
>  create mode 100644 device-types/virtio-scsi/device.tex
>  create mode 100644 device-types/virtio-scsi/driver-conformance.tex
>  create mode 100644 device-types/virtio-sound/device-conformance.tex
>  rename virtio-sound.tex => device-types/virtio-sound/device.tex (100%)
>  create mode 100644 device-types/virtio-sound/driver-conformance.tex
>  create mode 100644 device-types/virtio-vsock/device-conformance.tex
>  rename virtio-vsock.tex => device-types/virtio-vsock/device.tex (100%)
>  create mode 100644 device-types/virtio-vsock/driver-conformance.tex
> 
> -- 
> 2.26.2


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/


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

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

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=20230103055831-mutt-send-email-mst@kernel.org \
    --to=mst@redhat.com \
    --cc=parav@nvidia.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