Skip to contentSkip to conversation

docs: Update qmp scripts path

PATCH In review Shivang Upadhyay 2 participants 2 messages Jul 10

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: Update qmp scripts path

Qmp scripts are essentially removed from scripts directory as per commit b08e111b1e1 ("scripts: nudge users to use 'run' script for scripts that import qemu.qmp"). Scripts essentially redirect to run build/run script. Reflecting the same changes on docs.

---
 docs/devel/build-system.rst            |  2 +-
 docs/interop/live-block-operations.rst | 10 +++++-----
 docs/system/arm/cpu-features.rst       |  5 +++--
 docs/system/devices/usb.rst            |  2 +-
 4 files changed, 10 insertions(+), 9 deletions(-)
docs/devel/build-system.rst +1 -1
index 71331e64ac..052eac7c51 100644
@@ -521,7 +521,7 @@ Built by configure:
   before running the requested command. Pass the command to run as
   args, for example::
 
-    $ ./build/run ./script/qmp/qmp-shell-wrap qemu-system-x86_64
+    $ ./build/run qmp-shell-wrap qemu-system-x86_64
 
   will use the ``python3`` binary and site-packages from the local
   venv to run ``qmp-shell-wrap`` and spawn the QEMU emulator from
docs/interop/live-block-operations.rst +5 -5
index 6b549ede7c..f8beb66275 100644
@@ -152,12 +152,12 @@ of QEMU 2.9, accept ``node-name`` parameter) when performing various
 block operations.
 
 To interact with the QEMU instance launched above, we will use the
-``qmp-shell`` utility (located at: ``qemu/scripts/qmp``, as part of the
-QEMU source directory), which takes key-value pairs for QMP commands.
-Invoke it as below (which will also print out the complete raw JSON
-syntax for reference -- examples in the following sections)::
+``qmp-shell`` utility (available via the ``run`` script in the build
+directory after running configure), which takes key-value pairs for QMP
+commands.  Invoke it as below (which will also print out the complete raw
+JSON syntax for reference -- examples in the following sections)::
 
-    $ ./qmp-shell -v -p /tmp/qmp-sock
+    $ $builddir/run qmp-shell -v -p /tmp/qmp-sock
     (QEMU)
 
 .. note::
docs/system/arm/cpu-features.rst +3 -2
index 10b0eff27e..c56f5fe208 100644
@@ -36,8 +36,9 @@ CPU Feature Probing
 
 Determining which CPU features are available and functional for a given
 CPU type is possible with the ``query-cpu-model-expansion`` QMP command.
-Below are some examples where ``scripts/qmp/qmp-shell`` (see the top comment
-block in the script for usage) is used to issue the QMP commands.
+Below are some examples where ``qmp-shell`` (available via
+``$builddir/run qmp-shell`` after running configure) is used to issue the
+QMP commands.
 
 1. Determine which CPU features are available for the ``max`` CPU type
    (Note, we started QEMU with qemu-system-aarch64, so ``max`` is
docs/system/devices/usb.rst +1 -1
index dc694d23c2..7e2a303f41 100644
@@ -258,7 +258,7 @@ device visible to the guest. The workflow looks like this:
 #. ``device-add usb-bot,id=foo``
 #. ``device-add scsi-{hd,cd},bus=foo.0,lun=0``
 #. optionally add more devices (luns 1 ... 15)
-#. ``scripts/qmp/qom-set foo.attached = true``
+#. ``$builddir/run qom-set foo.attached = true``
 
 .. _host_005fusb_005fdevices:
 
Signature · 1 line
2.54.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 5 lines · Shivang Upadhyay

Qmp scripts are essentially removed from scripts directory as per commit b08e111b1e1 ("scripts: nudge users to use 'run' script for scripts that import qemu.qmp"). Scripts essentially redirect to run build/run script. Reflecting the same changes on docs.

Quoted 7 lines
---
 docs/devel/build-system.rst            |  2 +-
 docs/interop/live-block-operations.rst | 10 +++++-----
 docs/system/arm/cpu-features.rst       |  5 +++--
 docs/system/devices/usb.rst            |  2 +-
 4 files changed, 10 insertions(+), 9 deletions(-)

With regards,
Daniel

Signature · 3 lines
|: https://berrange.com       ~~        https://hachyderm.io/@berrange :|
|: https://libvirt.org          ~~          https://entangle-photo.org :|
|: https://pixelfed.art/berrange   ~~    https://fstop138.berrange.com :|