summary refs log tree commit diff stats
path: root/python/qemu/qmp/__init__.py
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2025-08-26 13:04:50 -0400
committerJohn Snow <jsnow@redhat.com>2025-09-15 14:36:01 -0400
commitf414048e32262830e06d50240b2f15b6e5857efe (patch)
tree3d2301e63c94e439617bfb9accc9c788ca36c2fd /python/qemu/qmp/__init__.py
parent85f223e5b031eb8ab63fbca314a4fb296a3a2632 (diff)
downloadfocaccia-qemu-f414048e32262830e06d50240b2f15b6e5857efe.tar.gz
focaccia-qemu-f414048e32262830e06d50240b2f15b6e5857efe.zip
python: synchronize qemu.qmp documentation
This patch collects comments and documentation changes from many commits
in the python-qemu-qmp repository; bringing the qemu.git copy in
bit-identical alignment with the standalone library *except* for several
copyright messages that reference the "LICENSE" file which is, for QEMU,
named "COPYING" instead and are therefore left unchanged.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Diffstat (limited to 'python/qemu/qmp/__init__.py')
-rw-r--r--python/qemu/qmp/__init__.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py
index 69190d057a..058139dc3c 100644
--- a/python/qemu/qmp/__init__.py
+++ b/python/qemu/qmp/__init__.py
@@ -39,7 +39,8 @@ from .qmp_client import ExecInterruptedError, ExecuteError, QMPClient
 logging.getLogger('qemu.qmp').addHandler(logging.NullHandler())
 
 
-# The order of these fields impact the Sphinx documentation order.
+# IMPORTANT: When modifying this list, update the Sphinx overview docs.
+# Anything visible in the qemu.qmp namespace should be on the overview page.
 __all__ = (
     # Classes, most to least important
     'QMPClient',