Stefan Weil <w...@mail.berlios.de> writes: > Markus Armbruster schrieb: >> Stefan Weil <w...@mail.berlios.de> writes: >> >>> The command line options -device, -nodefaults, -readconfig, >>> -writeconfig had entries for command line help, but >>> documentation for texi and derived formats (man, html, info) >>> was missing. >>> >>> This also required moving "@end table" to the end of >>> qemu-options.hx again. >>> >>> Signed-off-by: Stefan Weil <w...@mail.berlios.de> >>> --- >>> qemu-options.hx | 25 +++++++++++++++++++++---- >>> 1 files changed, 21 insertions(+), 4 deletions(-) >>> >>> diff --git a/qemu-options.hx b/qemu-options.hx >>> index e2edd71..b2d04e2 100644 >>> --- a/qemu-options.hx >>> +++ b/qemu-options.hx >>> @@ -404,6 +404,12 @@ ETEXI >>> >>> DEF("device", HAS_ARG, QEMU_OPTION_device, >>> "-device driver[,options] add device\n") >>> +STEXI >>> +...@item -device @var{driver}[,@var{option}[,...]] >>> +Add device @var{driver}. Depending on the device type, >>> +...@var{option} (typically @var{ke...@var{value}) may be useful. >>> +ETEXI >>> + >> >> While there, would you mind improving --help for -device a bit? It's >> too terse, and it doesn't start the help text in column 16 like the >> other options do. > > Hi Markus, > > this needs a little more work. I just had a look on the code, > and there is no online help for the possible options (key, value).
What I had in mind was just to bring it up to par with your patch to the texi, but... > If you (and especially those who have commit rights) agree, > I could provide these three additional patches: > > * Add online help for properties (qemu -device driver,?) > * Add online help for property value (qemu -device driver,property=?) > * Update documentation for command line option -device ... a patch to provide that is very desirable! I figure the best way to document available properties and there values is a self-documenting struct PropertyInfo: add a doc member, extend DEFINE_PROP() & friends to set it, fix up users to pass NULL, and so forth. We can then replace the NULL by something useful at our leisure. > There is already an online help for the driver (qemu -device ?).