qapi: New documentation section tag "Errors"
commit3a025d3d1ffa63903aba7775a1061b0e30da4d13
authorMarkus Armbruster <armbru@redhat.com>
Tue, 27 Feb 2024 11:39:11 +0000 (27 12:39 +0100)
committerMarkus Armbruster <armbru@redhat.com>
Mon, 4 Mar 2024 06:12:40 +0000 (4 07:12 +0100)
tree8b20797b0df43aac848385b29c4373b395afd64b
parent51e97c14fb54efaab57ee3b617bdd252ecf31c7b
qapi: New documentation section tag "Errors"

We use section "Returns" for documenting both success and error
response of commands.

I intend to generate better command success response documentation.
Easier when "Returns" documents just he success response.

Create new section tag "Errors".  The next two commits will move error
response documentation from "Returns" sections to "Errors" sections.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240227113921.236097-4-armbru@redhat.com>
docs/devel/qapi-code-gen.rst
scripts/qapi/parser.py
tests/qapi-schema/doc-good.json
tests/qapi-schema/doc-good.out
tests/qapi-schema/doc-good.txt