[PATCH 1/3] docs/devel/qapi-code-gen: Add two cross-references we missed

Markus Armbruster posted 3 patches 3 months, 2 weeks ago
Maintainers: Markus Armbruster <armbru@redhat.com>, Michael Roth <michael.roth@amd.com>, John Snow <jsnow@redhat.com>, Peter Maydell <peter.maydell@linaro.org>
[PATCH 1/3] docs/devel/qapi-code-gen: Add two cross-references we missed
Posted by Markus Armbruster 3 months, 2 weeks ago
Missed in commit 9c66762a601 (docs/qapi-code-gen: add
cross-references).

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 docs/devel/qapi-code-gen.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index dfdbeac5a5..138921b386 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -646,9 +646,9 @@ Member 'event' names the event.  This is the event name used in the
 Client JSON Protocol.
 
 Member 'data' defines the event-specific data.  It defaults to an
-empty MEMBERS object.
+empty MEMBERS_ object.
 
-If 'data' is a MEMBERS object, then MEMBERS defines event-specific
+If 'data' is a MEMBERS_ object, then MEMBERS defines event-specific
 data just like a struct type's 'data' defines struct type members.
 
 If 'data' is a STRING, then STRING names a complex type whose members
-- 
2.49.0
Re: [PATCH 1/3] docs/devel/qapi-code-gen: Add two cross-references we missed
Posted by John Snow 3 months, 1 week ago
On Thu, Jul 31, 2025 at 1:40 AM Markus Armbruster <armbru@redhat.com> wrote:
>
> Missed in commit 9c66762a601 (docs/qapi-code-gen: add
> cross-references).
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>

Reviewed-by: John Snow <jsnow@redhat.com>

> ---
>  docs/devel/qapi-code-gen.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
> index dfdbeac5a5..138921b386 100644
> --- a/docs/devel/qapi-code-gen.rst
> +++ b/docs/devel/qapi-code-gen.rst
> @@ -646,9 +646,9 @@ Member 'event' names the event.  This is the event name used in the
>  Client JSON Protocol.
>
>  Member 'data' defines the event-specific data.  It defaults to an
> -empty MEMBERS object.
> +empty MEMBERS_ object.

Admittedly, I forgot this was valid syntax - it's core to
restructuredtext and not a sphinxism, so it only works within the
scope of a single document. Quite suitable for this use case, just
slightly ashamed I didn't recognize it immediately.

>
> -If 'data' is a MEMBERS object, then MEMBERS defines event-specific
> +If 'data' is a MEMBERS_ object, then MEMBERS defines event-specific
>  data just like a struct type's 'data' defines struct type members.
>
>  If 'data' is a STRING, then STRING names a complex type whose members
> --
> 2.49.0
>