[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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

From: Avi Kivity
Subject: [Qemu-devel] Re: [PATCH 1/2] QMP: Introduce commands doc
Date: Fri, 14 May 2010 20:12:32 +0300
User-agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv: Gecko/20100330 Fedora/3.0.4-1.fc12 Thunderbird/3.0.4

On 05/14/2010 08:08 PM, Jan Kiszka wrote:

I mean, a patch introducing or modifying a monitor command.
The snippets should be readable by themselves.

They may be readable, but that doesn't mean anyone will read them. It's a lot easier for someone who isn't involved in the code (the libvirt people, or me) to review standalone documentation than something embedded in a patch (typically at the very end).

I'm only proposing to
keep them in the central file, at the same location where the others
are. There is no difference compared to existing monitor commands, we
just add the third documentation snippet, this time for QMP.

That's fine. But the fact that a lot of review comments pointing out issues surface only now show that we need to make things easier for reviewers. It's much harder to fix an external interface than an internal one.

Distributing a generated QMP/qmp-commands.txt is another thing, maybe a
useful one.

Sure, like the other qemu documentation.

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

reply via email to

[Prev in Thread] Current Thread [Next in Thread]