Skip to content

Commit 084d008

Browse files
committed
f readme - note about addr san default
1 parent ddc314d commit 084d008

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

lightning-c-bindings/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,4 +219,10 @@ These include:
219219
```
220220
221221
**It is highly recommended that you test any code which relies on the C (or C++) bindings in
222-
valgrind, MemorySanitizer, or other similar tools to ensure correctness.**
222+
valgrind, AddressSanitizer, MemorySanitizer, or other similar tools to ensure correctness.**
223+
224+
Note that after running `genbindings.sh`, if possible, the static lib in target/debug (eg
225+
target/debug/liblightning.a) will be linked with address sanitizer. In order to build against it,
226+
you will need to link with `clang` with `-fsanitize=address` with the same version of LLVM as
227+
`rustc`'s LLVM. If genbindings.sh failed to find a matching `clang` or you are building on an
228+
unsupported platform, a warning noting that address sanitizer is not available will be printed.

0 commit comments

Comments
 (0)