[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 14/16] qapi: Fix misspelled section tags in doc comments
From: |
Markus Armbruster |
Subject: |
[PATCH v2 14/16] qapi: Fix misspelled section tags in doc comments |
Date: |
Tue, 25 Apr 2023 08:42:21 +0200 |
Section tags are case sensitive and end with a colon. Screwing up
either gets them interpreted as ordinary paragraph. Fix a few.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
---
qapi/machine.json | 4 ++--
qapi/migration.json | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 5a18913767..fcd69965e5 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -517,7 +517,7 @@
# @targets: Target root bridge IDs from -device ...,id=<ID> for each root
# bridge.
#
-# Since 7.1
+# Since: 7.1
##
{ 'struct': 'CXLFixedMemoryWindowOptions',
'data': {
@@ -532,7 +532,7 @@
#
# @cxl-fmw: List of CXLFixedMemoryWindowOptions
#
-# Since 7.1
+# Since: 7.1
##
{ 'struct' : 'CXLFMWProperties',
'data': { 'cxl-fmw': ['CXLFixedMemoryWindowOptions'] }
diff --git a/qapi/migration.json b/qapi/migration.json
index 477ee4d35b..1b6c7b19e4 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1991,7 +1991,7 @@
#
# data: migration thread name
#
-# returns: information about migration threads
+# Returns: information about migration threads
#
# Since: 7.2
##
--
2.39.2
- [PATCH v2 00/16] qapi qga/qapi-schema: Doc fixes, Markus Armbruster, 2023/04/25
- [PATCH v2 04/16] qapi: Fix up references to long gone error classes, Markus Armbruster, 2023/04/25
- [PATCH v2 02/16] qga/qapi-schema: Fix a misspelled reference, Markus Armbruster, 2023/04/25
- [PATCH v2 07/16] qapi: Tidy up examples, Markus Armbruster, 2023/04/25
- [PATCH v2 08/16] qapi: Delete largely misleading "Stability Considerations", Markus Armbruster, 2023/04/25
- [PATCH v2 14/16] qapi: Fix misspelled section tags in doc comments,
Markus Armbruster <=
- [PATCH v2 10/16] qapi: Fix unintended definition lists in documentation, Markus Armbruster, 2023/04/25
- [PATCH v2 13/16] qapi: Replace ad hoc "since" documentation by member documentation, Markus Armbruster, 2023/04/25
- [PATCH v2 11/16] qga/qapi-schema: Fix member documentation markup, Markus Armbruster, 2023/04/25
- [PATCH v2 09/16] qapi: Fix bullet list markup in documentation, Markus Armbruster, 2023/04/25
- [PATCH v2 03/16] qapi: Fix misspelled references, Markus Armbruster, 2023/04/25
- [PATCH v2 05/16] qapi/block-core: Clean up after removal of dirty bitmap @status, Markus Armbruster, 2023/04/25
- [PATCH v2 01/16] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status, Markus Armbruster, 2023/04/25