[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 5/7] qapi: Fix mangled "Returns" sections in documentation
|
From: |
Markus Armbruster |
|
Subject: |
[PATCH 5/7] qapi: Fix mangled "Returns" sections in documentation |
|
Date: |
Sat, 20 Jan 2024 10:53:25 +0100 |
Commit e050e426782e (qapi: Use explicit bulleted lists) added list
markup to correct bad rendering:
A JSON block comment like this:
Returns: nothing on success
If @node is not a valid block device, DeviceNotFound
If @name is not found, GenericError with an explanation
renders like this:
Returns: nothing on success If node is not a valid block device,
DeviceNotFound If name is not found, GenericError with an explanation
because whitespace is not significant.
Use an actual bulleted list, so that the formatting is correct.
It missed a few instances. Commit a937b6aa739 (qapi: Reformat doc
comments to conform to current conventions) then reflowed them.
Revert the reflowing, and add list markup.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/net.json | 15 +++++++++------
qapi/qdev.json | 5 +++--
qapi/qom.json | 10 ++++++----
3 files changed, 18 insertions(+), 12 deletions(-)
diff --git a/qapi/net.json b/qapi/net.json
index 8095b68fa8..68493d6ac9 100644
--- a/qapi/net.json
+++ b/qapi/net.json
@@ -18,8 +18,9 @@
#
# @up: true to set the link status to be up
#
-# Returns: Nothing on success If @name is not a valid network device,
-# DeviceNotFound
+# Returns:
+# - Nothing on success
+# - If @name is not a valid network device, DeviceNotFound
#
# Since: 0.14
#
@@ -44,8 +45,9 @@
#
# Since: 0.14
#
-# Returns: Nothing on success If @type is not a valid network backend,
-# DeviceNotFound
+# Returns:
+# - Nothing on success
+# - If @type is not a valid network backend, DeviceNotFound
#
# Example:
#
@@ -64,8 +66,9 @@
#
# @id: the name of the network backend to remove
#
-# Returns: Nothing on success If @id is not a valid network backend,
-# DeviceNotFound
+# Returns:
+# - Nothing on success
+# - If @id is not a valid network backend, DeviceNotFound
#
# Since: 0.14
#
diff --git a/qapi/qdev.json b/qapi/qdev.json
index 6bc5a733b8..25bac5e611 100644
--- a/qapi/qdev.json
+++ b/qapi/qdev.json
@@ -89,8 +89,9 @@
#
# @id: the device's ID or QOM path
#
-# Returns: Nothing on success If @id is not a valid device,
-# DeviceNotFound
+# Returns:
+# - Nothing on success
+# - If @id is not a valid device, DeviceNotFound
#
# Notes: When this command completes, the device may not be removed
# from the guest. Hot removal is an operation that requires guest
diff --git a/qapi/qom.json b/qapi/qom.json
index 95516ba325..84af23fe24 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -1056,8 +1056,9 @@
#
# Create a QOM object.
#
-# Returns: Nothing on success Error if @qom-type is not a valid class
-# name
+# Returns:
+# - Nothing on success
+# - Error if @qom-type is not a valid class name
#
# Since: 2.0
#
@@ -1078,8 +1079,9 @@
#
# @id: the name of the QOM object to remove
#
-# Returns: Nothing on success Error if @id is not a valid id for a QOM
-# object
+# Returns:
+# - Nothing on success
+# - Error if @id is not a valid id for a QOM object
#
# Since: 2.0
#
--
2.43.0
- [PATCH 0/7] qapi qmp: Documentation fixes, Markus Armbruster, 2024/01/20
- [PATCH 2/7] docs: Replace dangling references to docs/interop/qmp-intro.txt, Markus Armbruster, 2024/01/20
- [PATCH 5/7] qapi: Fix mangled "Returns" sections in documentation,
Markus Armbruster <=
- [PATCH 3/7] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt, Markus Armbruster, 2024/01/20
- [PATCH 4/7] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref, Markus Armbruster, 2024/01/20
- [PATCH 1/7] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs, Markus Armbruster, 2024/01/20
- [PATCH 6/7] qapi: Indent tagged doc comment sections properly, Markus Armbruster, 2024/01/20
- [PATCH 7/7] qapi: Fix malformed "Since:" section tags (again), Markus Armbruster, 2024/01/20
- Re: [PATCH 0/7] qapi qmp: Documentation fixes, Eric Blake, 2024/01/25
- Re: [PATCH 0/7] qapi qmp: Documentation fixes, Markus Armbruster, 2024/01/26