summaryrefslogtreecommitdiff
path: root/FreeRTOS/Test/CMock/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'FreeRTOS/Test/CMock/Readme.md')
-rw-r--r--FreeRTOS/Test/CMock/Readme.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/FreeRTOS/Test/CMock/Readme.md b/FreeRTOS/Test/CMock/Readme.md
index 059f65303..e5ce98f8a 100644
--- a/FreeRTOS/Test/CMock/Readme.md
+++ b/FreeRTOS/Test/CMock/Readme.md
@@ -60,6 +60,11 @@ $ make coverage
Would build all unit tests, runs them one after the other, then generates html code
coverage and places them in build/coverage with initial file index.html
+## Runing tests with Address Sanitizer enabled ##
+The GCC address sanitizer can be enabled by passing in "ENABLE_SANITIZER=1" when calling make.
+
+Note: Enabling the address sanitizer will introduce additional branches that may not be possible to get test coverage of. For this reason, the address sanitizer is not enabled by default. It is recommended that developers enable the address sanitizer when modifying or developing new test cases.
+
## Running individual tests
From each test directory, you can build, run the test, and generate gcov coverage with the default "all" target like so:
```