[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 14/17] qapi: Fix misspelled section tags in doc comments
From: |
Markus Armbruster |
Subject: |
[PULL 14/17] qapi: Fix misspelled section tags in doc comments |
Date: |
Fri, 28 Apr 2023 12:28:58 +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>
Message-Id: <20230425064223.820979-15-armbru@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 015b22c970..82000adce4 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1963,7 +1963,7 @@
#
# data: migration thread name
#
-# returns: information about migration threads
+# Returns: information about migration threads
#
# Since: 7.2
##
--
2.39.2
- [PULL 12/17] qapi: Fix argument documentation markup, (continued)
- [PULL 12/17] qapi: Fix argument documentation markup, Markus Armbruster, 2023/04/28
- [PULL 06/17] qapi: @foo should be used to reference, not ``foo``, Markus Armbruster, 2023/04/28
- [PULL 09/17] qapi: Fix bullet list markup in documentation, Markus Armbruster, 2023/04/28
- [PULL 03/17] qapi: Fix misspelled references, Markus Armbruster, 2023/04/28
- [PULL 01/17] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status, Markus Armbruster, 2023/04/28
- [PULL 15/17] qapi: Format since information the conventional way: (since X.Y), Markus Armbruster, 2023/04/28
- [PULL 05/17] qapi/block-core: Clean up after removal of dirty bitmap @status, Markus Armbruster, 2023/04/28
- [PULL 13/17] qapi: Replace ad hoc "since" documentation by member documentation, Markus Armbruster, 2023/04/28
- [PULL 16/17] qapi storage-daemon/qapi: Fix documentation section structure, Markus Armbruster, 2023/04/28
- [PULL 08/17] qapi: Delete largely misleading "Stability Considerations", Markus Armbruster, 2023/04/28
- [PULL 14/17] qapi: Fix misspelled section tags in doc comments,
Markus Armbruster <=
- [PULL 07/17] qapi: Tidy up examples, Markus Armbruster, 2023/04/28
- [PULL 02/17] qga/qapi-schema: Fix a misspelled reference, Markus Armbruster, 2023/04/28
- [PULL 11/17] qga/qapi-schema: Fix member documentation markup, Markus Armbruster, 2023/04/28
- [PULL 17/17] docs/devel/qapi-code-gen: Describe some doc markup pitfalls, Markus Armbruster, 2023/04/28
- [PULL 10/17] qapi: Fix unintended definition lists in documentation, Markus Armbruster, 2023/04/28
- Re: [PULL 00/17] QAPI patches patches for 2023-04-28, Richard Henderson, 2023/04/29