summary refs log tree commit diff stats
path: root/python/qemu/utils
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2021-05-27 17:16:56 -0400
committerJohn Snow <jsnow@redhat.com>2021-06-01 16:21:21 -0400
commit93128815af4efcaba03a5581c959bc7f98ee2725 (patch)
treeb8c51b839f6c6e5bfff4006313f6a5288bc05050 /python/qemu/utils
parent3afc32906f7bffd8e09b7d247d60b55c49665bd3 (diff)
downloadfocaccia-qemu-93128815af4efcaba03a5581c959bc7f98ee2725.tar.gz
focaccia-qemu-93128815af4efcaba03a5581c959bc7f98ee2725.zip
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/utils')
-rw-r--r--python/qemu/utils/README.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/python/qemu/utils/README.rst b/python/qemu/utils/README.rst
new file mode 100644
index 0000000000..975fbf4d7d
--- /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.