[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] Re: [PATCH 2/3] QMP: Introduce commands documentation
From: |
Jan Kiszka |
Subject: |
[Qemu-devel] Re: [PATCH 2/3] QMP: Introduce commands documentation |
Date: |
Tue, 01 Jun 2010 19:39:00 +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:
> On Tue, 01 Jun 2010 18:10:26 +0200
> Jan Kiszka <address@hidden> wrote:
>
>> Luiz Capitulino wrote:
>>> From: Jan Kiszka <address@hidden>
>>>
>>> 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. To avoid at
>>> least divering from the user monitor help and texi snippets, QMP bits
>>> are also maintained inside qemu-monitor.hx, and hxtool is extended to
>>> generate a single text file from them.
>>>
>>> Signed-off-by: Jan Kiszka <address@hidden>
>>> Signed-off-by: Luiz Capitulino <address@hidden>
>>> ---
>>> Makefile | 5 +-
>>> QMP/README | 5 +-
>>> configure | 4 +
>>> hxtool | 44 ++-
>>> qemu-monitor.hx | 1322
>>> +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>>> 5 files changed, 1376 insertions(+), 4 deletions(-)
>>>
>>> diff --git a/Makefile b/Makefile
>>> index 7986bf6..3a8a311 100644
>>> --- a/Makefile
>>> +++ b/Makefile
>>> @@ -29,7 +29,7 @@ $(call set-vpath, $(SRC_PATH):$(SRC_PATH)/hw)
>>> LIBS+=-lz $(LIBS_TOOLS)
>>>
>>> ifdef BUILD_DOCS
>>> -DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8
>>> +DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8
>>> QMP/qmp-commands.txt
>>> else
>>> DOCS=
>>> endif
>>> @@ -259,6 +259,9 @@ qemu-options.texi: $(SRC_PATH)/qemu-options.hx
>>> qemu-monitor.texi: $(SRC_PATH)/qemu-monitor.hx
>>> $(call quiet-command,sh $(SRC_PATH)/hxtool -t < $< > $@," GEN
>>> $@")
>>>
>>> +QMP/qmp-commands.txt: $(SRC_PATH)/qemu-monitor.hx
>>> + $(call quiet-command,sh $(SRC_PATH)/hxtool -q < $< > $@," GEN
>>> $@")
>>> +
>>> qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx
>>> $(call quiet-command,sh $(SRC_PATH)/hxtool -t < $< > $@," GEN
>>> $@")
>>>
>> This hunk seem to have "gained" tab-to-spaces conversion, unfortunately
>> in a makefile.
>>
>> Applying the patch generated another hunk warning:
>
> Are those problems worth a resping or can we fix then with
> additional patches? It works ok here.
Oh, it's indeed a local issue. Likely our corporate mail server. Nice...
Sorry for the noise!
Jan
--
Siemens AG, Corporate Technology, CT T DE IT 1
Corporate Competence Center Embedded Linux