From 39b8768a791bb168e7027b10402560eb9bcda3c5 Mon Sep 17 00:00:00 2001 From: "Reece H. Dunn" Date: Mon, 19 Mar 2018 21:01:20 +0000 Subject: [PATCH] README: Document building with -fsanitize options. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 27c925d9..5f9021c7 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ - [Dependencies](#dependencies) - [Building](#building-1) - [Cross Compilation](#cross-compilation) + - [Sanitizer](#sanitizer) - [eSpeak NG Feature Configuration](#espeak-ng-feature-configuration) - [Extended Dictionary Configuration](#extended-dictionary-configuration) - [Testing](#testing) @@ -176,6 +177,17 @@ built it locally you can perform the cross compilation using: ./configure --build=... --host=... --target=... make -B src/espeak-ng src/speak-ng +#### Sanitizer + +It is possible to build eSpeak NG with the gcc or clang sanitizer by passing +the appropriate `CFLAGS` and `LDFLAGS` options to `configure`. For example: + + CFLAGS="-fsanitize=address,undefined -g" \ + LDFLAGS="-fsanitize=address,undefined" \ + CC=clang-6.0 ./configure + make + make check + #### eSpeak NG Feature Configuration The following `configure` options control which eSpeak NG features are enabled: