Re: [Qemu-devel] [PATCH 06/36] qapi: move documentation bits in schema files

[Marc-André Lureau]

----- Original Message -----
> On 09/25/2015 08:03 AM, address@hidden wrote:
> > From: Marc-André Lureau <address@hidden>
> > 
> > Moving the remaining bits of documentation to the schema files.
> > 
> > Signed-off-by: Marc-André Lureau <address@hidden>
> > ---
> >  qapi-schema.json | 48 ++++++++++++++++++++++++++++++++++++++++++-
> >  qmp-commands.hx  | 62
> >  --------------------------------------------------------
> >  2 files changed, 47 insertions(+), 63 deletions(-)
> > 
> > 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 -*-
> > +##
> > +# = Introduction
> > +#
> > +# This document describes all commands currently supported by QMP.
> > +#
> > +# Most of the time their usage is exactly the same as in the user Monitor,
> > this
> > +# means that any other document which also describe commands (the manpage,
> > +# 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 commands
> > just
> > +# return information. The sections below are divided accordingly.
> 
> Do we really still have that clean division?

snip

Could we leave the content change for a later patch? The point was not to 
rewrite the documentation, but simply to move it.