mirror of https://github.com/xemu-project/xemu.git
qapi: Fix dangling references to docs/devel/qapi-code-gen.txt
Conversion of docs/devel/qapi-code-gen.txt to ReST left several
dangling references behind. Fix them to point to
docs/devel/qapi-code-gen.rst.
Fixes: f7aa076dbd
(docs: convert qapi-code-gen.txt to ReST)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240120095327.666239-4-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
parent
3bc8dc8aa8
commit
b0b1313eb2
|
@ -8,7 +8,7 @@ This document doesn't discuss QMP protocol level details, nor does it dive
|
||||||
into the QAPI framework implementation.
|
into the QAPI framework implementation.
|
||||||
|
|
||||||
For an in-depth introduction to the QAPI framework, please refer to
|
For an in-depth introduction to the QAPI framework, please refer to
|
||||||
docs/devel/qapi-code-gen.txt. For the QMP protocol, see the
|
:doc:`qapi-code-gen`. For the QMP protocol, see the
|
||||||
:doc:`/interop/qmp-spec`.
|
:doc:`/interop/qmp-spec`.
|
||||||
|
|
||||||
New commands may be implemented in QMP only. New HMP commands should be
|
New commands may be implemented in QMP only. New HMP commands should be
|
||||||
|
|
|
@ -39,7 +39,7 @@
|
||||||
* limitations; see the documentation for each visitor for more
|
* limitations; see the documentation for each visitor for more
|
||||||
* details on what it supports. Also, see visitor-impl.h for the
|
* details on what it supports. Also, see visitor-impl.h for the
|
||||||
* callback contracts implemented by each visitor, and
|
* callback contracts implemented by each visitor, and
|
||||||
* docs/devel/qapi-code-gen.txt for more about the QAPI code
|
* docs/devel/qapi-code-gen.rst for more about the QAPI code
|
||||||
* generator.
|
* generator.
|
||||||
*
|
*
|
||||||
* All of the visitors are created via:
|
* All of the visitors are created via:
|
||||||
|
|
|
@ -45,7 +45,7 @@ void yank_unregister_instance(const YankInstance *instance);
|
||||||
* yank_register_function: Register a yank function
|
* yank_register_function: Register a yank function
|
||||||
*
|
*
|
||||||
* This registers a yank function. All limitations of qmp oob commands apply
|
* This registers a yank function. All limitations of qmp oob commands apply
|
||||||
* to the yank function as well. See docs/devel/qapi-code-gen.txt under
|
* to the yank function as well. See docs/devel/qapi-code-gen.rst under
|
||||||
* "An OOB-capable command handler must satisfy the following conditions".
|
* "An OOB-capable command handler must satisfy the following conditions".
|
||||||
*
|
*
|
||||||
* This function is thread-safe.
|
* This function is thread-safe.
|
||||||
|
|
|
@ -260,8 +260,8 @@
|
||||||
# Additional SchemaInfo members for meta-type 'alternate'.
|
# Additional SchemaInfo members for meta-type 'alternate'.
|
||||||
#
|
#
|
||||||
# @members: the alternate type's members, in no particular order. The
|
# @members: the alternate type's members, in no particular order. The
|
||||||
# members' wire encoding is distinct, see
|
# members' wire encoding is distinct, see :doc:`qapi-code-gen`
|
||||||
# docs/devel/qapi-code-gen.txt section Alternate types.
|
# section Alternate types.
|
||||||
#
|
#
|
||||||
# On the wire, this can be any of the members.
|
# On the wire, this can be any of the members.
|
||||||
#
|
#
|
||||||
|
|
|
@ -112,7 +112,7 @@ bool qapi_bool_parse(const char *name, const char *value, bool *obj, Error **err
|
||||||
* It may be prefixed by __RFQDN_ (downstream extension), where RFQDN
|
* It may be prefixed by __RFQDN_ (downstream extension), where RFQDN
|
||||||
* may contain only letters, digits, hyphen and period.
|
* may contain only letters, digits, hyphen and period.
|
||||||
* The special exception for enumeration names is not implemented.
|
* The special exception for enumeration names is not implemented.
|
||||||
* See docs/devel/qapi-code-gen.txt for more on QAPI naming rules.
|
* See docs/devel/qapi-code-gen.rst for more on QAPI naming rules.
|
||||||
* Keep this consistent with scripts/qapi-gen.py!
|
* Keep this consistent with scripts/qapi-gen.py!
|
||||||
* If @complete, the parse fails unless it consumes @str completely.
|
* If @complete, the parse fails unless it consumes @str completely.
|
||||||
* Return its length on success, -1 on failure.
|
* Return its length on success, -1 on failure.
|
||||||
|
|
|
@ -71,7 +71,7 @@ class QAPISchemaParser:
|
||||||
Parse QAPI schema source.
|
Parse QAPI schema source.
|
||||||
|
|
||||||
Parse a JSON-esque schema file and process directives. See
|
Parse a JSON-esque schema file and process directives. See
|
||||||
qapi-code-gen.txt section "Schema Syntax" for the exact syntax.
|
qapi-code-gen.rst section "Schema Syntax" for the exact syntax.
|
||||||
Grammatical validation is handled later by `expr.check_exprs()`.
|
Grammatical validation is handled later by `expr.check_exprs()`.
|
||||||
|
|
||||||
:param fname: Source file name.
|
:param fname: Source file name.
|
||||||
|
|
|
@ -35,7 +35,7 @@ typedef struct YankInstanceEntry YankInstanceEntry;
|
||||||
/*
|
/*
|
||||||
* This lock protects the yank_instance_list below. Because it's taken by
|
* This lock protects the yank_instance_list below. Because it's taken by
|
||||||
* OOB-capable commands, it must be "fast", i.e. it may only be held for a
|
* OOB-capable commands, it must be "fast", i.e. it may only be held for a
|
||||||
* bounded, short time. See docs/devel/qapi-code-gen.txt for additional
|
* bounded, short time. See docs/devel/qapi-code-gen.rst for additional
|
||||||
* information.
|
* information.
|
||||||
*/
|
*/
|
||||||
static QemuMutex yank_lock;
|
static QemuMutex yank_lock;
|
||||||
|
|
Loading…
Reference in New Issue