mirror of
https://github.com/xemu-project/xemu.git
synced 2024-06-02 20:18:25 -04:00
37094b6dd5
Now that we are fully switched over to the new QMP library, move it back over the old namespace. This is being done primarily so that we may upload this package simply as "qemu.qmp" without introducing confusion over whether or not "aqmp" is a new protocol or not. The trade-off is increased confusion inside the QEMU developer tree. Sorry! Note: the 'private' member "_aqmp" in legacy.py also changes to "_qmp"; not out of necessity, but just to remove any traces of the "aqmp" name. Signed-off-by: John Snow <jsnow@redhat.com> Reviewed-by: Beraldo Leal <bleal@redhat.com> Acked-by: Hanna Reitz <hreitz@redhat.com> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@openvz.org> Message-id: 20220330172812.3427355-8-jsnow@redhat.com Signed-off-by: John Snow <jsnow@redhat.com>
44 lines
1.5 KiB
ReStructuredText
44 lines
1.5 KiB
ReStructuredText
QEMU Python Tooling
|
|
===================
|
|
|
|
This package provides QEMU tooling used by the QEMU project to build,
|
|
configure, and test QEMU. It is not a fully-fledged SDK and it is subject
|
|
to change at any time.
|
|
|
|
Usage
|
|
-----
|
|
|
|
The ``qemu.qmp`` subpackage provides a library for communicating with
|
|
QMP servers. The ``qemu.machine`` subpackage offers rudimentary
|
|
facilities for launching and managing QEMU processes. Refer to each
|
|
package's documentation
|
|
(``>>> help(qemu.qmp)``, ``>>> help(qemu.machine)``)
|
|
for more information.
|
|
|
|
Contributing
|
|
------------
|
|
|
|
This package is maintained by John Snow <jsnow@redhat.com> as part of
|
|
the QEMU source tree. Contributions are welcome and follow the `QEMU
|
|
patch submission process
|
|
<https://wiki.qemu.org/Contribute/SubmitAPatch>`_, which involves
|
|
sending patches to the QEMU development mailing list.
|
|
|
|
John maintains a `GitLab staging branch
|
|
<https://gitlab.com/jsnow/qemu/-/tree/python>`_, and there is an
|
|
official `GitLab mirror <https://gitlab.com/qemu-project/qemu>`_.
|
|
|
|
Please report bugs on the `QEMU issue tracker
|
|
<https://gitlab.com/qemu-project/qemu/-/issues>`_ and tag ``@jsnow`` in
|
|
the report.
|
|
|
|
Optional packages necessary for running code quality analysis for this
|
|
package can be installed with the optional dependency group "devel":
|
|
``pip install qemu[devel]``.
|
|
|
|
``make develop`` can be used to install this package in editable mode
|
|
(to the current environment) *and* bring in testing dependencies in one
|
|
command.
|
|
|
|
``make check`` can be used to run the available tests.
|