Re: [Qemu-devel] [PATCH 1/2] QMP: Introduce commands doc

[Markus Armbruster]

Avi Kivity <address@hidden> writes:

> On 05/14/2010 11:33 AM, Markus Armbruster wrote:
>>
>> And we absolutely need to make use of that license to improve stuff.
>> Premature stability leads to stable crap.  Having to get everything
>> right the first time is just too hard for mortals.
>>    
>
> If that is the way we go (and I'm not sure what's the right thing
> here) then I suggest the following strategy:
>
> - fix the patch so it describes the current state of things accurately
> - merge
> - post patches that change both the code and the documentation to fix
> protocol problems
>
> That is, separate bugs in the documentation from bugs in the protocol;
> that allows new commands to be implemented and documented in parallel
> with fixing the old commands.

Step 1: Move the existing documentation out of the source files
verbatim.

Step 2: Fix it up so that it describes the current state of things
accurately.

Step 3+: Fix the protocol problems.