From 02d28f2920d9e88445bbfa5885dad91e7e049e8d Mon Sep 17 00:00:00 2001 From: Rick Altherr Date: Fri, 12 Jan 2018 10:33:33 -0800 Subject: [PATCH] Document how to enable test and build with debug info Signed-off-by: Rick Altherr --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 4f1c3cc1..44542944 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,22 @@ Creating HTML documentation: cd fuzzers/010-lutinit make -j$(nproc) run +Tests are not built by default. Setting the PRJXRAY\_BUILD\_TESTING option to +ON when running cmake will include them: + + cmake -DPRJXRAY_BUILD_TESTING=ON .. + make + +The default C++ build configuration is for releases (optimizations enabled, no +debug info). A build configuration for debugging (no optimizations, debug info) +can be chosen via the CMAKE\_BUILD\_TYPE option: + + cmake -DCMAKE_BUILD_TYPE=Debug .. + make + +The options to build tests and use a debug build configuration are independent +to allow testing that optimizations do not cause bugs. The build configuration +and build tests options may be combined to allow all permutations. # Process