Re: [Qemu-devel] [PATCH] qapi: convert add_client

[Luiz Capitulino]

On Tue, 18 Sep 2012 13:13:16 -0600
Eric Blake <address@hidden> wrote:

> On 09/18/2012 01:06 PM, Luiz Capitulino wrote:
> > Also fixes a few issues while there:
> > 
> >  1. The fd returned by monitor_get_fd() leaks in most error conditions
> >  2. monitor_get_fd() return value is not checked. Best case we get
> >     an error that is not correctly reported, worse case one of the
> >     functions using the fd (with value of -1) will explode
> >  3. A few error conditions aren't reported
> > 
> > Signed-off-by: Luiz Capitulino <address@hidden>
> > ---
> >  monitor.c        | 39 ---------------------------------------
> >  qapi-schema.json | 23 +++++++++++++++++++++++
> >  qmp-commands.hx  |  5 +----
> >  qmp.c            | 44 ++++++++++++++++++++++++++++++++++++++++++++
> >  4 files changed, 68 insertions(+), 43 deletions(-)
> > 
> 
> >  { 'command': 'screendump', 'data': {'filename': 'str'} }
> > +
> > +##
> > +# @add_client
> 
> Are these supposed to be sorted in any particular order?

Honestly, this is something I've paid very little attention to. But it's
a good idea to keep the list sorted yes (although I'd like ErroClass to
be the first item).

> 
> > +#
> > +# Allow client connections for VNC, Spice and socket based
> > +# character devices to be passed in to QEMU via SCM_RIGHTS.
> > +#
> > +# @protocol: protocol name. Valid names are "vnc", "spice" or the
> > +#            name of a character device (eg. from -chardev id=XXXX)
> > +#
> > +# @fdname: file descriptor name passed via SCM_RIGHTS
> 
> Misleading; isn't this really:
> 
> file descriptor name previously passed via 'getfd' command
> 
> since it is only 'getfd' that uses SCM_RIGHTS?

You're right, of course. Stupid mistake from my part :)

> > +#
> > +# skipauth: #optional whether to skip authentication
> > +#
> > +# tls: #optional whether to perform TLS
> 
> Missing leading @ on two lines.

Will fix.

> > +#
> > +# Returns: nothing on success.
> > +#
> > +# Since: 0.14.0
> 
> If this were a new command for 1.3, I'd say to name it 'add-client'; but
> since QMP has already been exposing it and you are now just documenting
> it, you can't change the name.

Yes, we just have to live with that for all old commands.