qapi: Fix misspelled section tags in doc comments

[PATCH] qapi: Fix misspelled section tags in doc comments

Markus Armbruster posted 1 patch 3 weeks, 4 days ago

Download mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20260701061136.798815-1-armbru@redhat.com

Maintainers: Eric Blake <eblake@redhat.com>, Markus Armbruster <armbru@redhat.com>, "Philippe Mathieu-Daudé" <philmd@mailo.com>, Zhao Liu <zhao1.liu@intel.com>, Paolo Bonzini <pbonzini@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>

qapi/machine-common.json | 2 +-
qapi/qom.json            | 6 +++---
2 files changed, 4 insertions(+), 4 deletions(-)

Expand all Fold all

[PATCH] qapi: Fix misspelled section tags in doc comments

Posted by Markus Armbruster 3 weeks, 4 days ago

Section tags are case sensitive and end with a colon.  Screwing up
either gets them interpreted as ordinary paragraph.  Fix a few.

Fixes: 4e88e7e340 (qapi/qom: Define cache enumeration and properties for machine, 2024-11-01)
Fixes: 8eb6d39e22 (qom: qom-list-get, 2025-07-11)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/machine-common.json | 2 +-
 qapi/qom.json            | 6 +++---
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/qapi/machine-common.json b/qapi/machine-common.json
index 92e84dfb14..aca98e994a 100644
--- a/qapi/machine-common.json
+++ b/qapi/machine-common.json
@@ -108,7 +108,7 @@
 #
 # @caches: the list of `SmpCacheProperties`.
 #
-# Since 9.2
+# Since: 9.2
 ##
 { 'struct': 'SmpCachePropertiesWrapper',
   'data': { 'caches': ['SmpCacheProperties'] } }
diff --git a/qapi/qom.json b/qapi/qom.json
index dd45ac1087..18e05f81df 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -58,7 +58,7 @@
 # @value: the value of the property.  Absent when the property cannot
 #     be read.
 #
-# Since 10.1
+# Since: 10.1
 ##
 { 'struct': 'ObjectPropertyValue',
   'data': { 'name': 'str',
@@ -70,7 +70,7 @@
 #
 # @properties: a list of properties.
 #
-# Since 10.1
+# Since: 10.1
 ##
 { 'struct': 'ObjectPropertiesValues',
   'data': { 'properties': [ 'ObjectPropertyValue' ] }}
@@ -167,7 +167,7 @@
 # Returns: A list where each element is the result for the
 #     corresponding element of @paths.
 #
-# Since 10.1
+# Since: 10.1
 ##
 { 'command': 'qom-list-get',
   'data': { 'paths': [ 'str' ] },
-- 
2.54.0

Re: [PATCH] qapi: Fix misspelled section tags in doc comments

Posted by Philippe Mathieu-Daudé 3 weeks, 4 days ago

On 1/7/26 08:11, Markus Armbruster wrote:
> Section tags are case sensitive and end with a colon.  Screwing up
> either gets them interpreted as ordinary paragraph.  Fix a few.
> 
> Fixes: 4e88e7e340 (qapi/qom: Define cache enumeration and properties for machine, 2024-11-01)
> Fixes: 8eb6d39e22 (qom: qom-list-get, 2025-07-11)
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   qapi/machine-common.json | 2 +-
>   qapi/qom.json            | 6 +++---
>   2 files changed, 4 insertions(+), 4 deletions(-)

Reviewed-by: Philippe Mathieu-Daudé <philmd@oss.qualcomm.com>