From: Matt Corallo Date: Fri, 11 Sep 2020 23:35:16 +0000 (-0400) Subject: Note that genbindings.sh is really also a test script. X-Git-Tag: v0.0.12~29^2~2 X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=53182a8cec76490129a422213dbbba26e5b96936;p=rust-lightning Note that genbindings.sh is really also a test script. --- diff --git a/lightning-c-bindings/README.md b/lightning-c-bindings/README.md index fa33a9f4..72426bdf 100644 --- a/lightning-c-bindings/README.md +++ b/lightning-c-bindings/README.md @@ -222,6 +222,12 @@ These include: **It is highly recommended that you test any code which relies on the C (or C++) bindings in valgrind, AddressSanitizer, MemorySanitizer, or other similar tools to ensure correctness.** +Process +======= + +`genbindings.sh` is currently a catch-all script for bindings - it generates the latest Rust/C/C++ +code for bindings from the rust-lightning source code, builds it, and then runs various test apps. + Note that after running `genbindings.sh`, if possible, the static lib in target/debug (eg target/debug/liblightning.a) will be linked with address sanitizer. In order to build against it, you will need to link with `clang` with `-fsanitize=address` with the same version of LLVM as