From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from [140.186.70.92] (port=52265 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1OCy83-0003dx-DN for qemu-devel@nongnu.org; Fri, 14 May 2010 12:52:53 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69) (envelope-from ) id 1OCy81-0006qm-4w for qemu-devel@nongnu.org; Fri, 14 May 2010 12:52:51 -0400 Received: from david.siemens.de ([192.35.17.14]:22171) by eggs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1OCy80-0006qS-PM for qemu-devel@nongnu.org; Fri, 14 May 2010 12:52:49 -0400 Message-ID: <4BED7FDC.7030208@siemens.com> Date: Fri, 14 May 2010 18:52:44 +0200 From: Jan Kiszka MIME-Version: 1.0 References: <1273086712-29163-1-git-send-email-lcapitulino@redhat.com> <1273086712-29163-2-git-send-email-lcapitulino@redhat.com> In-Reply-To: <1273086712-29163-2-git-send-email-lcapitulino@redhat.com> Content-Type: text/plain; charset=ISO-8859-15 Content-Transfer-Encoding: 7bit Subject: [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc List-Id: qemu-devel.nongnu.org List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Luiz Capitulino Cc: bazulay@redhat.com, juzhang@redhat.com, Avi Kivity , qemu-devel@nongnu.org, armbru@redhat.com 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