Add some XRef markup that links to the "tagged section" subsection. I don't know if we want to keep that section, so these cross-reference additions are isolated here.
Signed-off-by: John Snow <[email protected]> --- docs/devel/qapi-code-gen.rst | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index 4932dd35b64..ff7663a2666 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -989,7 +989,8 @@ definition with an optional indented overview (the :ref:`doc-intro`), :ref:`descriptions <doc-descrip>` of each argument (for commands and events), member (for structs and unions), branch (for alternates), or value (for enums), :ref:`feature descriptions <doc-feat>` of each -feature (if any), and finally optional tagged sections. +feature (if any), and finally optional :ref:`tagged sections +<doc-tagged>`. .. _doc-intro: @@ -1054,7 +1055,7 @@ like this:: Returns ^^^^^^^ -"Returns" sections are only valid for commands. They document the +"Returns" :ref:`doc-tagged` are only valid for commands. They document the success response of the command. If there is some nuance to capture with the return value, it may be documented as:: @@ -1073,8 +1074,8 @@ this section may be omitted. Errors ^^^^^^ -"Errors" sections are only valid for commands. They document -the error response(s) for a command. +"Errors" :ref:`doc-tagged` are only valid for commands. They document +the error responses. "Errors" sections should be formatted as an rST list, each entry detailing a relevant error condition. For example:: @@ -1162,7 +1163,7 @@ achieved by omitting the language argument. Since ^^^^^ -A "Since: x.y" section lists the release that introduced the +A "Since: x.y" :ref:`doc-tagged` lists the release that introduced the definition:: # -- 2.55.0
