Re: [PATCH] docs/devel/testing: iotests check script should be run via 'run'

["Daniel P. Berrangé" <berrange@redhat.com>]

On Tue, Nov 03, 2026 at 12:22:50PM +0000, Alex Bennée wrote:
> Peter Maydell <peter.maydell@linaro.org> writes:
> 
> > The iotests section of the testing documentation suggests directly
> > running the "./check" script.  However if you do this then the
> > script complains:
> >
> > WARNING: iotests is being run from outside of the configure-time python virtual environment
> > [...]
> > Please use the meson run script:
> >         /home/pm215/qemu/build/x86-tgt-san-dbg/run ./check
> >
> > Update the documentation to match this.
> >
> > Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> > ---
> >  docs/devel/testing/main.rst | 14 +++++++++-----
> >  1 file changed, 9 insertions(+), 5 deletions(-)
> >
> > diff --git a/docs/devel/testing/main.rst b/docs/devel/testing/main.rst
> > index b0ca37fe2ba..e26b8af0c79 100644
> > --- a/docs/devel/testing/main.rst
> > +++ b/docs/devel/testing/main.rst
> > @@ -272,8 +272,12 @@ scripts.  The testing success criteria is golden output comparison, and the
> >  test files are named with numbers.
> >  
> >  To run iotests, make sure QEMU is built successfully, then switch to the
> > -``tests/qemu-iotests`` directory under the build directory, and run ``./check``
> > -with desired arguments from there.
> > +``tests/qemu-iotests`` directory under the build directory, and run
> > +the ``check`` script via the ``run`` wrapper which sets up the environment:
> > +
> > +.. code::
> > +
> > +   ../../run ./check [args]
> >
> 
> This is possibly a personal preference thing but is there actually a
> reason for cwd to be tests/qemu-iotests or should we frame it as:
> 
>   $BLD/run tests/qemu-iotests/check
> 
> which is how the functional tests are listed?

For the sake of docs it is probably a good idea to be run consistent
and illustrate use of 'run' from the root of the build  dir ie

  ./run tests/qemu-iotests/check

With regards,
Daniel
-- 
|: https://berrange.com       ~~        https://hachyderm.io/@berrange :|
|: https://libvirt.org          ~~          https://entangle-photo.org :|
|: https://pixelfed.art/berrange   ~~    https://fstop138.berrange.com :|