xref: /qemu/qapi/pragma.json (revision a976a99a)
1# -*- Mode: Python -*-
2# vim: filetype=python
3
4{ 'pragma': { 'doc-required': true } }
5
6# Whitelists to permit QAPI rule violations; think twice before you
7# 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    # Externally visible types whose member names may use uppercase
35    'member-name-exceptions': [     # visible in:
36        'ACPISlotType',             # query-acpi-ospm-status
37        'AcpiTableOptions',         # -acpitable
38        'BlkdebugEvent',            # blockdev-add, -blockdev
39        'BlkdebugSetStateOptions',  # blockdev-add, -blockdev
40        'BlockDeviceInfo',          # query-block
41        'BlockDeviceStats',         # query-blockstats
42        'BlockDeviceTimedStats',    # query-blockstats
43        'BlockIOThrottle',          # block_set_io_throttle
44        'BlockInfo',                # query-block
45        'BlockdevAioOptions',       # blockdev-add, -blockdev
46        'BlockdevDriver',           # blockdev-add, query-blockstats, ...
47        'BlockdevVmdkAdapterType',  # blockdev-create (to match VMDK spec)
48        'BlockdevVmdkSubformat',    # blockdev-create (to match VMDK spec)
49        'ColoCompareProperties',    # object_add, -object
50        'FilterMirrorProperties',   # object_add, -object
51        'FilterRedirectorProperties', # object_add, -object
52        'FilterRewriterProperties', # object_add, -object
53        'InputLinuxProperties',     # object_add, -object
54        'NetdevTapOptions',         # netdev_add, query-netdev, -netdev
55        'ObjectType',               # object-add, -object
56        'PCIELinkSpeed',            # internal only
57        'PciBusInfo',               # query-pci
58        'PciDeviceInfo',            # query-pci
59        'PciMemoryRegion',          # query-pci
60        'QKeyCode',                 # send-key, input-sent-event
61        'QapiErrorClass',           # QMP error replies
62        'SshHostKeyCheckMode',      # blockdev-add, -blockdev
63        'SysEmuTarget',             # query-cpu-fast, query-target
64        'UuidInfo',                 # query-uuid
65        'VncClientInfo',            # query-vnc, query-vnc-servers, ...
66        'X86CPURegister32'          # qom-get of x86 CPU properties
67                                    # feature-words, filtered-features
68    ] } }
69