From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from [140.186.70.92] (port=48619 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OJVFD-0008Cl-OR for qemu-devel@nongnu.org; Tue, 01 Jun 2010 13:27:18 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OJVFB-0007Tz-Un for qemu-devel@nongnu.org; Tue, 01 Jun 2010 13:27:15 -0400 Received: from mx1.redhat.com ([209.132.183.28]:12894) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OJVFB-0007Tn-OQ for qemu-devel@nongnu.org; Tue, 01 Jun 2010 13:27:13 -0400 Date: Tue, 1 Jun 2010 14:27:07 -0300 From: Luiz Capitulino Message-ID: <20100601142707.074c5e7b@redhat.com> In-Reply-To: <4C0530F2.9020809@siemens.com> References: <1275327812-27017-1-git-send-email-lcapitulino@redhat.com> <1275327812-27017-3-git-send-email-lcapitulino@redhat.com> <4C0530F2.9020809@siemens.com> Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII 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: Jan Kiszka Cc: "armbru@redhat.com" , "aliguori@us.ibm.com" , "qemu-devel@nongnu.org" , "avi@redhat.com" 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.