diff mbox series

[v7,14/16] docs/devel/testing: add -valgrind option to the debug section of QEMU iotests

Message ID 20210628123150.56567-15-eesposit@redhat.com
State New
Headers show
Series qemu_iotests: improve debugging options | expand

Commit Message

Emanuele Giuseppe Esposito June 28, 2021, 12:31 p.m. UTC
Signed-off-by: Emanuele Giuseppe Esposito <eesposit@redhat.com>
Reviewed-by: Max Reitz <mreitz@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
---
 docs/devel/testing.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Eric Blake June 28, 2021, 9 p.m. UTC | #1
On Mon, Jun 28, 2021 at 02:31:48PM +0200, Emanuele Giuseppe Esposito wrote:
> Signed-off-by: Emanuele Giuseppe Esposito <eesposit@redhat.com>
> Reviewed-by: Max Reitz <mreitz@redhat.com>
> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
> ---
>  docs/devel/testing.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
> index 8b24e6fb47..fa85592a38 100644
> --- a/docs/devel/testing.rst
> +++ b/docs/devel/testing.rst
> @@ -240,6 +240,13 @@ a failing test:
>    If the ``-gdb`` option is not used, ``$GDB_OPTIONS`` is ignored,
>    regardless on whether it is set or not.
>  
> +* ``-valgrind`` attaches a valgrind instance to QEMU. If it detects
> +  warnings, it will print and save the log in
> +  ``$TEST_DIR/<valgrind_pid>.valgrind``.
> +  The final command line will be ``valgrind --log-file=$TEST_DIR/
> +  <valgrind_pid>.valgrind --error-exitcode=99 $QEMU ...``
> +  Note: if used together with ``-gdb``, this command will be ignored.

Ignored? Or did the previous patch make it an error to try and use
both at once?
Emanuele Giuseppe Esposito June 29, 2021, 7:05 a.m. UTC | #2
On 28/06/2021 23:00, Eric Blake wrote:
> On Mon, Jun 28, 2021 at 02:31:48PM +0200, Emanuele Giuseppe Esposito wrote:
>> Signed-off-by: Emanuele Giuseppe Esposito <eesposit@redhat.com>
>> Reviewed-by: Max Reitz <mreitz@redhat.com>
>> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@virtuozzo.com>
>> ---
>>   docs/devel/testing.rst | 7 +++++++
>>   1 file changed, 7 insertions(+)
>>
>> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
>> index 8b24e6fb47..fa85592a38 100644
>> --- a/docs/devel/testing.rst
>> +++ b/docs/devel/testing.rst
>> @@ -240,6 +240,13 @@ a failing test:
>>     If the ``-gdb`` option is not used, ``$GDB_OPTIONS`` is ignored,
>>     regardless on whether it is set or not.
>>   
>> +* ``-valgrind`` attaches a valgrind instance to QEMU. If it detects
>> +  warnings, it will print and save the log in
>> +  ``$TEST_DIR/<valgrind_pid>.valgrind``.
>> +  The final command line will be ``valgrind --log-file=$TEST_DIR/
>> +  <valgrind_pid>.valgrind --error-exitcode=99 $QEMU ...``
>> +  Note: if used together with ``-gdb``, this command will be ignored.
> 
> Ignored? Or did the previous patch make it an error to try and use
> both at once?
> 

I apologize, I forgot to update the documentation.
You are right in patch 13, the intended behavior is to fail with a 
meaningful error when both flags are used.

Will remove this doc line and update the error message as you suggested.

Thank you,
Emanuele
diff mbox series

Patch

diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index 8b24e6fb47..fa85592a38 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -240,6 +240,13 @@  a failing test:
   If the ``-gdb`` option is not used, ``$GDB_OPTIONS`` is ignored,
   regardless on whether it is set or not.
 
+* ``-valgrind`` attaches a valgrind instance to QEMU. If it detects
+  warnings, it will print and save the log in
+  ``$TEST_DIR/<valgrind_pid>.valgrind``.
+  The final command line will be ``valgrind --log-file=$TEST_DIR/
+  <valgrind_pid>.valgrind --error-exitcode=99 $QEMU ...``
+  Note: if used together with ``-gdb``, this command will be ignored.
+
 * ``-d`` (debug) just increases the logging verbosity, showing
   for example the QMP commands and answers.