| Message ID | 1503576178-23966-2-git-send-email-armbru@redhat.com |
|---|---|
| State | New |
| Headers | show |
On Thu, Aug 24, 2017 at 2:02 PM, Markus Armbruster <armbru@redhat.com> wrote: > Documentation generated with qapi2texi.py is in textual order, with > included sub-schemas inserted at the first include directive > (subsequent include directives have no effect). To get a sane and > stable order, it's best to include each sub-schema just once, or > include it first in qapi-schema.json. Document that. > > While there, drop a few redundant comments. > > Signed-off-by: Markus Armbruster <armbru@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com> > --- > qapi-schema.json | 17 ++++++----------- > 1 file changed, 6 insertions(+), 11 deletions(-) > > diff --git a/qapi-schema.json b/qapi-schema.json > index 802ea53..76b5888 100644 > --- a/qapi-schema.json > +++ b/qapi-schema.json > @@ -72,22 +72,17 @@ > 'q_obj_CpuInfo-base' # CPU, visible through query-cpu > ] } } > > -# QAPI common definitions > +# Documentation generated with qapi2texi.py is in textual order, with > +# included sub-schemas inserted at the first include directive > +# (subsequent include directives have no effect). To get a sane and > +# stable order, it's best to include each sub-schema just once, or > +# include it first in qapi-schema.json. > + > { 'include': 'qapi/common.json' } > - > -# QAPI crypto definitions > { 'include': 'qapi/crypto.json' } > - > -# QAPI block definitions > { 'include': 'qapi/block.json' } > - > -# QAPI event definitions > { 'include': 'qapi/event.json' } > - > -# Tracing commands > { 'include': 'qapi/trace.json' } > - > -# QAPI introspection > { 'include': 'qapi/introspect.json' } > > ## > -- > 2.7.5 > >
diff --git a/qapi-schema.json b/qapi-schema.json index 802ea53..76b5888 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -72,22 +72,17 @@ 'q_obj_CpuInfo-base' # CPU, visible through query-cpu ] } } -# QAPI common definitions +# Documentation generated with qapi2texi.py is in textual order, with +# included sub-schemas inserted at the first include directive +# (subsequent include directives have no effect). To get a sane and +# stable order, it's best to include each sub-schema just once, or +# include it first in qapi-schema.json. + { 'include': 'qapi/common.json' } - -# QAPI crypto definitions { 'include': 'qapi/crypto.json' } - -# QAPI block definitions { 'include': 'qapi/block.json' } - -# QAPI event definitions { 'include': 'qapi/event.json' } - -# Tracing commands { 'include': 'qapi/trace.json' } - -# QAPI introspection { 'include': 'qapi/introspect.json' } ##
Documentation generated with qapi2texi.py is in textual order, with included sub-schemas inserted at the first include directive (subsequent include directives have no effect). To get a sane and stable order, it's best to include each sub-schema just once, or include it first in qapi-schema.json. Document that. While there, drop a few redundant comments. Signed-off-by: Markus Armbruster <armbru@redhat.com> --- qapi-schema.json | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-)