[Qemu-commits] [qemu/qemu] 39a65e: qapi: Document introspection stability considerati...

[GitHub]

  Branch: refs/heads/master
  Home:   https://github.com/qemu/qemu
  Commit: 39a65e2c243978a480e03cab865462d98873fc3c
      
https://github.com/qemu/qemu/commit/39a65e2c243978a480e03cab865462d98873fc3c
  Author: Eric Blake <address@hidden>
  Date:   2015-11-17 (Tue, 17 Nov 2015)

  Changed paths:
    M docs/qapi-code-gen.txt
    M qapi/introspect.json

  Log Message:
  -----------
  qapi: Document introspection stability considerations

We are not ready (and might never be ready) to declare
introspection stable between releases. Clients written to
control multiple versions of qemu, and desiring to know
whether a particular member is supported for a given
command, must be prepared to locate that member in spite
of qapi changes that may affect the member's location or
type within the overall object, even though such changes
did not break QMP wire back-compatibility.

Signed-off-by: Eric Blake <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Markus Armbruster <address@hidden>


  Commit: 513e7cdbaeec56c77e4cf26f151d7ee79f3a6be9
      
https://github.com/qemu/qemu/commit/513e7cdbaeec56c77e4cf26f151d7ee79f3a6be9
  Author: Eric Blake <address@hidden>
  Date:   2015-11-17 (Tue, 17 Nov 2015)

  Changed paths:
    M qapi-schema.json

  Log Message:
  -----------
  input: Document why x-input-send-event is still experimental

The x-input-send-event command was introduced in 2.2 with mention
that it is experimental, but now that several releases have elapsed
without any changes, it would be nice to document why that was done
and should still remain experimental in 2.5.

Meanwhile, our documentation states that we prefer 'lower-case',
rather than 'CamelCase', for qapi enum values.  The InputButton and
InputAxis enums violate this convention.  However, because they are
currently used primarily for generating code that is used internally;
and their only exposure through QMP is via the experimental
'x-input-send-event' command, we are free to change their spelling.
Of course, it would be nicer to delay such a change until the same
time we promote the command to non-experimental.  Adding
documentation will help us remember to do that rename.

We have plans to tighten the qapi generator to flag instances of
inconsistent use of naming conventions; if that lands first, it
will just need to whitelist these exceptions until the time we
settle on the final interface.

Fix a typo in the docs for InputAxis while at it.

Signed-off-by: Eric Blake <address@hidden>
Message-Id: <address@hidden>
Reviewed-by: Gerd Hoffmann <address@hidden>
Signed-off-by: Markus Armbruster <address@hidden>


  Commit: 361cb26827ffd5f24af05b0e473ecd82d6a33bde
      
https://github.com/qemu/qemu/commit/361cb26827ffd5f24af05b0e473ecd82d6a33bde
  Author: Peter Maydell <address@hidden>
  Date:   2015-11-17 (Tue, 17 Nov 2015)

  Changed paths:
    M docs/qapi-code-gen.txt
    M qapi-schema.json
    M qapi/introspect.json

  Log Message:
  -----------
  Merge remote-tracking branch 'remotes/armbru/tags/pull-qapi-2015-11-17' into 
staging

QAPI patches

# gpg: Signature made Tue 17 Nov 2015 08:28:24 GMT using RSA key ID EB918653
# gpg: Good signature from "Markus Armbruster <address@hidden>"
# gpg:                 aka "Markus Armbruster <address@hidden>"

* remotes/armbru/tags/pull-qapi-2015-11-17:
  input: Document why x-input-send-event is still experimental
  qapi: Document introspection stability considerations

Signed-off-by: Peter Maydell <address@hidden>


Compare: https://github.com/qemu/qemu/compare/c257779e2a58...361cb26827ff