diff --git a/python/qemu/machine/__init__.py b/python/qemu/machine/__init__.py index 728f27adbedced174ecfee7ea70f32a1c94da02e..9ccd58ef14763bbd0db9f80cd330853444d9ee1b 100644 --- a/python/qemu/machine/__init__.py +++ b/python/qemu/machine/__init__.py @@ -4,10 +4,10 @@ This library provides a few high-level classes for driving QEMU from a test suite, not intended for production use. -- QEMUMachine: Configure and Boot a QEMU VM - - QEMUQtestMachine: VM class, with a qtest socket. + | QEMUQtestProtocol: send/receive qtest messages. + | QEMUMachine: Configure and Boot a QEMU VM + | +-- QEMUQtestMachine: VM class, with a qtest socket. -- QEMUQtestProtocol: Connect to, send/receive qtest messages. """ # Copyright (C) 2020-2021 John Snow for Red Hat Inc. diff --git a/python/qemu/machine/machine.py b/python/qemu/machine/machine.py index e3345dfa1bc835d0bc10a91b6098eeb118ff56a8..d47ab3d8965bd415921b137a1e1c9967b492081d 100644 --- a/python/qemu/machine/machine.py +++ b/python/qemu/machine/machine.py @@ -545,7 +545,8 @@ def set_qmp_monitor(self, enabled: bool = True) -> None: @param enabled: if False, qmp monitor options will be removed from the base arguments of the resulting QEMU command line. Default is True. - @note: call this function before launch(). + + .. note:: Call this function before launch(). """ self._qmp_set = enabled diff --git a/python/qemu/qmp/__init__.py b/python/qemu/qmp/__init__.py index 376954cb6d275ad4cb8c5f3bf4dbd01de472d9bf..269516a79b90aa6ced483a192de5927a803ed942 100644 --- a/python/qemu/qmp/__init__.py +++ b/python/qemu/qmp/__init__.py @@ -279,6 +279,7 @@ def accept(self, timeout: Optional[float] = 15.0) -> QMPMessage: None). The value passed will set the behavior of the underneath QMP socket as described in [1]. Default value is set to 15.0. + @return QMP greeting dict @raise OSError on socket connection errors @raise QMPConnectError if the greeting is not received diff --git a/python/qemu/qmp/qom_common.py b/python/qemu/qmp/qom_common.py index f82b16772dfa2fb27b23a4b7f8dddd6515ab61b0..a59ae1a2a1883cb4d89b0e44507c5001f44357a0 100644 --- a/python/qemu/qmp/qom_common.py +++ b/python/qemu/qmp/qom_common.py @@ -156,7 +156,7 @@ def command_runner( """ Run a fully-parsed subcommand, with error-handling for the CLI. - :return: The return code from `.run()`. + :return: The return code from `run()`. """ try: cmd = cls(args) diff --git a/python/qemu/utils/accel.py b/python/qemu/utils/accel.py index 297933df2a316475f49bdf320c88d535d96ce945..386ff640ca81b6d3aeb096ca1a491931cf34f23e 100644 --- a/python/qemu/utils/accel.py +++ b/python/qemu/utils/accel.py @@ -36,7 +36,7 @@ def list_accel(qemu_bin: str) -> List[str]: List accelerators enabled in the QEMU binary. @param qemu_bin (str): path to the QEMU binary. - @raise Exception: if failed to run `qemu -accel help` + @raise Exception: if failed to run ``qemu -accel help`` @return a list of accelerator names. """ if not qemu_bin: