docs/devel/qapi-domain.rst

30 these forms will not be needed for documentation writing purposes,
31 understanding the cross-referencing syntax *will* be helpful when
78   * Creates an ungrouped field: i.e., each entry will create its own
79     section and they will not be combined.
89   * Creates a grouped field: i.e. multiple adjacent entries will be
90     merged into one section, and the content will form a bulleted list.
96   * All items will be generated with the form: "argument -- body"
104   * Creates a grouped, typed field. Multiple adjacent entres will be
105     merged into one section, and the content will form a bulleted list.
112   * All items will be generated with the form "name (type) -- body"
114 This is used for entries that are expected to be repeated and will have
117 below, They must be a valid, documented type that will be
169       The job will pause as soon as possible, which means transitioning
171       READY.  The corresponding JOB_STATUS_CHANGE event will be emitted.
341 Will allow you to add arbitrary field lists in QAPI directives::
363 * ``:qapi:mod:`block-core``` -- Reference a QAPI module. The link will
386 will apply only to the type name between the brackets. For example;
391 can be suffixed with ``?``. The cross-reference will be transformed to
408   ``:qapi:type:`QMP:block-core.BitmapSyncMode``` will render to:
412   will render to: :qapi:type:`~QMP:block-core.BitmapSyncMode`
423 When absent, their value will be inferred from context by the presence
428 namespaces/modules will be searched as a last resort; but any explicitly
446 <block-dirty-bitmap-merge>``` will render as: :qapi:cmd:`Merge dirty
472 undashed spellings are currently retained as aliases, but will be
543 Will be rendered as:
572 Will be rendered as:
603      :feat sadness: When present, the diagnostic message will also
606 Will be rendered as:
617    :feat sadness: When present, the diagnostic message will also explain
640 Will be rendered as:
674 Will be rendered as:
706 Will be rendered as: