qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: stefanha@redhat.com
Subject: Re: [PULL 00/11] QAPI patches patches for 2025-04-08
Date: Tue, 08 Apr 2025 09:45:39 +0200	[thread overview]
Message-ID: <8734ejp04c.fsf@pond.sub.org> (raw)
In-Reply-To: <20250408072001.2518323-1-armbru@redhat.com> (Markus Armbruster's message of "Tue, 8 Apr 2025 09:19:50 +0200")

Here's my argument for taking this into 10.0.

The changes can be divided into four parts:

1. Address deficiencies right at the beginning of the three QMP manuals:

   * "QEMU QMP Reference Manual" section "Introduction" suffers from bit
     rot: much of the contents is useless or misleading.

   * The "QEMU Storage Daemon QMP Reference Manual" and the "QEMU Guest
     Agent Protocol Reference" lack a proper introduction.

   * "QEMU Guest Agent Protocol Reference" has a useless table of
     contents.

   * "QEMU QMP Reference Manual" and "QEMU Storage Daemon QMP Reference
     Manual" both have a needlessly ugly table of contents.

2. Render the example notation in these introductions properly.  This
   involves changing *one* line of code in docs/sphinx/qmp_lexer.py.
   This is the only code change, everything else is documentation.

3. Minor cleanup of rocker QMP documentation

4. Minor improvement of QAPI developer documentation



  parent reply	other threads:[~2025-04-08  7:46 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-08  7:19 [PULL 00/11] QAPI patches patches for 2025-04-08 Markus Armbruster
2025-04-08  7:19 ` [PULL 01/11] docs/devel/qapi-code-gen: Tidy up whitespace Markus Armbruster
2025-04-08  7:19 ` [PULL 02/11] qapi/rocker: Tidy up query-rocker-of-dpa-flows example Markus Armbruster
2025-04-08  7:19 ` [PULL 03/11] docs/interop: Delete "QEMU Guest Agent Protocol Reference" TOC Markus Armbruster
2025-04-08  7:19 ` [PULL 04/11] docs/interop: Sanitize QMP reference manuals TOC Markus Armbruster
2025-04-08  7:19 ` [PULL 05/11] docs/devel/qapi-code-gen: Improve the part on qmp-example directive Markus Armbruster
2025-04-08  7:19 ` [PULL 06/11] docs/sphinx/qmp_lexer: Generalize elision syntax Markus Armbruster
2025-04-08  7:19 ` [PULL 07/11] docs/sphinx/qmp_lexer: Highlight elisions like comments, not prompts Markus Armbruster
2025-04-08  7:19 ` [PULL 08/11] qapi/qapi-schema: Update introduction for example notation Markus Armbruster
2025-04-08  7:19 ` [PULL 09/11] qapi/qapi-schema: Address the introduction's bit rot Markus Armbruster
2025-04-08  7:20 ` [PULL 10/11] storage-daemon/qapi/qapi-schema: Add a proper introduction Markus Armbruster
2025-04-08  7:20 ` [PULL 11/11] qga/qapi-schema: " Markus Armbruster
2025-04-08  7:45 ` Markus Armbruster [this message]
2025-04-09  8:31 ` [PULL 00/11] QAPI patches patches for 2025-04-08 Stefan Hajnoczi

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=8734ejp04c.fsf@pond.sub.org \
    --to=armbru@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=stefanha@redhat.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).