mirror of https://github.com/proxmox/mirror_qemu
qapi-schema: Document how generated documentation is ordered
Documentation generated with qapi2texi.py is in source 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> Message-Id: <1503602048-12268-2-git-send-email-armbru@redhat.com>master
parent
cbb6540526
commit
211e5063be
|
@ -72,22 +72,17 @@
|
||||||
'q_obj_CpuInfo-base' # CPU, visible through query-cpu
|
'q_obj_CpuInfo-base' # CPU, visible through query-cpu
|
||||||
] } }
|
] } }
|
||||||
|
|
||||||
# QAPI common definitions
|
# Documentation generated with qapi2texi.py is in source 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' }
|
{ 'include': 'qapi/common.json' }
|
||||||
|
|
||||||
# QAPI crypto definitions
|
|
||||||
{ 'include': 'qapi/crypto.json' }
|
{ 'include': 'qapi/crypto.json' }
|
||||||
|
|
||||||
# QAPI block definitions
|
|
||||||
{ 'include': 'qapi/block.json' }
|
{ 'include': 'qapi/block.json' }
|
||||||
|
|
||||||
# QAPI event definitions
|
|
||||||
{ 'include': 'qapi/event.json' }
|
{ 'include': 'qapi/event.json' }
|
||||||
|
|
||||||
# Tracing commands
|
|
||||||
{ 'include': 'qapi/trace.json' }
|
{ 'include': 'qapi/trace.json' }
|
||||||
|
|
||||||
# QAPI introspection
|
|
||||||
{ 'include': 'qapi/introspect.json' }
|
{ 'include': 'qapi/introspect.json' }
|
||||||
|
|
||||||
##
|
##
|
||||||
|
|
Loading…
Reference in New Issue