From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from [140.186.70.92] (port=44036 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1PpNUD-0005eB-J7 for qemu-devel@nongnu.org; Tue, 15 Feb 2011 11:10:46 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1PpNUC-0008Te-6y for qemu-devel@nongnu.org; Tue, 15 Feb 2011 11:10:45 -0500 Received: from mail-qy0-f173.google.com ([209.85.216.173]:55731) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1PpNUB-0008TT-P0 for qemu-devel@nongnu.org; Tue, 15 Feb 2011 11:10:43 -0500 Received: by qyl38 with SMTP id 38so2610748qyl.4 for ; Tue, 15 Feb 2011 08:10:42 -0800 (PST) Message-ID: <4D5AA56F.9040901@codemonkey.ws> Date: Tue, 15 Feb 2011 10:10:23 -0600 From: Anthony Liguori MIME-Version: 1.0 Subject: Re: [Qemu-devel] [PATCH REBASE/RESEND 2/4] virtio-serial: Add description fields for qdev properties References: <2b49a1453925f808405eb380cab2f45f10fb6a5f.1296800130.git.amit.shah@redhat.com> In-Reply-To: <2b49a1453925f808405eb380cab2f45f10fb6a5f.1296800130.git.amit.shah@redhat.com> Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Amit Shah Cc: qemu list , Markus Armbruster On 02/04/2011 12:18 AM, Amit Shah wrote: > Document the parameters for the virtserialport and virtioconsole > devices. > > Example: > > $ ./x86_64-softmmu/qemu-system-x86_64 -device virtserialport,? > virtserialport.nr=uint32, The 'number' for the port for \ > predictable port numbers. Use this to spawn ports if you \ > plan to migrate the guest. > > virtserialport.chardev=chr, The chardev to associate this port with. > > virtserialport.name=string, Name for the port that's exposed to \ > the guest for port discovery. > > Signed-off-by: Amit Shah > Acked-by: Markus Armbruster > --- > hw/virtio-console.c | 17 ++++++++++------- > hw/virtio-serial.h | 13 +++++++++++++ > 2 files changed, 23 insertions(+), 7 deletions(-) > > diff --git a/hw/virtio-console.c b/hw/virtio-console.c > index a32e628..29e5600 100644 > --- a/hw/virtio-console.c > +++ b/hw/virtio-console.c > @@ -98,11 +98,13 @@ static VirtIOSerialPortInfo virtconsole_info = { > .init = virtconsole_initfn, > .exit = virtconsole_exitfn, > .qdev.props = (Property[]) { > - DEFINE_PROP_UINT8("is_console", VirtConsole, port.is_console, 1, ""), > + DEFINE_PROP_UINT8("is_console", VirtConsole, port.is_console, 1, > + PROP_VIRTSERIAL_IS_CONSOLE_DESC), > DEFINE_PROP_UINT32("nr", VirtConsole, port.id, VIRTIO_CONSOLE_BAD_ID, > - ""), > - DEFINE_PROP_CHR("chardev", VirtConsole, chr, ""), > - DEFINE_PROP_STRING("name", VirtConsole, port.name, ""), > + PROP_VIRTSERIAL_NR_DESC), > + DEFINE_PROP_CHR("chardev", VirtConsole, chr, PROP_VIRTSERIAL_CHR_DESC), > + DEFINE_PROP_STRING("name", VirtConsole, port.name, > + PROP_VIRTSERIAL_NAME_DESC), > DEFINE_PROP_END_OF_LIST(), > }, > }; > @@ -129,9 +131,10 @@ static VirtIOSerialPortInfo virtserialport_info = { > .exit = virtconsole_exitfn, > .qdev.props = (Property[]) { > DEFINE_PROP_UINT32("nr", VirtConsole, port.id, VIRTIO_CONSOLE_BAD_ID, > - ""), > - DEFINE_PROP_CHR("chardev", VirtConsole, chr, ""), > - DEFINE_PROP_STRING("name", VirtConsole, port.name, ""), > + PROP_VIRTSERIAL_NR_DESC), > + DEFINE_PROP_CHR("chardev", VirtConsole, chr, PROP_VIRTSERIAL_CHR_DESC), > + DEFINE_PROP_STRING("name", VirtConsole, port.name, > + PROP_VIRTSERIAL_NAME_DESC), > DEFINE_PROP_END_OF_LIST(), > }, > }; > diff --git a/hw/virtio-serial.h b/hw/virtio-serial.h > index a308196..2c5e336 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." > + > Why are you using a #define instead of inlining the docs? Regards, Anthony Liguori > typedef struct VirtIOSerial VirtIOSerial; > typedef struct VirtIOSerialBus VirtIOSerialBus; > typedef struct VirtIOSerialPort VirtIOSerialPort; >