Discussion of the implementations of VIRTIO specification
 help / color / mirror / Atom feed
From: Cornelia Huck <cohuck@redhat.com>
To: "Michael S. Tsirkin" <mst@redhat.com>, Parav Pandit <parav@nvidia.com>
Cc: virtio-dev@lists.oasis-open.org, virtio-comment@lists.oasis-open.org
Subject: [virtio-dev] Re: [PATCH v2 00/20] Split device spec to its individual files
Date: Tue, 10 Jan 2023 12:20:31 +0100	[thread overview]
Message-ID: <87358i4ow0.fsf@redhat.com> (raw)
In-Reply-To: <20230109121857-mutt-send-email-mst@kernel.org>

On Mon, Jan 09 2023, "Michael S. Tsirkin" <mst@redhat.com> wrote:

> On Mon, Jan 09, 2023 at 06:28:29PM +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:
>> ----------
>> v1->v2:
>> - removed extra blank lines in network and block device files
>> - added missing device conformance link for rpmb, sound, i2c and
>>   gpio devices
>> 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
>> 
>> 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                               |  456 +-
>>  content.tex                                   | 4561 +----------------
>>  .../virtio-block/device-conformance.tex       |    8 +
>>  device-types/virtio-block/device.tex          | 1313 +++++
>>  .../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        | 1594 ++++++
>>  .../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(-)
>
> Does makediff still work? Documentation says latexpand does not
> support import. without latexdiff generating redlined versions would
> be very difficult.
>
>
> I am also worried about consistency since we
> already use \\input.
> If using \\input means putting everything in a single directory,
> that's a small price to pay:
>
> virtio-sound.tex + virtio-sound-conformance.tex
>
> is not fundamentally worse than device-types/virtio-sound/device.tex
> and device-types/virtio-sound/device-conformance.tex
>
> and it avoids the duplicated "device" in the name.
>
> Previously it looked like a cosmetic issue, but now it looks
> like it's important.

I agree, and we need to decide quickly what to do with the ballot. We
don't want to merge v1, but the current votes still have a majority of
'yes'. My preference would be to withdraw the ballot, which needs to be
done before 22:00 UTC today, if I'm not confused.

Parav, what do you think? If you request to withdraw the ballot, that's
easy to do; we'll just open a new one once we've agreed on a version.


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


  reply	other threads:[~2023-01-10 11:20 UTC|newest]

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

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=87358i4ow0.fsf@redhat.com \
    --to=cohuck@redhat.com \
    --cc=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