From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from [140.186.70.92] (port=59423 helo=eggs.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.43) id 1OCyHI-0002dJ-5S
	for qemu-devel@nongnu.org; Fri, 14 May 2010 13:02:26 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.69)
	(envelope-from <avi@redhat.com>) id 1OCyGu-0008Kr-CD
	for qemu-devel@nongnu.org; Fri, 14 May 2010 13:02:15 -0400
Received: from mx1.redhat.com ([209.132.183.28]:29139)
	by eggs.gnu.org with esmtp (Exim 4.69)
	(envelope-from <avi@redhat.com>) id 1OCyGt-0008KA-IK
	for qemu-devel@nongnu.org; Fri, 14 May 2010 13:02:00 -0400
Message-ID: <4BED8202.5020309@redhat.com>
Date: Fri, 14 May 2010 20:01:54 +0300
From: Avi Kivity <avi@redhat.com>
MIME-Version: 1.0
References: <1273086712-29163-1-git-send-email-lcapitulino@redhat.com>
	<1273086712-29163-2-git-send-email-lcapitulino@redhat.com>
	<4BED7FDC.7030208@siemens.com>
In-Reply-To: <4BED7FDC.7030208@siemens.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Subject: [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc
List-Id: qemu-devel.nongnu.org
List-Unsubscribe: <http://lists.nongnu.org/mailman/listinfo/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=unsubscribe>
List-Archive: <http://lists.nongnu.org/archive/html/qemu-devel>
List-Post: <mailto:qemu-devel@nongnu.org>
List-Help: <mailto:qemu-devel-request@nongnu.org?subject=help>
List-Subscribe: <http://lists.nongnu.org/mailman/listinfo/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
To: Jan Kiszka <jan.kiszka@siemens.com>
Cc: bazulay@redhat.com, juzhang@redhat.com, qemu-devel@nongnu.org, armbru@redhat.com, Luiz Capitulino <lcapitulino@redhat.com>

On 05/14/2010 07:52 PM, Jan Kiszka wrote:
>
>> 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.
>    

If we do, then the generated documentation should be included in the 
patch changelog for review.

-- 
Do not meddle in the internals of kernels, for they are subtle and quick to panic.