[Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc

[Jan Kiszka <jan.kiszka@siemens.com>]

Luiz Capitulino wrote:
> One of the most important missing feature in QMP today is its
> supported commands documentation.
> 
> The plan is to make it part of self-description support, however
> self-description is a big task we have been postponing for a
> long time now and still don't know when it's going to be done.
> 
> In order not to compromise QMP adoption and make users' life easier,
> this commit adds a simple text documentation which fully describes
> all QMP supported commands.
> 
> This is not ideal for a number of reasons (harder to maintain,
> text-only, etc) but does improve the current situation.

Even if it's temporary - maintaining it in a separate file looks rather
unhandy.

Can't we generate the per-command documentation snippets also from
qemu-monitor.hx and merge them with a header/footer into some text file?
That .hx file is the one anyone adding/converting commands has to touch
anyway.

Jan

-- 
Siemens AG, Corporate Technology, CT T DE IT 1
Corporate Competence Center Embedded Linux