mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-08-22 01:21:53 -06:00
python: add directory structure README.rst files
Add short readmes to python/, python/qemu/, python/qemu/machine, python/qemu/qmp, and python/qemu/utils that explain the directory hierarchy. These readmes are visible when browsing the source on e.g. gitlab/github and are designed to help new developers/users quickly make sense of the source tree. They are not designed for inclusion in a published manual. Signed-off-by: John Snow <jsnow@redhat.com> Reviewed-by: Cleber Rosa <crosa@redhat.com> Message-id: 20210527211715.394144-13-jsnow@redhat.com Signed-off-by: John Snow <jsnow@redhat.com>
This commit is contained in:
parent
3afc32906f
commit
93128815af
5 changed files with 74 additions and 0 deletions
9
python/qemu/machine/README.rst
Normal file
9
python/qemu/machine/README.rst
Normal file
|
@ -0,0 +1,9 @@
|
|||
qemu.machine package
|
||||
====================
|
||||
|
||||
This package provides core utilities used for testing and debugging
|
||||
QEMU. It is used by the iotests, vm tests, acceptance tests, and several
|
||||
other utilities in the ./scripts directory. It is not a fully-fledged
|
||||
SDK and it is subject to change at any time.
|
||||
|
||||
See the documentation in ``__init__.py`` for more information.
|
Loading…
Add table
Add a link
Reference in a new issue