Adds the .. qapi:struct:: directive, object, and :qapi:struct:`name`
cross-referencing role.
As per usual, QAPI cross-referencing for types in the member field list
will be added in a forthcoming commit.
RFC Note: The "?" syntax sneaks into the example document again. Please
ignore that for now.
Signed-off-by: John Snow <js...@redhat.com>
---
docs/qapi/index.rst | 16 ++++++++++++++++
docs/sphinx/qapi-domain.py | 9 +++++++++
2 files changed, 25 insertions(+)
diff --git a/docs/qapi/index.rst b/docs/qapi/index.rst
index d81bccfb06a..b07e6e9e2e3 100644
--- a/docs/qapi/index.rst
+++ b/docs/qapi/index.rst
@@ -174,3 +174,19 @@ Explicit cross-referencing syntax for QAPI modules is
available with
"microseconds": 959568
}
}
+
+.. qapi:struct:: BackupPerf
+ :since: 6.0
+
+ Optional parameters for backup. These parameters don't affect
+ functionality, but may significantly affect performance.
+
+ :memb bool? use-copy-range: Use copy offloading. Default false.
+ :memb int? max-workers: Maximum number of parallel requests for the
+ sustained background copying process. Doesn't influence
+ copy-before-write operations. Default 64.
+ :memb int64? max-chunk: Maximum request length for the sustained
+ background copying process. Doesn't influence copy-before-write
+ operations. 0 means unlimited. If max-chunk is non-zero then it
+ should not be less than job cluster size which is calculated as
+ maximum of target image cluster size and 64k. Default 0.
diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py
index 74dc578b3c7..b46faeaceef 100644
--- a/docs/sphinx/qapi-domain.py
+++ b/docs/sphinx/qapi-domain.py
@@ -343,6 +343,12 @@ class QAPIEvent(QAPIObjectWithMembers):
pass
+class QAPIStruct(QAPIObjectWithMembers):
+ """Description of a QAPI Struct."""
+
+ pass
+
+
class QAPIModule(SphinxDirective):
"""
Directive to mark description of a new module.
@@ -497,6 +503,7 @@ class QAPIDomain(Domain):
"command": ObjType(_("command"), "cmd", "obj"),
"event": ObjType(_("event"), "event", "obj"),
"enum": ObjType(_("enum"), "enum", "obj", "type"),
+ "struct": ObjType(_("struct"), "struct", "obj", "type"),
"alternate": ObjType(_("alternate"), "alt", "obj", "type"),
}
@@ -507,6 +514,7 @@ class QAPIDomain(Domain):
"command": QAPICommand,
"event": QAPIEvent,
"enum": QAPIEnum,
+ "struct": QAPIStruct,
"alternate": QAPIAlternate,
}
@@ -518,6 +526,7 @@ class QAPIDomain(Domain):
"cmd": QAPIXRefRole(),
"event": QAPIXRefRole(),
"enum": QAPIXRefRole(),
+ "struct": QAPIXRefRole(),
"alt": QAPIXRefRole(),
"type": QAPIXRefRole(), # reference any data type (excludes modules,
commands, events)
"obj": QAPIXRefRole(), # reference *any* type of QAPI object.
--
2.44.0
