diff options
| author | John Snow <jsnow@redhat.com> | 2021-05-27 17:16:56 -0400 |
|---|---|---|
| committer | John Snow <jsnow@redhat.com> | 2021-06-01 16:21:21 -0400 |
| commit | 93128815af4efcaba03a5581c959bc7f98ee2725 (patch) | |
| tree | b8c51b839f6c6e5bfff4006313f6a5288bc05050 /python/qemu | |
| parent | 3afc32906f7bffd8e09b7d247d60b55c49665bd3 (diff) | |
| download | qemu-93128815af4efcaba03a5581c959bc7f98ee2725.zip qemu-93128815af4efcaba03a5581c959bc7f98ee2725.tar.gz qemu-93128815af4efcaba03a5581c959bc7f98ee2725.tar.bz2 | |
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>
Diffstat (limited to 'python/qemu')
| -rw-r--r-- | python/qemu/README.rst | 8 | ||||
| -rw-r--r-- | python/qemu/machine/README.rst | 9 | ||||
| -rw-r--r-- | python/qemu/qmp/README.rst | 9 | ||||
| -rw-r--r-- | python/qemu/utils/README.rst | 7 |
4 files changed, 33 insertions, 0 deletions
diff --git a/python/qemu/README.rst b/python/qemu/README.rst new file mode 100644 index 0000000..d04943f --- /dev/null +++ b/python/qemu/README.rst @@ -0,0 +1,8 @@ +QEMU Python Namespace +===================== + +This directory serves as the root of a `Python PEP 420 implicit +namespace package <https://www.python.org/dev/peps/pep-0420/>`_. + +Each directory below is assumed to be an installable Python package that +is available under the ``qemu.<package>`` namespace. diff --git a/python/qemu/machine/README.rst b/python/qemu/machine/README.rst new file mode 100644 index 0000000..ac2b4ff --- /dev/null +++ b/python/qemu/machine/README.rst @@ -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. diff --git a/python/qemu/qmp/README.rst b/python/qemu/qmp/README.rst new file mode 100644 index 0000000..c219514 --- /dev/null +++ b/python/qemu/qmp/README.rst @@ -0,0 +1,9 @@ +qemu.qmp package +================ + +This package provides a library used for connecting to and communicating +with QMP servers. It is used extensively by iotests, vm tests, +acceptance tests, and other utilities in the ./scripts directory. It is +not a fully-fledged SDK and is subject to change at any time. + +See the documentation in ``__init__.py`` for more information. diff --git a/python/qemu/utils/README.rst b/python/qemu/utils/README.rst new file mode 100644 index 0000000..975fbf4 --- /dev/null +++ b/python/qemu/utils/README.rst @@ -0,0 +1,7 @@ +qemu.utils package +================== + +This package provides miscellaneous utilities used for testing and +debugging QEMU. It is used primarily by the vm and acceptance tests. + +See the documentation in ``__init__.py`` for more information. |