qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Stefan Hajnoczi" <stefanha@redhat.com>,
	"Hanna Reitz" <hreitz@redhat.com>,
	"Michael Roth" <michael.roth@amd.com>,
	"Philippe Mathieu-Daudé" <philmd@linaro.org>,
	"Victor Toso de Carvalho" <victortoso@redhat.com>,
	"Michael S. Tsirkin" <mst@redhat.com>,
	"Konstantin Kostiuk" <kkostiuk@redhat.com>,
	"Yanan Wang" <wangyanan55@huawei.com>,
	"Pavel Dovgalyuk" <pavel.dovgaluk@ispras.ru>,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>,
	"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
	"Fabiano Rosas" <farosas@suse.de>,
	"Lukas Straub" <lukasstraub2@web.de>,
	"Eduardo Habkost" <eduardo@habkost.net>,
	"Mads Ynddal" <mads@ynddal.dk>,
	"Daniel P. Berrangé" <berrange@redhat.com>,
	"Gerd Hoffmann" <kraxel@redhat.com>,
	"Stefan Berger" <stefanb@linux.vnet.ibm.com>,
	"Peter Xu" <peterx@redhat.com>,
	"Igor Mammedov" <imammedo@redhat.com>,
	"Cédric Le Goater" <clg@redhat.com>,
	"Jason Wang" <jasowang@redhat.com>,
	"Ani Sinha" <anisinha@redhat.com>,
	"Markus Armbruster" <armbru@redhat.com>,
	"Paolo Bonzini" <pbonzini@redhat.com>,
	"Peter Maydell" <peter.maydell@linaro.org>,
	qemu-block@nongnu.org, "Jiri Pirko" <jiri@resnulli.us>,
	"Alex Williamson" <alex.williamson@redhat.com>,
	"Kevin Wolf" <kwolf@redhat.com>, "Eric Blake" <eblake@redhat.com>,
	"John Snow" <jsnow@redhat.com>
Subject: [PATCH 08/13] qapi: ensure all errors sections are uniformly typset
Date: Tue, 18 Jun 2024 20:30:07 -0400	[thread overview]
Message-ID: <20240619003012.1753577-9-jsnow@redhat.com> (raw)
In-Reply-To: <20240619003012.1753577-1-jsnow@redhat.com>

Transactions have the only instance of an Errors section that isn't a
rST list; turn it into one.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 docs/devel/qapi-code-gen.rst | 7 +++++++
 qapi/transaction.json        | 2 +-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index f453bd35465..cee43222f19 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -1011,6 +1011,13 @@ like this::
 "Returns" and "Errors" sections are only valid for commands.  They
 document the success and the error response, respectively.
 
+"Errors" sections should be formatted as an rST list, each entry
+detailing a relevant error condition. For example::
+
+ # Errors:
+ #     - If @device does not exist, DeviceNotFound
+ #     - Any other error returns a GenericError.
+
 A "Since: x.y.z" tagged section lists the release that introduced the
 definition.
 
diff --git a/qapi/transaction.json b/qapi/transaction.json
index 5749c133d4a..07afc269d54 100644
--- a/qapi/transaction.json
+++ b/qapi/transaction.json
@@ -235,7 +235,7 @@
 #     additional detail.
 #
 # Errors:
-#     Any errors from commands in the transaction
+#     - Any errors from commands in the transaction
 #
 # Note: The transaction aborts on the first failure.  Therefore, there
 #     will be information on only one failed operation returned in an
-- 
2.44.0



  parent reply	other threads:[~2024-06-19  0:32 UTC|newest]

Thread overview: 53+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-19  0:29 [PATCH 00/13] qapi: convert "Note" and "Example" sections to rST John Snow
2024-06-19  0:30 ` [PATCH 01/13] [DO-NOT-MERGE]: Add some ad-hoc linting helpers John Snow
2024-06-19  0:30 ` [PATCH 02/13] qapi: linter fixups John Snow
2024-06-19  0:30 ` [PATCH 03/13] docs/qapidoc: delint a tiny portion of the module John Snow
2024-06-19  6:28   ` Markus Armbruster
2024-06-19 17:06     ` John Snow
2024-06-19  0:30 ` [PATCH 04/13] qapi/parser: preserve indentation in QAPIDoc sections John Snow
2024-06-19 12:03   ` Markus Armbruster
2024-06-20 14:47     ` John Snow
2024-06-20 15:07       ` Markus Armbruster
2024-06-20 15:14         ` John Snow
2024-06-21  6:38           ` Markus Armbruster
2024-06-21 17:28             ` John Snow
2024-06-22  8:48               ` Markus Armbruster
2024-06-19  0:30 ` [PATCH 05/13] qapi/parser: fix comment parsing immediately following a doc block John Snow
2024-06-19 12:04   ` Markus Armbruster
2024-06-19  0:30 ` [PATCH 06/13] docs/qapidoc: fix nested parsing under untagged sections John Snow
2024-06-19 12:05   ` Markus Armbruster
2024-06-19  0:30 ` [PATCH 07/13] qapi: fix non-compliant JSON examples John Snow
2024-06-19 12:07   ` Markus Armbruster
2024-06-19  0:30 ` John Snow [this message]
2024-06-19 12:10   ` [PATCH 08/13] qapi: ensure all errors sections are uniformly typset Markus Armbruster
2024-06-20 15:25     ` John Snow
2024-06-19  0:30 ` [PATCH 09/13] qapi: convert "Note" sections to plain rST John Snow
2024-06-19 12:49   ` Markus Armbruster
2024-06-20 13:35     ` Markus Armbruster
2024-06-20 15:46       ` John Snow
2024-06-20 18:44         ` John Snow
2024-06-21 12:23           ` Markus Armbruster
2024-06-21 17:41             ` John Snow
2024-06-22  8:52               ` Markus Armbruster
2024-06-20 15:39     ` John Snow
2024-06-21 10:20       ` Markus Armbruster
2024-06-19 13:07   ` Markus Armbruster
2024-06-20 15:40     ` John Snow
2024-06-21  6:39       ` Markus Armbruster
2024-06-20 13:54   ` Markus Armbruster
2024-06-20 15:52     ` John Snow
2024-06-21 12:08   ` Markus Armbruster
2024-06-21 17:33     ` John Snow
2024-06-19  0:30 ` [PATCH 10/13] qapi: update prose in note blocks John Snow
2024-06-19 12:18   ` Markus Armbruster
2024-06-19  0:30 ` [PATCH 11/13] qapi: add markup to " John Snow
2024-06-19 12:19   ` Markus Armbruster
2024-06-19  0:30 ` [PATCH 12/13] qapi/parser: don't parse rST markup as section headers John Snow
2024-06-19 12:55   ` Markus Armbruster
2024-06-19  0:30 ` [PATCH 13/13] qapi: convert "Example" sections to rST John Snow
2024-06-19 13:20   ` Markus Armbruster
2024-06-19 17:32     ` John Snow
2024-06-26  5:17   ` Markus Armbruster
2024-06-26 14:39     ` John Snow
2024-06-26  5:35 ` [PATCH 00/13] qapi: convert "Note" and " Markus Armbruster
2024-07-01 20:28 ` Michael S. Tsirkin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240619003012.1753577-9-jsnow@redhat.com \
    --to=jsnow@redhat.com \
    --cc=alex.williamson@redhat.com \
    --cc=anisinha@redhat.com \
    --cc=armbru@redhat.com \
    --cc=berrange@redhat.com \
    --cc=clg@redhat.com \
    --cc=eblake@redhat.com \
    --cc=eduardo@habkost.net \
    --cc=farosas@suse.de \
    --cc=hreitz@redhat.com \
    --cc=imammedo@redhat.com \
    --cc=jasowang@redhat.com \
    --cc=jiri@resnulli.us \
    --cc=kkostiuk@redhat.com \
    --cc=kraxel@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=lukasstraub2@web.de \
    --cc=mads@ynddal.dk \
    --cc=marcandre.lureau@redhat.com \
    --cc=marcel.apfelbaum@gmail.com \
    --cc=michael.roth@amd.com \
    --cc=mst@redhat.com \
    --cc=pavel.dovgaluk@ispras.ru \
    --cc=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=peterx@redhat.com \
    --cc=philmd@linaro.org \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanb@linux.vnet.ibm.com \
    --cc=stefanha@redhat.com \
    --cc=victortoso@redhat.com \
    --cc=wangyanan55@huawei.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).