Skip to content

Commit 83b18e7

Browse files
committed
Note that genbindings.sh is really also a test script.
1 parent bb40560 commit 83b18e7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

lightning-c-bindings/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,12 @@ These include:
222222
**It is highly recommended that you test any code which relies on the C (or C++) bindings in
223223
valgrind, AddressSanitizer, MemorySanitizer, or other similar tools to ensure correctness.**
224224
225+
Process
226+
=======
227+
228+
`genbindings.sh` is currently a catch-all script for bindings - it generates the latest Rust/C/C++
229+
code for bindings from the rust-lightning source code, builds it, and then runs various test apps.
230+
225231
Note that after running `genbindings.sh`, if possible, the static lib in target/debug (eg
226232
target/debug/liblightning.a) will be linked with address sanitizer. In order to build against it,
227233
you will need to link with `clang` with `-fsanitize=address` with the same version of LLVM as

0 commit comments

Comments
 (0)