[PATCH] qapi: Fix malformed "Since:" section tags

[PATCH] qapi: Fix malformed "Since:" section tags

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

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

Re: [PATCH] qapi: Fix malformed "Since:" section tags

[Andrea Bolognani]

On Fri, Apr 22, 2022 at 03:28:07PM +0200, Markus Armbruster wrote:
> "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(-)

Reviewed-by: Andrea Bolognani <abologna@redhat.com>

-- 
Andrea Bolognani / Red Hat / Virtualization

Re: [PATCH] qapi: Fix malformed "Since:" section tags

[Markus Armbruster]

Markus Armbruster <armbru@redhat.com> writes:

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

Queued.