xref: /qemu/qapi/pragma.json (revision 4707331d)
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        'DisplayProtocol',
50        'DriveBackupWrapper',
51        'DummyBlockCoreForceArrays',
52        'DummyForceArrays',
53        'DummyVirtioForceArrays',
54        'HotKeyMod',
55        'ImageInfoSpecificKind',
56        'InputAxis',
57        'InputButton',
58        'IscsiHeaderDigest',
59        'IscsiTransport',
60        'KeyValueKind',
61        'MemoryDeviceInfoKind',
62        'NetClientDriver',
63        'ObjectType',
64        'QKeyCode',
65        'RbdAuthMode',
66        'RbdImageEncryptionFormat',
67        'S390CpuEntitlement',
68        'S390CpuPolarization',
69        'S390CpuState',
70        'String',
71        'StringWrapper',
72        'SysEmuTarget',
73        'ThrottleGroupProperties',
74        'VncPrimaryAuth',
75        'VncVencryptSubAuth',
76        'X86CPURegister32',
77        'XDbgBlockGraph',
78        'YankInstanceType',
79        'blockdev-reopen' ],
80    # Externally visible types whose member names may use uppercase
81    'member-name-exceptions': [     # visible in:
82        'ACPISlotType',             # query-acpi-ospm-status
83        'AcpiTableOptions',         # -acpitable
84        'BlkdebugEvent',            # blockdev-add, -blockdev
85        'BlkdebugSetStateOptions',  # blockdev-add, -blockdev
86        'BlockDeviceInfo',          # query-block
87        'BlockDeviceStats',         # query-blockstats
88        'BlockDeviceTimedStats',    # query-blockstats
89        'BlockIOThrottle',          # block_set_io_throttle
90        'BlockInfo',                # query-block
91        'BlockdevAioOptions',       # blockdev-add, -blockdev
92        'BlockdevDriver',           # blockdev-add, query-blockstats, ...
93        'BlockdevVmdkAdapterType',  # blockdev-create (to match VMDK spec)
94        'BlockdevVmdkSubformat',    # blockdev-create (to match VMDK spec)
95        'ColoCompareProperties',    # object_add, -object
96        'FilterMirrorProperties',   # object_add, -object
97        'FilterRedirectorProperties', # object_add, -object
98        'FilterRewriterProperties', # object_add, -object
99        'InputLinuxProperties',     # object_add, -object
100        'NetdevTapOptions',         # netdev_add, query-netdev, -netdev
101        'ObjectType',               # object-add, -object
102        'PCIELinkSpeed',            # internal only
103        'PciBusInfo',               # query-pci
104        'PciDeviceInfo',            # query-pci
105        'PciMemoryRegion',          # query-pci
106        'QKeyCode',                 # send-key, input-sent-event
107        'QapiErrorClass',           # QMP error replies
108        'SshHostKeyCheckMode',      # blockdev-add, -blockdev
109        'SysEmuTarget',             # query-cpu-fast, query-target
110        'UuidInfo',                 # query-uuid
111        'VncClientInfo',            # query-vnc, query-vnc-servers, ...
112        'X86CPURegister32'          # qom-get of x86 CPU properties
113                                    # feature-words, filtered-features
114    ] } }
115