From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from [140.186.70.92] (port=51382 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OJVQg-0000io-1a for qemu-devel@nongnu.org; Tue, 01 Jun 2010 13:39:11 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OJVQe-0002Jt-IP for qemu-devel@nongnu.org; Tue, 01 Jun 2010 13:39:05 -0400 Received: from goliath.siemens.de ([192.35.17.28]:16438) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OJVQe-0002It-7x for qemu-devel@nongnu.org; Tue, 01 Jun 2010 13:39:04 -0400 Message-ID: <4C0545B4.4010505@siemens.com> Date: Tue, 01 Jun 2010 19:39:00 +0200 From: Jan Kiszka MIME-Version: 1.0 References: <1275327812-27017-1-git-send-email-lcapitulino@redhat.com> <1275327812-27017-3-git-send-email-lcapitulino@redhat.com> <4C0530F2.9020809@siemens.com> <20100601142707.074c5e7b@redhat.com> In-Reply-To: <20100601142707.074c5e7b@redhat.com> Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Subject: [Qemu-devel] Re: [PATCH 2/3] QMP: Introduce commands documentation List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Luiz Capitulino Cc: "armbru@redhat.com" , "aliguori@us.ibm.com" , "qemu-devel@nongnu.org" , "avi@redhat.com" Luiz Capitulino wrote: > On Tue, 01 Jun 2010 18:10:26 +0200 > Jan Kiszka wrote: > >> Luiz Capitulino wrote: >>> From: Jan Kiszka >>> >>> 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 >>> Signed-off-by: Luiz Capitulino >>> --- >>> 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