[PATCH 0/6] qapi: Supply some of the missing member documentation

Markus Armbruster posted 6 patches 3 months, 2 weeks ago
There is a newer version of this series
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(-)
[PATCH 0/6] qapi: Supply some of the missing member documentation
Posted by Markus Armbruster 3 months, 2 weeks ago
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
Re: [PATCH 0/6] qapi: Supply some of the missing member documentation
Posted by John Snow 3 months, 2 weeks ago
On Thu, Aug 8, 2024 at 2:26 PM Markus Armbruster <armbru@redhat.com> wrote:

> 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
>

I don't maintain any of these, but looks fine enough to me over being
undocumented.

ACK.

~~js