This patch demonstrates what happens when you mess up a field list
entry. The next patch adds a safeguard against this.
Signed-off-by: John Snow <js...@redhat.com>
---
docs/qapi/index.rst | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/docs/qapi/index.rst b/docs/qapi/index.rst
index c68e2044890..5bb1c37a5ed 100644
--- a/docs/qapi/index.rst
+++ b/docs/qapi/index.rst
@@ -129,6 +129,10 @@ Explicit cross-referencing syntax for QAPI modules is
available with
argument values. It's very temperamental.
:return SomeTypeName: An esoteric collection of mystical nonsense to
both confound and delight.
+ :arg: this is malformed.
+ :memb: this is malformed and unrecognized.
+ :choice type name: This is unrecognized.
+ :errors FooError: Also malformed.
Field lists can appear anywhere in the directive block, but any field
list entries in the same list block that are recognized as special
--
2.44.0
