qapi/compat.json

   1 # -*- Mode: Python -*-
   2 # vim: filetype=python
   3
   4 ##
   5 # = Compatibility policy
   6 ##
   7
   8 ##
   9 # @CompatPolicyInput:
  10 #
  11 # Policy for handling "funny" input.
  12 #
  13 # @accept: Accept silently
  14 #
  15 # @reject: Reject with an error
  16 #
  17 # @crash: abort() the process
  18 #
  19 # Since: 6.0
  20 ##
  21 { 'enum': 'CompatPolicyInput',
  22   'data': [ 'accept', 'reject', 'crash' ] }
  23
  24 ##
  25 # @CompatPolicyOutput:
  26 #
  27 # Policy for handling "funny" output.
  28 #
  29 # @accept: Pass on unchanged
  30 #
  31 # @hide: Filter out
  32 #
  33 # Since: 6.0
  34 ##
  35 { 'enum': 'CompatPolicyOutput',
  36   'data': [ 'accept', 'hide' ] }
  37
  38 ##
  39 # @CompatPolicy:
  40 #
  41 # Policy for handling deprecated management interfaces.
  42 #
  43 # This is intended for testing users of the management interfaces.
  44 #
  45 # Limitation: covers only syntactic aspects of QMP, i.e. stuff tagged
  46 # with feature 'deprecated' or 'unstable'.  We may want to extend it
  47 # to cover semantic aspects and CLI.
  48 #
  49 # Limitation: deprecated-output policy @hide is not implemented for
  50 # enumeration values.  They behave the same as with policy @accept.
  51 #
  52 # @deprecated-input: how to handle deprecated input (default 'accept')
  53 #
  54 # @deprecated-output: how to handle deprecated output (default
  55 #     'accept')
  56 #
  57 # @unstable-input: how to handle unstable input (default 'accept')
  58 #     (since 6.2)
  59 #
  60 # @unstable-output: how to handle unstable output (default 'accept')
  61 #     (since 6.2)
  62 #
  63 # Since: 6.0
  64 ##
  65 { 'struct': 'CompatPolicy',
  66   'data': { '*deprecated-input': 'CompatPolicyInput',
  67             '*deprecated-output': 'CompatPolicyOutput',
  68             '*unstable-input': 'CompatPolicyInput',
  69             '*unstable-output': 'CompatPolicyOutput' } }