The blurb about @foo style references in qapi-code-gen.rst is out of date now, update it.
Signed-off-by: John Snow <js...@redhat.com> --- docs/devel/qapi-code-gen.rst | 11 ++++++++--- docs/devel/qapi-domain.rst | 1 + 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index dfdbeac5a5a..51993a6eb0c 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -943,9 +943,14 @@ The usual ****strong****, *\*emphasized\** and ````literal```` markup should be used. If you need a single literal ``*``, you will need to backslash-escape it. -Use ``@foo`` to reference a name in the schema. This is an rST -extension. It is rendered the same way as ````foo````, but carries -additional meaning. +Use ```foo``` to reference a name in the schema and generate a +cross-reference link. In the event that a cross-reference is ambiguous +and the manual compilation fails, `QAPI cross-reference roles +<QAPI-XREF>` can be used to narrow the cross-reference results. + +Use ``@foo`` to reference members, which do not currently have a +cross-reference target. This is an rST extension. It is rendered the +same way as ````foo````, but carries additional meaning. Example:: diff --git a/docs/devel/qapi-domain.rst b/docs/devel/qapi-domain.rst index b71890f6609..8d9fc866bc3 100644 --- a/docs/devel/qapi-domain.rst +++ b/docs/devel/qapi-domain.rst @@ -375,6 +375,7 @@ Will allow you to add arbitrary field lists in QAPI directives:: :see also: Lorem ipsum, dolor sit amet ... +.. _QAPI-XREF: Cross-references ================ -- 2.50.1