docs/devel/qapi-domain.rst

8 ``docs/sphinx/qapi_domain.py``. This extension is analogous to the
19 language. By itself, this QAPI extension is only sufficient to parse rST
28 domain is quite handy. This reference may also be useful as a guide for
68 example, add cross-references. The QAPI Domain takes advantage of this
84 This is used primarily for entries which are not expected to be
86 domain uses this class for "Errors" section.
98 This is used for entries which are expected to be repeated, but aren't
100 without types. The QAPI domain uses this class for features, returns,
114 This is used for entries that are expected to be repeated and will have
115 a name, a type, and a description. The QAPI domain uses this class for
127 :availability: This field list is available in the body of Command,
152 :availability: This field list is only available in the body of the
166       This command returns immediately after marking the active job for
183 :availability: This field list is only available in the body of the
200       This command can only be issued when there is an active block job.
204       :arg string device: The job identifier.  This used to be a device
210           - If no background operation is active on this device,
219 :availability: This field list is only available in the body of the
250 :availability: This field list is only available in the body of the Enum
263       :value GenericError: this is used for errors that don't require a specific
264           error class.  This should be the default case for most errors
277 :availability: This field list is only available in the body of the
284 addition to the type, even though this information is not visible on the
285 wire in the QMP protocol format. This limitation *may* be lifted at a
293       This is a string value or the explicit lack of a string (null
306 :availability: This field list is available in the body of Event or
312 This is fundamentally the same as ``:arg:`` and ``:alt:``, but uses the
371 * ``:qapi:type:`BlockDirtyInfo``` -- Reference *any* QAPI type; this
431 This allows for efficient cross-referencing with a minimum of syntax in
454 various QAPI/QMP entities. The syntax is plain rST, and follows this
475 * ``:no-index:`` and ``:noindex:`` -- Do not add this item into the
477 * ``no-index-entry:`` and ``:noindexentry:`` -- Do not add this item
479 * ``no-contents-entry`` and ``:nocontentsentry:`` -- Exclude this item
491 * ``:namespace: name`` -- This option allows you to override the
493 * ``:module: modname`` -- Borrowed from the Python domain, this option allows
501   advertises that this definition is deprecated and should be avoided.
503   advertises that this definition is unstable and should not be used in
512 directives are associated with the most recent namespace. This affects
516 This directive also influences how reference resolution works for any
517 references that do not explicitly specify a namespace, so this directive
526 This directive has no visible effect.
534 are associated with the most recent module; this effects their "fully
554 This directive documents a QMP command. It may use any of the standard
565      This command is fake, so it can't hurt you!
579      This command is fake, so it can't hurt you!
589 This directive documents a QMP event. It may use any of the standard
599      This event is emitted when your computer is *extremely* ruined.
613    This event is emitted when your computer is *extremely* ruined.
624 This directive documents a QAPI enum. It may use any of the standard
633      This enum represents your virtual machine's current mood!
646    This enum represents your virtual machine's current mood!
657 This directive documents a QAPI structure or union and represents a QMP
666      This object has a bunch of disparate and unrelated things in it.
679    This object has a bunch of disparate and unrelated things in it.
691 This directive documents a QAPI alternate. It may use any of the
699      This alternate represents an Error Code from the VM.
711    This alternate represents an Error Code from the VM.