From: Markus Armbruster <armbru@redhat.com>
To: John Snow <jsnow@redhat.com>
Cc: qemu-devel@nongnu.org,
Pierrick Bouvier <pierrick.bouvier@oss.qualcomm.com>,
Michael Roth <michael.roth@amd.com>
Subject: Re: [PATCH 02/11] docs/qapi-code-gen: add "Putting it all together" subsection
Date: Tue, 06 Oct 2026 09:55:52 +0200 [thread overview]
Message-ID: <87mrsrdzzr.fsf@pond.sub.org> (raw)
In-Reply-To: <20261001172239.2825745-3-jsnow@redhat.com> (John Snow's message of "Thu, 1 Oct 2026 13:22:29 -0400")
John Snow <jsnow@redhat.com> writes:
> Separate the specification portion of the documentation section from
> the holistic examples. Avoid naming the section "Examples" because it
> might be confused with the literal case of documenting how code
> examples should themselves be documented.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> docs/devel/qapi-code-gen.rst | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
> index f276a2bc9bc..0f66f012be1 100644
> --- a/docs/devel/qapi-code-gen.rst
> +++ b/docs/devel/qapi-code-gen.rst
> @@ -1089,6 +1089,9 @@ Highlighting in non-QMP languages can be accomplished by using the
> achieved by omitting the language argument.
>
>
> +Putting it all together
> +^^^^^^^^^^^^^^^^^^^^^^^
> +
> Examples of complete definition documentation::
>
> ##
This adds another level of headings, level seven:
Developer Information
QEMU Build System
How to use the QAPI code generator
The QAPI schema language
Documentation comments
Definition documentation
Putting it all together
I'm not thrilled by this depth, to be honest.
Adding the heading makes next to no sense by itself. However, you add
more headings next to it later in the series, and I believe that's why
you add this one now. Recommend to mention this in your commit message.
The series' total change to the section structure:
Introduction
============
The QAPI schema language
========================
Schema syntax
-------------
Built-in Types
--------------
Include directives
------------------
Pragma directives
-----------------
Enumeration types
-----------------
Type references and array types
-------------------------------
Struct types
------------
Union types
-----------
Alternate types
---------------
Commands
--------
Events
------
Features
--------
Special features
~~~~~~~~~~~~~~~~
Naming rules and reserved names
-------------------------------
Downstream extensions
---------------------
Configuring the schema
----------------------
Documentation comments
----------------------
Headings and subheadings
~~~~~~~~~~~~~~~~~~~~~~~~
Documentation markup
~~~~~~~~~~~~~~~~~~~~
Definition documentation
~~~~~~~~~~~~~~~~~~~~~~~~
+ Intro
+ ^^^^^
+ Descriptions
+ ^^^^^^^^^^^^
+ Tagged sections
+ ^^^^^^^^^^^^^^^
+ Returns
+ ^^^^^^^
+ Errors
+ ^^^^^^
+ Feature Descriptions
+ ^^^^^^^^^^^^^^^^^^^^
+ Details
+ ^^^^^^^
+ Since
+ ^^^^^
+ TODO
+ ^^^^
+ Putting it all together
+ ^^^^^^^^^^^^^^^^^^^^^^^
Markup pitfalls
~~~~~~~~~~~~~~~
Client JSON Protocol introspection
==================================
Compatibility considerations
============================
Code generation
===============
Code generated for QAPI types
-----------------------------
Code generated for visiting QAPI types
--------------------------------------
Code generated for commands
---------------------------
Code generated for events
-------------------------
Code generated for introspection
--------------------------------
It's more deeply nested than I'd like, but to avoid that, we'd need a
more invasive restructuring. Let's not go there now.
next prev parent reply other threads:[~2026-10-07 8:49 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-01 17:22 [PATCH 00/11] docs/qapi: revise and expand QAPI documentation spec John Snow
2026-10-01 17:22 ` [PATCH 01/11] docs/qapi-code-gen: change "x.y.z" to "x.y" for Since: documentation John Snow
2026-10-06 5:58 ` Markus Armbruster
2026-10-01 17:22 ` [PATCH 02/11] docs/qapi-code-gen: add "Putting it all together" subsection John Snow
2026-10-06 7:55 ` Markus Armbruster [this message]
2026-10-01 17:22 ` [PATCH 03/11] docs/qapi-code-gen: add "TODO" subsection John Snow
2026-10-06 8:02 ` Markus Armbruster
2026-10-01 17:22 ` [PATCH 04/11] docs/qapi-code-gen: add "Since" subsection John Snow
2026-10-01 17:22 ` [PATCH 05/11] docs/qapi-code-gen: add "Details" docs subsection John Snow
2026-10-06 8:36 ` Markus Armbruster
2026-10-01 17:22 ` [PATCH 06/11] docs/qapi-code-gen: add "Errors" and "Returns" subsections John Snow
2026-10-01 17:22 ` [PATCH 07/11] docs/qapi-code-gen: add "Tagged sections" subsection John Snow
2026-10-01 17:22 ` [PATCH 08/11] docs/qapi-code-gen: add "Descriptions" subsection John Snow
2026-10-06 9:08 ` Markus Armbruster
2026-10-01 17:22 ` [PATCH 09/11] docs/qapi-code-gen: add "Feature descriptions" subsection John Snow
2026-10-01 17:22 ` [PATCH 10/11] docs/qapi-code-gen: add "Intro" subsection John Snow
2026-10-01 17:22 ` [PATCH 11/11] docs/qapi-code-gen: add "Tagged sections" cross-references John Snow
2026-10-06 11:31 ` [PATCH 00/11] docs/qapi: revise and expand QAPI documentation spec Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87mrsrdzzr.fsf@pond.sub.org \
--to=armbru@redhat.com \
--cc=jsnow@redhat.com \
--cc=michael.roth@amd.com \
--cc=pierrick.bouvier@oss.qualcomm.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.