[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc
From: |
Jan Kiszka |
Subject: |
[Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc |
Date: |
Fri, 14 May 2010 18:52:44 +0200 |
User-agent: |
Mozilla/5.0 (X11; U; Linux i686 (x86_64); de; rv:1.8.1.12) Gecko/20080226 SUSE/2.0.0.12-1.1 Thunderbird/2.0.0.12 Mnenhy/0.7.5.666 |
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
- Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc, (continued)
- Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc, Luiz Capitulino, 2010/05/14
- Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc, Avi Kivity, 2010/05/15
- Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc, Markus Armbruster, 2010/05/17
- Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc, Anthony Liguori, 2010/05/17
- Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc, Avi Kivity, 2010/05/17
- Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc, Markus Armbruster, 2010/05/18
- Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc, Luiz Capitulino, 2010/05/18
- Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc, Markus Armbruster, 2010/05/14
[Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc,
Jan Kiszka <=
- [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc, Avi Kivity, 2010/05/14
- [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc, Avi Kivity, 2010/05/14
- [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc, Jan Kiszka, 2010/05/14
- [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc, Avi Kivity, 2010/05/14
- [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc, Luiz Capitulino, 2010/05/14
- [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc, Jan Kiszka, 2010/05/15
- [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc, Luiz Capitulino, 2010/05/17
- Re: [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc, Markus Armbruster, 2010/05/18
- Re: [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc, Luiz Capitulino, 2010/05/18