]> git.ipfire.org Git - thirdparty/qemu.git/commit
qapi: Fix incorrect "Not documented" claims in QMP documentation
authorPeter Maydell <peter.maydell@linaro.org>
Thu, 13 Feb 2020 17:56:25 +0000 (17:56 +0000)
committerMarkus Armbruster <armbru@redhat.com>
Sat, 15 Feb 2020 10:41:50 +0000 (11:41 +0100)
commitf56275064e06974b5c03f37ccdb124adbc5baef6
treecab44e8d3fc368badb94573c9fa2d291a84c7384
parent0a940d66de9590566c09e3bfab539d5cbe9481d9
qapi: Fix incorrect "Not documented" claims in QMP documentation

Some qapi doc comments have forgotten the ':' after the
@argument, like this:

# @filename         Filename for the new image file
# @size             Size of the virtual disk in bytes

The result is that these are parsed as part of the body
text and appear as a run-on line:
  filename Filename for the new image file size Size of the virtual disk in bytes"
followed by
  filename: string
    Not documented
  size: int
    Not documented

in the 'Members' section.

Correct the formatting.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20200213175647.17628-9-peter.maydell@linaro.org>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
qapi/block-core.json