qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com, marcandre.lureau@redhat.com,
	pbonzini@redhat.com, berrange@redhat.com, mst@redhat.com,
	marcel.apfelbaum@gmail.com, jiri@resnulli.us, jsnow@redhat.com
Subject: [PATCH 0/6] qapi: Supply some of the missing member documentation
Date: Thu,  8 Aug 2024 20:26:30 +0200	[thread overview]
Message-ID: <20240808182636.3657537-1-armbru@redhat.com> (raw)

This series gets a few of modules off the pragma
documentation-exceptions list of shame that require minimal effort.

Many undocumented members still remain:

    module          type or command                     #missing
    ------------------------------------------------------------
    audio           AudiodevDriver                      12
    block-core      BlkdebugEvent                       43
                    BlockdevDriver                      39
                    BlockdevQcow2EncryptionFormat       1
                    BlockdevVmdkAdapterType             4
                    DummyBlockCoreForceArrays           1
                    ImageInfoSpecificKind               2
                    IscsiHeaderDigest                   4
                    IscsiTransport                      2
                    RbdAuthMode                         2
                    RbdImageEncryptionFormat            2
                    ThrottleGroupProperties             19
                    XDbgBlockGraph                      2
                    blockdev-reopen			1
    cryptodev       QCryptodevBackendServiceType        5
    cxl             CxlCorErrorType                     1
    machine-common  CpuS390Entitlement                  4
    machine-target  CpuS390Polarization                 2
    machine         CpuS390State                        5
                    DummyForceArrays                    1
                    MemoryDeviceInfoKind                1
                    SysEmuTarget                        27
                    X86CPURegister32                    8
    net             NetClientDriver                     10
                    String                              1
    qom             ObjectType                          48
    transaction     AbortWrapper                        1
                    BlockDirtyBitmapAddWrapper          1
                    BlockDirtyBitmapMergeWrapper        1
                    BlockDirtyBitmapWrapper             1
                    BlockdevBackupWrapper               1
                    BlockdevSnapshotInternalWrapper     1
                    BlockdevSnapshotSyncWrapper         1
                    BlockdevSnapshotWrapper             1
                    DriveBackupWrapper                  1
    ui              DisplayProtocol                     2
                    HotKeyMod                           3
                    InputAxis                           2
                    InputButton                         7
                    KeyValueKind                        2
                    QKeyCode                            119
                    VncPrimaryAuth                      9
                    VncVencryptSubAuth                  9
    virtio          DummyVirtioForceArrays              1
    yank            YankInstanceType                    3
    qga             GuestNVMeSmart                      25

Note: DummyVirtioForceArrays is purely internal, and should be elided
from the manual instead, but that's a different project.

Markus Armbruster (6):
  qapi/char: Supply missing member documentation
  qapi/common: Supply missing member documentation
  qapi/crypto: Supply missing member documentation
  qapi/introspect: Supply missing member documentation
  qapi/pci: Supply missing member documentation
  qapi/rocker: Supply missing member documentation

 qapi/char.json       | 44 ++++++++++++++++++++++++++++----------------
 qapi/common.json     | 14 +++++++++++++-
 qapi/crypto.json     |  4 ++++
 qapi/introspect.json | 16 ++++++++++++++++
 qapi/pci.json        |  2 ++
 qapi/pragma.json     |  9 +--------
 qapi/rocker.json     |  4 ++++
 7 files changed, 68 insertions(+), 25 deletions(-)

-- 
2.45.0



             reply	other threads:[~2024-08-08 18:27 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-08 18:26 Markus Armbruster [this message]
2024-08-08 18:26 ` [PATCH 1/6] qapi/char: Supply missing member documentation Markus Armbruster
2024-08-08 20:48   ` John Snow
2024-08-09  4:51     ` Markus Armbruster
2024-08-09  8:44   ` Philippe Mathieu-Daudé
2024-08-09  9:11     ` Markus Armbruster
2024-08-12 18:10       ` John Snow
2024-08-08 18:26 ` [PATCH 2/6] qapi/common: " Markus Armbruster
2024-08-09  8:38   ` Philippe Mathieu-Daudé
2024-08-08 18:26 ` [PATCH 3/6] qapi/crypto: " Markus Armbruster
2024-08-09  8:39   ` Philippe Mathieu-Daudé
2024-08-08 18:26 ` [PATCH 4/6] qapi/introspect: " Markus Armbruster
2024-08-09 12:27   ` Eric Blake
2024-08-08 18:26 ` [PATCH 5/6] qapi/pci: " Markus Armbruster
2024-08-09  8:41   ` Philippe Mathieu-Daudé
2024-08-08 18:26 ` [PATCH 6/6] qapi/rocker: " Markus Armbruster
2024-08-09  8:41   ` Philippe Mathieu-Daudé
2024-08-08 20:51 ` [PATCH 0/6] qapi: Supply some of the " John Snow

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=20240808182636.3657537-1-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=berrange@redhat.com \
    --cc=eblake@redhat.com \
    --cc=jiri@resnulli.us \
    --cc=jsnow@redhat.com \
    --cc=marcandre.lureau@redhat.com \
    --cc=marcel.apfelbaum@gmail.com \
    --cc=mst@redhat.com \
    --cc=pbonzini@redhat.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 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).