Re: [Qemu-devel] [PATCH] Makefile: Install qmp-events.txt

[Eric Blake]

On 06/26/2014 07:25 AM, Paolo Bonzini wrote:
> 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.

Actually, there is a second new event on queue right now:
https://lists.gnu.org/archive/html/qemu-devel/2014-06/msg06561.html

> 
> 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.

Sadly, manpower is more frequently devoted to code than to documentation
improvements.

> 
> 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

So depending on Laszlo's series, we may be adding 2 events in 2.1.

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature