Re: [Qemu-devel] [PATCH 2/4] virtio-serial: Add description fields for qdev properties

[Amit Shah]

On (Tue) Sep 28 2010 [15:48:26], Markus Armbruster wrote:
> > diff --git a/hw/virtio-serial.h b/hw/virtio-serial.h
> > index ff08c40..187d5e4 100644
> > --- a/hw/virtio-serial.h
> > +++ b/hw/virtio-serial.h
> > @@ -57,6 +57,19 @@ struct virtio_console_control {
> >  
> >  /* == In-qemu interface == */
> >  
> > +#define PROP_VIRTSERIAL_IS_CONSOLE_DESC                                 \
> > +    "An hvc console will be spawned in the guest if this is set."
> > +
> > +#define PROP_VIRTSERIAL_NR_DESC                                         \
> > +    "The 'number' for the port for predictable port numbers. Use this to " 
> > \
> > +    "spawn ports if you plan to migrate the guest."
> > +
> > +#define PROP_VIRTSERIAL_CHR_DESC                \
> > +    "The chardev to associate this port with."
> > +
> > +#define PROP_VIRTSERIAL_NAME_DESC                \
> > +    "Name for the port that's exposed to the guest for port discovery."
> > +
> >  typedef struct VirtIOSerial VirtIOSerial;
> >  typedef struct VirtIOSerialBus VirtIOSerialBus;
> >  typedef struct VirtIOSerialPort VirtIOSerialPort;
> 
> Do you expect these macros to be used elsewhere?  If not, I'd rather
> have them right next to their use, so that they do double-duty
> documenting source code.

Yes, other users of virtio-serial, like spice, clipboard sharing apps,
etc.

                Amit