From 702336ec07caf86d398fd0b73da1770bcfc53e95 Mon Sep 17 00:00:00 2001 From: wspear Date: Mon, 4 Mar 2024 13:41:31 -0800 Subject: [PATCH] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 45a894e..460aaf6 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ for testing with both GCC and Clang. ### 3. Configure and build SALT: This step is most easily performed in the [salt-dev] container, -but can also be performed in a suitable installation of LLVM and Clang are present. +but can also be performed if a suitable installation of LLVM and Clang are present. ``` shell # Tell CMake to use the clang/clang++ compiler to build SALT @@ -75,6 +75,8 @@ export CXX=clang++ cmake -Wdev -Wdeprecated -S . -B build cmake --build build --parallel # Add --verbose to debug something going wrong ``` +To specify a TAU installation for testing other than the one used by the [salt-dev] container +you can add `-DTAU_ROOT=` to the first cmake invocation. If the Ninja build system is present and you prefer it to Makefiles (it's already present in the [salt-dev] container image), @@ -107,12 +109,10 @@ The tests are all located in the `tests` subdirectory of the project. * New profiles are moved to subdirectories indicating which test they are assosciated with By default the tests assume a TAU installation matching the [salt-dev] -development image. -If you don't have a GCC and Clang configuration of TAU installed into the default location -(`/usr/local/x86_64/`) then some of the tests will fail. +development image (located at `/usr/local/x86_64/` with a GCC and Clang configuration). -Alternatively you can add `-DTAU_ROOT=` to the cmake invocation to point the tests -to a different location. The tests require TAU to be built with these two configurations: +To use a different TAU installation add `-DTAU_ROOT=` to the cmake invocation. +The specified directory should point to a TAU install built with at least these two configurations: `-pthread -cc=clang -c++=clang++ -bfd=download -unwind=download -dwarf=download -otf=download`