From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:43667) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZfUw9-0003Ep-TT for qemu-devel@nongnu.org; Fri, 25 Sep 2015 11:29:26 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZfUw6-0001jF-NT for qemu-devel@nongnu.org; Fri, 25 Sep 2015 11:29:25 -0400 Received: from mx6-phx2.redhat.com ([209.132.183.39]:44504) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZfUw6-0001if-Eq for qemu-devel@nongnu.org; Fri, 25 Sep 2015 11:29:22 -0400 Date: Fri, 25 Sep 2015 11:29:19 -0400 (EDT) From: =?utf-8?Q?Marc-Andr=C3=A9?= Lureau Message-ID: <1869848575.17961943.1443194959176.JavaMail.zimbra@redhat.com> In-Reply-To: <56056701.10306@redhat.com> References: <1443189844-20341-1-git-send-email-marcandre.lureau@redhat.com> <1443189844-20341-7-git-send-email-marcandre.lureau@redhat.com> <56056701.10306@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Subject: Re: [Qemu-devel] [PATCH 06/36] qapi: move documentation bits in schema files List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Eric Blake Cc: mdroth@linux.vnet.ibm.com, marcandre lureau , qemu-devel@nongnu.org, armbru@redhat.com ----- Original Message ----- > On 09/25/2015 08:03 AM, marcandre.lureau@redhat.com wrote: > > From: Marc-Andr=C3=A9 Lureau > >=20 > > Moving the remaining bits of documentation to the schema files. > >=20 > > Signed-off-by: Marc-Andr=C3=A9 Lureau > > --- > > qapi-schema.json | 48 ++++++++++++++++++++++++++++++++++++++++++- > > qmp-commands.hx | 62 > > -------------------------------------------------------- > > 2 files changed, 47 insertions(+), 63 deletions(-) > >=20 > > diff --git a/qapi-schema.json b/qapi-schema.json > > index 1383011..c8ee75d 100644 > > --- a/qapi-schema.json > > +++ b/qapi-schema.json > > @@ -1,6 +1,52 @@ > > # -*- Mode: Python -*- > > +## > > +# =3D Introduction > > +# > > +# This document describes all commands currently supported by QMP. > > +# > > +# Most of the time their usage is exactly the same as in the user Moni= tor, > > this > > +# means that any other document which also describe commands (the manp= age, > > +# QEMU's manual, etc) can and should be consulted. > > +# > > +# QMP has two types of commands: regular and query commands. Regular > > commands > > +# usually change the Virtual Machine's state someway, while query comm= ands > > just > > +# return information. The sections below are divided accordingly. >=20 > Do we really still have that clean division? snip Could we leave the content change for a later patch? The point was not to r= ewrite the documentation, but simply to move it.