qemu-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-devel] Re: [PATCH] Documentation: Add documentation for -chardev


From: Gerd Hoffmann
Subject: [Qemu-devel] Re: [PATCH] Documentation: Add documentation for -chardev
Date: Fri, 30 Oct 2009 10:17:41 +0100
User-agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.1.4pre) Gecko/20091014 Fedora/3.0-2.8.b4.fc11 Lightning/1.0pre Thunderbird/3.0b4

On 10/29/09 17:56, Matthew Booth wrote:
+DEFHEADING()
+
+DEFHEADING(Character device options:)
+
+DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
+    "-chardev null[,id=id]\n"
+    "                A void device. This device will not emit any data, and 
will\n"
+    "                drop any data it receives.\n"

I'd try to keep this shorter to not bloat the -help text. Just list the options, like this:

-chardev null,id=id
-chardev socket,id=id,path=path[,...]           (unix)
-chardev socket,id=id,port=port[,...]           (tcp)
-chardev udp,...

maybe?  The detailed descriptions are in the man-page.

Oh, and id is *not* optional (would be pointless as you would have no way to use the chardev), so it shouldn't be listed in brackets.

+STEXI
+
+The general form of a character device option is:
address@hidden @option
+
address@hidden -chardev @var{backend} [,address@hidden [,@var{options}]

Same here.

address@hidden -chardev vc [,address@hidden
+
+Connect to a QEMU text console. @option{vc} does not take any options.

It takes options for the scren size: width+height (pixels) or cols+rows (chars) (see console.c).

Otherwise the patch looks fine.

Thanks for doing this,
  Gerd




reply via email to

[Prev in Thread] Current Thread [Next in Thread]