aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/developer
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2024-04-18 12:09:57 +0200
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2024-04-18 13:56:54 +0200
commit83a93d243dbc1ef6679ee8ac3a35184a6edc43d9 (patch)
tree8b6f6ae3839ada21acf24fba35fcec12bdfe88ba /sources/pyside6/doc/developer
parent01dfd0d713dd9b9b151b69d0fc979e05a4a58164 (diff)
Documentation: Add instructions for using address sanitizer
Pick-to: 6.7 Change-Id: I851ffc5a9d421bb3a227594db691f67694ca042a Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
Diffstat (limited to 'sources/pyside6/doc/developer')
-rw-r--r--sources/pyside6/doc/developer/extras.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/sources/pyside6/doc/developer/extras.rst b/sources/pyside6/doc/developer/extras.rst
index 79fc72190..e06642805 100644
--- a/sources/pyside6/doc/developer/extras.rst
+++ b/sources/pyside6/doc/developer/extras.rst
@@ -24,6 +24,19 @@ Build on the command line
- Consider using ``build_scripts/qp5_tool.py``.
+Build with address sanitizer (Linux)
+====================================
+
+ASAN needs to be told to not exit on memory leaks and its library
+needs to be pre-loaded. Assuming the library is found
+at ``/usr/lib/gcc/x86_64-linux-gnu/11``:
+
+.. code-block:: bash
+
+ export ASAN_OPTIONS=detect_leaks=0
+ export LD_PRELOAD=/usr/lib/gcc/x86_64-linux-gnu/11/libasan.so
+ pyside-setup install [...] --sanitize-address
+
De-Virtualize the Python Files
==============================