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

[Gerd Hoffmann <kraxel@redhat.com>]

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:
> +@table @option
> +
> +@item -chardev @var{backend} [,id=@var{id}] [,@var{options}]

Same here.

> +@item -chardev vc [,id=@var{id}]
> +
> +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