From patchwork Tue Jun 1 16:10:26 2010 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jan Kiszka X-Patchwork-Id: 54233 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id EF5B7B7D20 for ; Wed, 2 Jun 2010 02:13:04 +1000 (EST) Received: from localhost ([127.0.0.1]:46097 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OJU5N-0005Ni-A0 for incoming@patchwork.ozlabs.org; Tue, 01 Jun 2010 12:13:01 -0400 Received: from [140.186.70.92] (port=50855 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OJU2z-0004UT-0V for qemu-devel@nongnu.org; Tue, 01 Jun 2010 12:10:34 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OJU2w-0001Df-KP for qemu-devel@nongnu.org; Tue, 01 Jun 2010 12:10:32 -0400 Received: from goliath.siemens.de ([192.35.17.28]:24209) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OJU2w-0001D6-86 for qemu-devel@nongnu.org; Tue, 01 Jun 2010 12:10:30 -0400 Received: from mail2.siemens.de (localhost [127.0.0.1]) by goliath.siemens.de (8.12.11.20060308/8.12.11) with ESMTP id o51GARFk019400; Tue, 1 Jun 2010 18:10:27 +0200 Received: from [139.25.109.167] (mchn012c.mchp.siemens.de [139.25.109.167] (may be forged)) by mail2.siemens.de (8.12.11.20060308/8.12.11) with ESMTP id o51GAQNY026636; Tue, 1 Jun 2010 18:10:27 +0200 Message-ID: <4C0530F2.9020809@siemens.com> Date: Tue, 01 Jun 2010 18:10:26 +0200 From: Jan Kiszka 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 MIME-Version: 1.0 To: Luiz Capitulino References: <1275327812-27017-1-git-send-email-lcapitulino@redhat.com> <1275327812-27017-3-git-send-email-lcapitulino@redhat.com> In-Reply-To: <1275327812-27017-3-git-send-email-lcapitulino@redhat.com> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4-2.6 Cc: "armbru@redhat.com" , "aliguori@us.ibm.com" , "qemu-devel@nongnu.org" , "avi@redhat.com" Subject: [Qemu-devel] Re: [PATCH 2/3] QMP: Introduce commands documentation X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org 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: ... patching file qemu-monitor.hx Hunk #15 succeeded at 983 with fuzz 2. Haven't checked yet - harmless? If you need to resent the patch, please already fold in this trivial fix: Thanks! Jan diff --git a/hxtool b/hxtool index d499dc0..7ca83ed 100644 --- a/hxtool +++ b/hxtool @@ -59,6 +59,7 @@ hxtoqmp() { IFS= flag=0 + line=1 while read -r str; do case "$str" in HXCOMM*) @@ -87,6 +88,7 @@ hxtoqmp() test $flag -eq 1 && echo "$str" ;; esac + line=$((line+1)) done }