Re: [Qemu-devel] [PATCH] Documentation: Add missing documentation for qdev related command line options

[Markus Armbruster]

Stefan Weil <address@hidden> 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 <address@hidden>
> ---
>  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
> address@hidden -device @var{driver}[,@var{option}[,...]]
> +Add device @var{driver}. Depending on the device type,
> address@hidden (typically @address@hidden) 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.

>  DEF("name", HAS_ARG, QEMU_OPTION_name,
[...]
> +STEXI
> address@hidden -writeconfig @var{file}
> +Write device configuration to @var{file}.
> +ETEXI
> +
> +HXCOMM This is the last statement. Insert new options before this line!
> +STEXI
> address@hidden table
> +ETEXI

Neat, thanks!