Re: [PATCH v7 7/8] qmp: add QMP command x-debug-virtio-queue-element

[Jonah Palmer]

On 10/7/21 9:27 AM, Eric Blake wrote:

> On Tue, Oct 05, 2021 at 12:45:52PM -0400, Jonah Palmer wrote:
> > From: Laurent Vivier <lvivier@redhat.com>
> >
> > This new command shows the information of a VirtQueue element.
> >
> > Signed-off-by: Jonah Palmer <jonah.palmer@oracle.com>
> > ---
> > +++ b/qapi/virtio.json
> > +##
> > +# @VirtioRingAvail:
> > +#
> > +# @flags: VRingAvail flags
> > +#
> > +# @idx: VRingAvail idx
> >       
> Is it worth being consistent...
>
> > +##
> > +# @VirtioQueueElement:
> > +#
> > +# @device-name: VirtIODevice name (for reference)
> > +#
> > +# @index: index of the element in the queue
> >       
> ...and spelling things 'index' everywhere instead of sometimes
> abbreviating?
>
> But overall, it looks like you did a nice job of making the command
> machine-parseable, while still leaving the flexibility to alter it as
> needed since it is only for developers under the x-debug- namespace.
>     
I think I'll elaborate a bit more with these definitions (for all patches).
After attending the QAPI sync last Thursday, I realized developers would
like to see more thorough documentation in these files. For something like
virtio, this is probably worth expanding on.

Jonah

>