]> git.proxmox.com Git - mirror_qemu.git/commit
qapi: Fix unintended definition lists in documentation
authorMarkus Armbruster <armbru@redhat.com>
Tue, 25 Apr 2023 06:42:17 +0000 (08:42 +0200)
committerMarkus Armbruster <armbru@redhat.com>
Fri, 28 Apr 2023 09:48:34 +0000 (11:48 +0200)
commitf2de3b926cf37e0c878a52f01a29e5d708bccedb
treeddffb89bafa3011b2d0e42a1d294a6aad86ce89d
parentc11010289851ab1943442ff87cf19b7686fb94b3
qapi: Fix unintended definition lists in documentation

rST parses something like

    first line
        second line

as a definition list item, where "first line" is the term being
defined by "second line".

This bites us in a couple of places.  Here's one:

    # @bps_max: total throughput limit during bursts,
    #                     in bytes (Since 1.7)

scripts/qapi/parser.py parses this into an "argument section" with
name "bps_max" and text

    total throughput limit during bursts,
      in bytes (Since 1.7)

docs/sphinx/qapidoc.py duly passes the text to the rST parser, which
parses it as another definition list.  Comes out as nested
definitions: term "bps_max: int (optional)" defined as term "total
throughput limit during bursts," defined as "in bytes (Since 1.7)".

rST truly is the Perl of ASCII-based markups.

Fix by deleting the extra indentation.

Fixes: 26ec4e53f2bf (qapi: Fix indent level on doc comments in json files)
Fixes: c0ac533b6f97 (qapi: Stop using whitespace for alignment in comments)
Fixes: 81ad2964e938 (net/vmnet: add vmnet backends to qapi/net)
Reported-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20230425064223.820979-11-armbru@redhat.com>
qapi/block-core.json
qapi/control.json
qapi/machine.json
qapi/net.json