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

[Matthew Booth]

On 30/10/09 09:17, Gerd Hoffmann wrote:
> 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.

Done

> 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.

I thought as much, although the code doesn't look as though it'll 
explode if id isn't set. I've updated to indicate it's required.

> > +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).

Ah, the path to those wasn't quite so straightforward :) Updated.

New patch attached.

Matt
--
Matthew Booth, RHCA, RHCSS
Red Hat Engineering, Virtualisation Team

M:       +44 (0)7977 267231
GPG ID:  D33C3490
GPG FPR: 3733 612D 2D05 5458 8A8A 1600 3441 EA19 D33C 3490

0001-Documentation-Add-documentation-for-chardev.patch
Description: Text document