Skip to contentSkip to conversation

qapi: Fix malformed "Since:" section tags

PATCH In review Markus Armbruster 2 participants 3 messages Apr 22, 2022 – May 2, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 qapi: Fix malformed "Since:" section tags

"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.

---
 qapi/crypto.json     | 3 +--
 qapi/machine.json    | 2 +-
 qapi/misc.json       | 2 +-
 qga/qapi-schema.json | 2 +-
 4 files changed, 4 insertions(+), 5 deletions(-)
qapi/crypto.json +1 -2
index 1ec54c15ca..8e0b4764e5 100644
@@ -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',
qapi/machine.json +1 -1
index d25a481ce4..84b7fd7c28 100644
@@ -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',
qapi/misc.json +1 -1
index b83cc39029..f8a9feda30 100644
@@ -188,7 +188,7 @@
 # Features:
 # @unstable: This command is experimental.
 #
-# Since 3.0
+# Since: 3.0
 #
 # Returns: nothing
 #
qga/qapi-schema.json +1 -1
index 94e4aacdcc..1812823d88 100644
@@ -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'],
Signature · 1 line
2.35.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 11 lines · Markus Armbruster

"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.

---
 qapi/crypto.json     | 3 +--
 qapi/machine.json    | 2 +-
 qapi/misc.json       | 2 +-
 qga/qapi-schema.json | 2 +-
 4 files changed, 4 insertions(+), 5 deletions(-)
Signature · 1 line
Andrea Bolognani / Red Hat / Virtualization