diff options
| author | Markus Armbruster <armbru@redhat.com> | 2023-04-25 08:42:13 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2023-04-28 11:48:34 +0200 |
| commit | f1a787b5f4b60524580ed9d1527568590d73789b (patch) | |
| tree | 1fc43237c13bd9b9b6f91ad2b6356ab513d4557d /docs/devel | |
| parent | 9a5af2f9dc8f231f6ca20f61b95970380f1024e2 (diff) | |
qapi: @foo should be used to reference, not ``foo``
Documentation suggests @foo is merely shorthand for ``foo``. It's
not, it carries additional meaning: it's a reference to a QAPI schema
name.
Reword the documentation to spell that out.
Fix up the few ``foo`` that should be @foo.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20230425064223.820979-7-armbru@redhat.com>
Diffstat (limited to 'docs/devel')
| -rw-r--r-- | docs/devel/qapi-code-gen.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index 879a649e8c..d81aac7a19 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -924,9 +924,11 @@ first character of the first line. The usual ****strong****, *\*emphasized\** and ````literal```` markup should be used. If you need a single literal ``*``, you will need to -backslash-escape it. As an extension beyond the usual rST syntax, you -can also use ``@foo`` to reference a name in the schema; this is rendered -the same way as ````foo````. +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. Example:: |