diff options
| author | Markus Armbruster <armbru@redhat.com> | 2024-02-27 12:39:11 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-03-04 07:12:40 +0100 |
| commit | 3a025d3d1ffa63903aba7775a1061b0e30da4d13 (patch) | |
| tree | 8b20797b0df43aac848385b29c4373b395afd64b /tests | |
| parent | 51e97c14fb54efaab57ee3b617bdd252ecf31c7b (diff) | |
| download | focaccia-qemu-3a025d3d1ffa63903aba7775a1061b0e30da4d13.tar.gz focaccia-qemu-3a025d3d1ffa63903aba7775a1061b0e30da4d13.zip | |
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>
Diffstat (limited to 'tests')
| -rw-r--r-- | tests/qapi-schema/doc-good.json | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.out | 2 | ||||
| -rw-r--r-- | tests/qapi-schema/doc-good.txt | 6 |
3 files changed, 10 insertions, 0 deletions
diff --git a/tests/qapi-schema/doc-good.json b/tests/qapi-schema/doc-good.json index 5bb2b69071..de38a386e8 100644 --- a/tests/qapi-schema/doc-good.json +++ b/tests/qapi-schema/doc-good.json @@ -159,6 +159,8 @@ # # Returns: @Object # +# Errors: some +# # TODO: frobnicate # # Notes: diff --git a/tests/qapi-schema/doc-good.out b/tests/qapi-schema/doc-good.out index 34ee74af4b..716a9a4102 100644 --- a/tests/qapi-schema/doc-good.out +++ b/tests/qapi-schema/doc-good.out @@ -173,6 +173,8 @@ another feature @arg3 is undocumented section=Returns @Object + section=Errors +some section=TODO frobnicate section=Notes diff --git a/tests/qapi-schema/doc-good.txt b/tests/qapi-schema/doc-good.txt index 879f6ff50a..847db70412 100644 --- a/tests/qapi-schema/doc-good.txt +++ b/tests/qapi-schema/doc-good.txt @@ -206,6 +206,12 @@ Returns "Object" +Errors +~~~~~~ + +some + + Notes ~~~~~ |