From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: richard.henderson@linaro.org,
"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: [PULL 12/17] qapi: Fix argument documentation markup
Date: Fri, 28 Apr 2023 12:28:56 +0200 [thread overview]
Message-ID: <20230428102901.1685375-13-armbru@redhat.com> (raw)
In-Reply-To: <20230428102901.1685375-1-armbru@redhat.com>
Member / argument documentation of BlockdevAmendOptionsQcow2,
job-resume, and RDMA_GID_STATUS_CHANGED is parsed as ordinary text due
to missing colon or space before the colon. The generated
documentation shows these members / arguments as "Not documented".
The fix is obvious: add missing colons, delete extra spaces.
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>
Message-Id: <20230425064223.820979-13-armbru@redhat.com>
---
qapi/block-core.json | 2 +-
qapi/job.json | 2 +-
qapi/rdma.json | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 2382772e17..9dd5ed9a47 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -5155,7 +5155,7 @@
# Driver specific image amend options for qcow2.
# For now, only encryption options can be amended
#
-# @encrypt Encryption options to be amended
+# @encrypt: Encryption options to be amended
#
# Since: 5.1
##
diff --git a/qapi/job.json b/qapi/job.json
index d5f84e9615..bc4104757a 100644
--- a/qapi/job.json
+++ b/qapi/job.json
@@ -148,7 +148,7 @@
# This command returns immediately after resuming a paused job. Resuming an
# already running job is an error.
#
-# @id : The job identifier.
+# @id: The job identifier.
#
# Since: 3.0
##
diff --git a/qapi/rdma.json b/qapi/rdma.json
index a1d2175a8b..5b6b66afa4 100644
--- a/qapi/rdma.json
+++ b/qapi/rdma.json
@@ -17,7 +17,7 @@
#
# @subnet-prefix: Subnet Prefix
#
-# @interface-id : Interface ID
+# @interface-id: Interface ID
#
# Since: 4.0
#
--
2.39.2
next prev parent reply other threads:[~2023-04-28 10:31 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-28 10:28 [PULL 00/17] QAPI patches patches for 2023-04-28 Markus Armbruster
2023-04-28 10:28 ` [PULL 01/17] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status Markus Armbruster
2023-04-28 10:28 ` [PULL 02/17] qga/qapi-schema: Fix a misspelled reference Markus Armbruster
2023-04-28 10:28 ` [PULL 03/17] qapi: Fix misspelled references Markus Armbruster
2023-04-28 10:28 ` [PULL 04/17] qapi: Fix up references to long gone error classes Markus Armbruster
2023-04-28 10:28 ` [PULL 05/17] qapi/block-core: Clean up after removal of dirty bitmap @status Markus Armbruster
2023-04-28 10:28 ` [PULL 06/17] qapi: @foo should be used to reference, not ``foo`` Markus Armbruster
2023-04-28 10:28 ` [PULL 07/17] qapi: Tidy up examples Markus Armbruster
2023-04-28 10:28 ` [PULL 08/17] qapi: Delete largely misleading "Stability Considerations" Markus Armbruster
2023-04-28 10:28 ` [PULL 09/17] qapi: Fix bullet list markup in documentation Markus Armbruster
2023-04-28 10:28 ` [PULL 10/17] qapi: Fix unintended definition lists " Markus Armbruster
2023-04-28 10:28 ` [PULL 11/17] qga/qapi-schema: Fix member documentation markup Markus Armbruster
2023-04-28 10:28 ` Markus Armbruster [this message]
2023-04-28 10:28 ` [PULL 13/17] qapi: Replace ad hoc "since" documentation by member documentation Markus Armbruster
2023-04-28 10:28 ` [PULL 14/17] qapi: Fix misspelled section tags in doc comments Markus Armbruster
2023-04-28 10:28 ` [PULL 15/17] qapi: Format since information the conventional way: (since X.Y) Markus Armbruster
2023-04-28 10:29 ` [PULL 16/17] qapi storage-daemon/qapi: Fix documentation section structure Markus Armbruster
2023-04-28 10:29 ` [PULL 17/17] docs/devel/qapi-code-gen: Describe some doc markup pitfalls Markus Armbruster
2023-04-29 9:04 ` [PULL 00/17] QAPI patches patches for 2023-04-28 Richard Henderson
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=20230428102901.1685375-13-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=richard.henderson@linaro.org \
--cc=vsementsov@yandex-team.ru \
/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).