From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Eric Blake" <eblake@redhat.com>
Subject: [PULL 8/8] qapi: Fix malformed "Since:" section tags (again)
Date: Fri, 26 Jan 2024 07:27:44 +0100 [thread overview]
Message-ID: <20240126062744.265588-9-armbru@redhat.com> (raw)
In-Reply-To: <20240126062744.265588-1-armbru@redhat.com>
"Since X.Y" is not recognized as a tagged section, and therefore not
formatted as such in generated documentation. Fix by adding the
required colon.
Previously fixed in commit 433a4fdc420 (qapi: Fix malformed "Since:"
section tags)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240120095327.666239-8-armbru@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Eric Blake <eblake@redhat.com>
---
qapi/block-core.json | 4 ++--
qapi/migration.json | 14 +++++++-------
2 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index ca390c5700..3919156d49 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1361,7 +1361,7 @@
# target, i.e. same data and new writes are done synchronously to
# both.
#
-# Since 8.2
+# Since: 8.2
##
{ 'struct': 'BlockJobInfoMirror',
'data': { 'actively-synced': 'bool' } }
@@ -3080,7 +3080,7 @@
#
# @type: The job type
#
-# Since 8.2
+# Since: 8.2
##
{ 'union': 'BlockJobChangeOptions',
'base': { 'id': 'str', 'type': 'JobType' },
diff --git a/qapi/migration.json b/qapi/migration.json
index eb2f883513..489b591c23 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1597,7 +1597,7 @@
#
# @file: Direct the migration stream to a file.
#
-# Since 8.2
+# Since: 8.2
##
{ 'enum': 'MigrationAddressType',
'data': [ 'socket', 'exec', 'rdma', 'file' ] }
@@ -1609,7 +1609,7 @@
#
# @offset: The file offset where the migration stream will start
#
-# Since 8.2
+# Since: 8.2
##
{ 'struct': 'FileMigrationArgs',
'data': { 'filename': 'str',
@@ -1620,7 +1620,7 @@
#
# @args: command (list head) and arguments to execute.
#
-# Since 8.2
+# Since: 8.2
##
{ 'struct': 'MigrationExecCommand',
'data': {'args': [ 'str' ] } }
@@ -1630,7 +1630,7 @@
#
# Migration endpoint configuration.
#
-# Since 8.2
+# Since: 8.2
##
{ 'union': 'MigrationAddress',
'base': { 'transport' : 'MigrationAddressType'},
@@ -1648,7 +1648,7 @@
#
# @main: Main outbound migration channel.
#
-# Since 8.1
+# Since: 8.1
##
{ 'enum': 'MigrationChannelType',
'data': [ 'main' ] }
@@ -1662,7 +1662,7 @@
#
# @addr: Migration endpoint configuration on destination interface.
#
-# Since 8.1
+# Since: 8.1
##
{ 'struct': 'MigrationChannel',
'data': {
@@ -2126,7 +2126,7 @@
#
# @millisecond: value is in milliseconds
#
-# Since 8.2
+# Since: 8.2
#
##
{ 'enum': 'TimeUnit',
--
2.43.0
next prev parent reply other threads:[~2024-01-26 6:29 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-26 6:27 [PULL 0/8] QAPI patches patches for 2024-01-26 Markus Armbruster
2024-01-26 6:27 ` [PULL 1/8] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind' Markus Armbruster
2024-01-26 6:27 ` [PULL 2/8] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs Markus Armbruster
2024-01-26 6:27 ` [PULL 3/8] docs: Replace dangling references to docs/interop/qmp-intro.txt Markus Armbruster
2024-01-26 6:27 ` [PULL 4/8] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt Markus Armbruster
2024-01-26 6:27 ` [PULL 5/8] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref Markus Armbruster
2024-01-26 6:27 ` [PULL 6/8] qapi: Fix mangled "Returns" sections in documentation Markus Armbruster
2024-01-26 6:27 ` [PULL 7/8] qapi: Indent tagged doc comment sections properly Markus Armbruster
2024-01-26 6:27 ` Markus Armbruster [this message]
2024-01-26 13:10 ` [PULL 0/8] QAPI patches patches for 2024-01-26 Peter Maydell
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=20240126062744.265588-9-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
/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).