]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
testsuite/README: update for meson, mention sanitizers
authorEmil Velikov <emil.l.velikov@gmail.com>
Thu, 17 Oct 2024 16:41:58 +0000 (17:41 +0100)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Fri, 18 Oct 2024 18:28:18 +0000 (13:28 -0500)
Mention that running outside of `meson test", one needs to set the env.
aka "source scripts/sanitizer-env.sh".

Also gently discourage using sanitizers alongside gdb and strace. While
thing might work it's not the setup we want to support, I think.

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/172
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
testsuite/README

index 1b0112ce10f853844e772c420d57cbdb189e665f..198bce246cafd4d6dd142d2c00946e4225b20944 100644 (file)
@@ -54,8 +54,12 @@ pay attention when writing a test:
     modules from module-playground. Update the latter script to include any
     modules your test needs.
 
-8 - Tests can be run individually, outside of 'make check'. strace and gdb work
-    too, as long as you tell them to operate on child process.
+8 - Tests can be run individually, outside of 'meson test'. strace and gdb
+    work too, as long as you tell them to operate on child process.
+
+    When running with sanitizers, make sure to 'source scripts/sanitizer-env.sh'.
+    Sanitizers are not guaranteed to work well with other tools like strace and gdb.
 
 9 - Make sure test passes when using "default" build flags, i.e. by running
-    'autogen.sh c'
+    'meson setup --native-file build-dev.ini ...', which by default enables the
+    sanitizers.