Sanitizers moved to main build

SmingHub · Jul 8, 2024 · 2035a92 · 2035a92
1 parent 0cc7343
commit 2035a92
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 27 deletions.
diff --git a/Sming/Arch/Host/README.rst b/Sming/Arch/Host/README.rst
@@ -230,33 +230,6 @@ Configuration
    On MacOS builds are 64-bit only. Default for other systems is 32-bit.
 
 
-.. envvar:: ENABLE_SANITIZERS
-
-   default: 0 (off)
-
-   Enable this option to build with lots of runtime checking.
-
-   This provides some of the capabilities of valgrind but by instrumenting
-   the code when it is compiled, rather than patching at runtime.
-
-   It also links in some additional runtime support libraries.
-
-   Run a full rebuild after changing this setting (or :envvar:`SANITIZERS`)::
-
-       make clean components-clean
-       make
-
-   .. note::
-
-      If using :envvar:`CLANG_BUILD` then all runtime libraries should already be available.
-      For GCC you will also need to install ``libasan`` and ``libubsan``.
-
-
-.. envvar:: SANITIZERS
-
-   Selects which sanitizers are used. See :envvar:`ENABLE_SANITIZERS`.
-
-
 Components
 ----------
 

diff --git a/Sming/README.rst b/Sming/README.rst
@@ -97,6 +97,36 @@ Build caching
    This setting was introduced mainly for CI builds as relatively little changes between runs.
 
 
+.. envvar:: ENABLE_SANITIZERS
+
+   default: 0 (off)
+
+   Enable this option to build with lots of runtime checking.
+
+   This provides some of the capabilities of valgrind but by instrumenting
+   the code when it is compiled, rather than patching at runtime.
+
+   It also links in some additional runtime support libraries.
+
+   Run a full rebuild after changing this setting (or :envvar:`SANITIZERS`)::
+
+       make clean components-clean
+       make
+
+   .. note::
+
+      Applications cannot link when this setting is enabled as sanitizer runtime libraries
+      are not currently available for embedded toolchains.
+
+      With Host builds using :envvar:`CLANG_BUILD`, all runtime libraries should already be available.
+      For GCC you will also need to install ``libasan`` and ``libubsan``.
+
+
+.. envvar:: SANITIZERS
+
+   Selects which sanitizers are used. See :envvar:`ENABLE_SANITIZERS`.
+
+
 Release builds
 ~~~~~~~~~~~~~~