Skip to content

Commit

Permalink
qapi-schema: Improve section headings
Browse files Browse the repository at this point in the history
The generated QEMU QMP reference is now structured as follows:

    1.1 Introduction
    1.2 Stability Considerations
    1.3 Common data types
    1.4 Socket data types
    1.5 VM run state
    1.6 Cryptography
    1.7 Block devices
    1.7.1 Block core (VM unrelated)
    1.7.2 QAPI block definitions (vm unrelated)
    1.8 Character devices
    1.9 Net devices
    1.10 Rocker switch device
    1.11 TPM (trusted platform module) devices
    1.12 Remote desktop
    1.12.1 Spice
    1.12.2 VNC
    1.13 Input
    1.14 Migration
    1.15 Transactions
    1.16 Tracing
    1.17 QMP introspection
    1.18 Miscellanea

Section "1.18 Miscellanea" is still too big: it documents 134 symbols.
Section "1.7.1 Block core (VM unrelated)" is also rather big: 128
symbols.  All the others are of reasonable size.

Signed-off-by: Markus Armbruster <[email protected]>
Message-Id: <[email protected]>
Reviewed-by: Marc-André Lureau <[email protected]>
  • Loading branch information
Markus Armbruster committed Sep 4, 2017
1 parent 496490a commit f5cf31c
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 8 deletions.
2 changes: 1 addition & 1 deletion qapi-schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
{ 'include': 'qapi/introspect.json' }

##
# = QMP commands
# = Miscellanea
##

##
Expand Down
2 changes: 1 addition & 1 deletion qapi/block-core.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- Mode: Python -*-

##
# == QAPI block core definitions (vm unrelated)
# == Block core (VM unrelated)
##

{ 'include': 'common.json' }
Expand Down
5 changes: 2 additions & 3 deletions qapi/block.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# -*- Mode: Python -*-

##
# = QAPI block definitions
# = Block devices
##

# QAPI block core definitions
{ 'include': 'block-core.json' }

##
# == QAPI block definitions (vm unrelated)
# == Additional block stuff (VM related)
##

##
Expand Down
2 changes: 1 addition & 1 deletion qapi/common.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# -*- Mode: Python -*-

##
# = QAPI common definitions
# = Common data types
##

##
Expand Down
2 changes: 1 addition & 1 deletion qapi/crypto.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#

##
# = QAPI crypto definitions
# = Cryptography
##

##
Expand Down
2 changes: 1 addition & 1 deletion qapi/trace.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# See the COPYING file in the top-level directory.

##
# = Tracing commands
# = Tracing
##

##
Expand Down

0 comments on commit f5cf31c

Please sign in to comment.