From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: eduardo@habkost.net, berrange@redhat.com, michael.roth@amd.com,
f4bug@amsat.org, wangyanan55@huawei.com, eblake@redhat.com
Subject: [PATCH] qapi: Fix malformed "Since:" section tags
Date: Fri, 22 Apr 2022 15:28:07 +0200 [thread overview]
Message-ID: <20220422132807.1704411-1-armbru@redhat.com> (raw)
"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.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/crypto.json | 3 +--
qapi/machine.json | 2 +-
qapi/misc.json | 2 +-
qga/qapi-schema.json | 2 +-
4 files changed, 4 insertions(+), 5 deletions(-)
diff --git a/qapi/crypto.json b/qapi/crypto.json
index 1ec54c15ca..8e0b4764e5 100644
--- a/qapi/crypto.json
+++ b/qapi/crypto.json
@@ -357,8 +357,7 @@
# password to use to retrieve current master key.
# Defaults to the same secret that was used to open the image
#
-#
-# Since 5.1
+# Since: 5.1
##
{ 'struct': 'QCryptoBlockAmendOptionsLUKS',
'data': { 'state': 'QCryptoBlockLUKSKeyslotState',
diff --git a/qapi/machine.json b/qapi/machine.json
index d25a481ce4..84b7fd7c28 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -970,7 +970,7 @@
# preconfigure stage to configure numa mapping before initializing
# machine.
#
-# Since 3.0
+# Since: 3.0
##
{ 'command': 'set-numa-node', 'boxed': true,
'data': 'NumaOptions',
diff --git a/qapi/misc.json b/qapi/misc.json
index b83cc39029..f8a9feda30 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -188,7 +188,7 @@
# Features:
# @unstable: This command is experimental.
#
-# Since 3.0
+# Since: 3.0
#
# Returns: nothing
#
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 94e4aacdcc..1812823d88 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -899,7 +899,7 @@
# @alias: optional alias assigned to the disk, on Linux this is a name assigned
# by device mapper
#
-# Since 5.2
+# Since: 5.2
##
{ 'struct': 'GuestDiskInfo',
'data': {'name': 'str', 'partition': 'bool', '*dependencies': ['str'],
--
2.35.1
next reply other threads:[~2022-04-22 13:38 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-22 13:28 Markus Armbruster [this message]
2022-04-22 18:06 ` [PATCH] qapi: Fix malformed "Since:" section tags Andrea Bolognani
2022-05-02 12:38 ` Markus Armbruster
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=20220422132807.1704411-1-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=f4bug@amsat.org \
--cc=michael.roth@amd.com \
--cc=qemu-devel@nongnu.org \
--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).