qapi/pragma.json

   1 # -*- Mode: Python -*-
   2 # vim: filetype=python
   3
   4 { 'pragma': { 'doc-required': true } }
   5
   6 # Entries in these lists are allowed to violate the QAPI rules (for
   7 # historical reasons); think twice before you add to them!
   8 { 'pragma': {
   9     # Command names containing '_'
  10     'command-name-exceptions': [
  11         'add_client',
  12         'block_resize',
  13         'block_set_io_throttle',
  14         'client_migrate_info',
  15         'device_add',
  16         'device_del',
  17         'expire_password',
  18         'migrate_cancel',
  19         'netdev_add',
  20         'netdev_del',
  21         'qmp_capabilities',
  22         'set_link',
  23         'set_password',
  24         'system_powerdown',
  25         'system_reset',
  26         'system_wakeup' ],
  27     # Commands allowed to return a non-dictionary
  28     'command-returns-exceptions': [
  29         'human-monitor-command',
  30         'qom-get',
  31         'query-tpm-models',
  32         'query-tpm-types',
  33         'ringbuf-read' ],
  34     # Types, commands, and events with undocumented members / arguments:
  35     'documentation-exceptions': [
  36         'AbortWrapper',
  37         'AudiodevDriver',
  38         'BlkdebugEvent',
  39         'BlockDirtyBitmapAddWrapper',
  40         'BlockDirtyBitmapMergeWrapper',
  41         'BlockDirtyBitmapWrapper',
  42         'BlockdevBackupWrapper',
  43         'BlockdevDriver',
  44         'BlockdevQcow2EncryptionFormat',
  45         'BlockdevSnapshotInternalWrapper',
  46         'BlockdevSnapshotSyncWrapper',
  47         'BlockdevSnapshotWrapper',
  48         'BlockdevVmdkAdapterType',
  49         'ChardevBackendKind',
  50         'CpuS390Entitlement',
  51         'CpuS390Polarization',
  52         'CpuS390State',
  53         'CxlCorErrorType',
  54         'DisplayProtocol',
  55         'DriveBackupWrapper',
  56         'DummyBlockCoreForceArrays',
  57         'DummyForceArrays',
  58         'DummyVirtioForceArrays',
  59         'GrabToggleKeys',
  60         'HotKeyMod',
  61         'ImageInfoSpecificKind',
  62         'InputAxis',
  63         'InputButton',
  64         'IscsiHeaderDigest',
  65         'IscsiTransport',
  66         'JSONType',
  67         'KeyValueKind',
  68         'MemoryDeviceInfoKind',
  69         'NetClientDriver',
  70         'ObjectType',
  71         'PciMemoryRegion',
  72         'QCryptoAkCipherKeyType',
  73         'QCryptodevBackendServiceType',
  74         'QKeyCode',
  75         'RbdAuthMode',
  76         'RbdImageEncryptionFormat',
  77         'String',
  78         'StringWrapper',
  79         'SysEmuTarget',
  80         'ThrottleGroupProperties',
  81         'VncPrimaryAuth',
  82         'VncVencryptSubAuth',
  83         'X86CPURegister32',
  84         'XDbgBlockGraph',
  85         'YankInstanceType',
  86         'blockdev-reopen',
  87         'query-rocker',
  88         'query-rocker-ports' ],
  89     # Externally visible types whose member names may use uppercase
  90     'member-name-exceptions': [     # visible in:
  91         'ACPISlotType',             # query-acpi-ospm-status
  92         'AcpiTableOptions',         # -acpitable
  93         'BlkdebugEvent',            # blockdev-add, -blockdev
  94         'BlkdebugSetStateOptions',  # blockdev-add, -blockdev
  95         'BlockDeviceInfo',          # query-block
  96         'BlockDeviceStats',         # query-blockstats
  97         'BlockDeviceTimedStats',    # query-blockstats
  98         'BlockIOThrottle',          # block_set_io_throttle
  99         'BlockInfo',                # query-block
 100         'BlockdevAioOptions',       # blockdev-add, -blockdev
 101         'BlockdevDriver',           # blockdev-add, query-blockstats, ...
 102         'BlockdevVmdkAdapterType',  # blockdev-create (to match VMDK spec)
 103         'BlockdevVmdkSubformat',    # blockdev-create (to match VMDK spec)
 104         'ColoCompareProperties',    # object_add, -object
 105         'FilterMirrorProperties',   # object_add, -object
 106         'FilterRedirectorProperties', # object_add, -object
 107         'FilterRewriterProperties', # object_add, -object
 108         'InputLinuxProperties',     # object_add, -object
 109         'NetdevTapOptions',         # netdev_add, query-netdev, -netdev
 110         'ObjectType',               # object-add, -object
 111         'PCIELinkSpeed',            # internal only
 112         'PciBusInfo',               # query-pci
 113         'PciDeviceInfo',            # query-pci
 114         'PciMemoryRegion',          # query-pci
 115         'QKeyCode',                 # send-key, input-sent-event
 116         'QapiErrorClass',           # QMP error replies
 117         'SshHostKeyCheckMode',      # blockdev-add, -blockdev
 118         'SysEmuTarget',             # query-cpu-fast, query-target
 119         'UuidInfo',                 # query-uuid
 120         'VncClientInfo',            # query-vnc, query-vnc-servers, ...
 121         'X86CPURegister32'          # qom-get of x86 CPU properties
 122                                     # feature-words, filtered-features
 123     ] } }