From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from eggs.gnu.org ([2001:4830:134:3::10]:60859)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <pbonzini@redhat.com>) id 1X09gS-0003eT-IG
	for qemu-devel@nongnu.org; Thu, 26 Jun 2014 09:25:56 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <pbonzini@redhat.com>) id 1X09gI-0002rJ-3b
	for qemu-devel@nongnu.org; Thu, 26 Jun 2014 09:25:48 -0400
Received: from mx1.redhat.com ([209.132.183.28]:22875)
	by eggs.gnu.org with esmtp (Exim 4.71)
	(envelope-from <pbonzini@redhat.com>) id 1X09gH-0002r6-P4
	for qemu-devel@nongnu.org; Thu, 26 Jun 2014 09:25:37 -0400
Message-ID: <53AC1F4D.6090702@redhat.com>
Date: Thu, 26 Jun 2014 15:25:33 +0200
From: Paolo Bonzini <pbonzini@redhat.com>
MIME-Version: 1.0
References: <4b996aea34144d33f2227835dc3d064818ffb7be.1403688576.git.mprivozn@redhat.com>	<53AAD523.3000604@redhat.com>	<20140625155048.252833c1@redhat.com>	<53AB2D71.7050704@redhat.com>	<20140626084611.20f771a2@redhat.com>	<53AC19C3.10502@redhat.com>	<53AC1C13.40308@redhat.com>	<53AC1C99.8070106@redhat.com>
	<20140626091738.4ee3a0b4@redhat.com>
In-Reply-To: <20140626091738.4ee3a0b4@redhat.com>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit
Subject: Re: [Qemu-devel] [PATCH] Makefile: Install qmp-events.txt
List-Id: <qemu-devel.nongnu.org>
List-Unsubscribe: <https://lists.nongnu.org/mailman/options/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: <https://lists.nongnu.org/mailman/listinfo/qemu-devel>,
	<mailto:qemu-devel-request@nongnu.org?subject=subscribe>
To: Luiz Capitulino <lcapitulino@redhat.com>
Cc: famz@redhat.com, Michal Privoznik <mprivozn@redhat.com>, qemu-devel@nongnu.org, Wenchao Xia <wenchaoqemu@gmail.com>

Il 26/06/2014 15:17, Luiz Capitulino ha scritto:
>> > We're really close to hard freeze and by extension the release.  Do
>> > _not_ strive for perfection.  Get something that is mostly okay and is
>> > an obvious patch.  We'll then have 3 weeks to do documentation patches.
> The hard freeze argument is a strong one, but my understanding was that
> we wanted to move away from duplicated information. So reverting is a
> step back.

We sure want to move away from duplicated information.  However, at this 
point we are actively _dropping_ information compared to qmp-events.txt 
(the examples).

Considering that QEMU releases rarely add more than 1 event(*), the 
amount of duplicated work caused by qmp-events.txt is trivial for the 
foreseeable future.

Of course, the obvious steps to do things "right" are:

- automatically generate HTML/DocBook/Texinfo documentation from .json

- install the automatically-generated documentation

- move examples from qmp-events.txt and qmp-commands.hx to the .json

- when qmp-events.txt and qmp-commands.hx are entirely duplicate, kill them

But this requires manpower, of course.

Paolo

(*)    Version         Events introduced
        0.12.0                5
        0.13.0                5
        0.14.0                3
        0.15.0                0
        1.0                   0
        1.1                   2
        1.2                   2
        1.3                   1
        1.4                   0
        1.5                   1
        1.6                   1
        1.7                   0
        2.0                   1
        2.1                   1