mbox series

[v2,0/8] qapi: Supply some of the missing member documentation

Message ID 20240911112545.2248881-1-armbru@redhat.com
Headers show
Series qapi: Supply some of the missing member documentation | expand

Message

Markus Armbruster Sept. 11, 2024, 11:25 a.m. UTC 
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
    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: The Dummy*ForceArrays are purely internal, and should be elided
from the manual instead, but that's a different project.

Based on my "[PULL 00/19] QAPI patches patches for 2024-09-10" rather
than current master to avoid trivial conflicts in qapi/pragma.json.

Based-on: <20240910164714.1993531-1-armbru@redhat.com>

v2:
* Rebased on latest QAPI PR
* PATCH 1: Tody up a "since" while there [John Snow]
* PATCH 7+8: New

Markus Armbruster (7):
  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/cxl: Supply missing member documentation

Zhenwei Pi (1):
  qapi: Document QCryptodevBackendServiceType

 qapi/char.json       | 44 ++++++++++++++++++++++++++++----------------
 qapi/common.json     | 14 +++++++++++++-
 qapi/crypto.json     |  4 ++++
 qapi/cryptodev.json  | 10 ++++++++++
 qapi/cxl.json        |  3 +++
 qapi/introspect.json | 16 ++++++++++++++++
 qapi/pci.json        |  2 ++
 qapi/pragma.json     | 11 +----------
 qapi/rocker.json     |  4 ++++
 9 files changed, 81 insertions(+), 27 deletions(-)

Comments

Markus Armbruster Sept. 13, 2024, 8:09 a.m. UTC | #1 
Qeueued.  I'm going to sit on it for a few more days in the hope of
getting PATCH 1+7 reviewed, too.