[virtio-comment] Re: [PATCH v1 00/20] Split device spec to its individual files

["Michael S. Tsirkin" <mst@redhat.com>]

On Tue, Jan 03, 2023 at 02:26:15PM +0000, Parav Pandit wrote:
> 
> > From: Michael S. Tsirkin <mst@redhat.com>
> > Sent: Tuesday, January 3, 2023 9:20 AM
> > 
> > On Tue, Jan 03, 2023 at 02:15:37PM +0000, Parav Pandit wrote:
> > >
> > > > From: Michael S. Tsirkin <mst@redhat.com>
> > > > Sent: Tuesday, January 3, 2023 5:47 AM
> > > >
> > > > 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.
> > > >
> > > >
> > > > OK it's a technicality but it's a big change so I think we should
> > > > vote on this. Still I don't feel it needs extra time for review.
> > > > Can you create a github issue and I'll kick off the voting process?
> > > >
> > > Great.
> > > I already open last week [1].
> > > [1] https://github.com/oasis-tcs/virtio-spec/issues/153
> > 
> > Sounds good. What do you think about the idea to have all files flat in the same
> > directory?
> 
> I was writing up reply to other thread at the moment.
> But lets continue here since you ask.
> I don't have a strong opinion, but I find directories neat.
> This is because we have many devices spec files, conformance files and it's expected to grow.
> I have transports directory and place code in there.
> Since latex spec doesn't have good way to include and refer sub section, we have many files.
> 19 devices * 3 spec files + 3 transports * 3 spec files.
> 
> And once spec is in its own directory, things should be self-sufficient.
> Only touch points will be in common areas which should be less frequent.
> WDYT?

Yea I know. It's just that one of the ways we publish is a directory in
a web browser and there browsing up and down is annoying.
But if you feel strongly we can make the TC decide.

-- 
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/