xref: /qemu/qapi/pragma.json (revision a0e93dd8) 
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        'GuestPanicInformationHyperV',
61        'HotKeyMod',
62        'ImageInfoSpecificKind',
63        'InputAxis',
64        'InputButton',
65        'InputMultiTouchEvent',
66        'InputMultiTouchType',
67        'IscsiHeaderDigest',
68        'IscsiTransport',
69        'JSONType',
70        'KeyValueKind',
71        'MemoryDeviceInfoKind',
72        'NetClientDriver',
73        'ObjectType',
74        'PciMemoryRegion',
75        'QCryptoAkCipherKeyType',
76        'QCryptodevBackendServiceType',
77        'QKeyCode',
78        'Qcow2OverlapCheckFlags',
79        'RbdAuthMode',
80        'RbdImageEncryptionFormat',
81        'StatsFilter',
82        'StatsValue',
83        'String',
84        'StringWrapper',
85        'SysEmuTarget',
86        'ThrottleGroupProperties',
87        'VncPrimaryAuth',
88        'VncVencryptSubAuth',
89        'X86CPURegister32',
90        'XDbgBlockGraph',
91        'YankInstanceType',
92        'blockdev-reopen',
93        'query-cpu-model-baseline',
94        'query-cpu-model-comparison',
95        'query-cpu-model-expansion',
96        'query-rocker',
97        'query-rocker-ports',
98        'query-stats-schemas',
99        'watchdog-set-action' ],
100    # Externally visible types whose member names may use uppercase
101    'member-name-exceptions': [     # visible in:
102        'ACPISlotType',             # query-acpi-ospm-status
103        'AcpiTableOptions',         # -acpitable
104        'BlkdebugEvent',            # blockdev-add, -blockdev
105        'BlkdebugSetStateOptions',  # blockdev-add, -blockdev
106        'BlockDeviceInfo',          # query-block
107        'BlockDeviceStats',         # query-blockstats
108        'BlockDeviceTimedStats',    # query-blockstats
109        'BlockIOThrottle',          # block_set_io_throttle
110        'BlockInfo',                # query-block
111        'BlockdevAioOptions',       # blockdev-add, -blockdev
112        'BlockdevDriver',           # blockdev-add, query-blockstats, ...
113        'BlockdevVmdkAdapterType',  # blockdev-create (to match VMDK spec)
114        'BlockdevVmdkSubformat',    # blockdev-create (to match VMDK spec)
115        'ColoCompareProperties',    # object_add, -object
116        'FilterMirrorProperties',   # object_add, -object
117        'FilterRedirectorProperties', # object_add, -object
118        'FilterRewriterProperties', # object_add, -object
119        'InputLinuxProperties',     # object_add, -object
120        'NetdevTapOptions',         # netdev_add, query-netdev, -netdev
121        'ObjectType',               # object-add, -object
122        'PCIELinkSpeed',            # internal only
123        'PciBusInfo',               # query-pci
124        'PciDeviceInfo',            # query-pci
125        'PciMemoryRegion',          # query-pci
126        'QKeyCode',                 # send-key, input-sent-event
127        'QapiErrorClass',           # QMP error replies
128        'SshHostKeyCheckMode',      # blockdev-add, -blockdev
129        'SysEmuTarget',             # query-cpu-fast, query-target
130        'UuidInfo',                 # query-uuid
131        'VncClientInfo',            # query-vnc, query-vnc-servers, ...
132        'X86CPURegister32'          # qom-get of x86 CPU properties
133                                    # feature-words, filtered-features
134    ] } }
135