From 8a30bafeac883757e5c4f3eb54c195530dfdc42d Mon Sep 17 00:00:00 2001 From: Tom Finegan Date: Wed, 13 Sep 2017 11:35:34 -0700 Subject: [PATCH] Add information about sanitizer support to README.md. BUG=aomedia:736 Change-Id: I628b809caf98215ff2082eca3926247da555f9d3 --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 533a1daab..773fc40d4 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,20 @@ In addition to the above it's important to note that the toolchain files suffixed with gcc behave differently than the others. These toolchain files attempt to obey the $CROSS environment variable. +### Sanitizers + +Sanitizer integration is built-in to the CMake build system. To enable a +sanitizer, add `-DSANITIZE=` to the CMake command line. For example, to +enable address sanitizer: + +~~~ + $ cmake path/to/aom -DSANITIZE=address + $ make +~~~ + +Sanitizers available vary by platform, target, and compiler. Consult your +compiler documentation to determine which, if any, are available. + ### Microsoft Visual Studio builds Building the AV1 codec library in Microsoft Visual Studio is supported. The -- GitLab