aboutsummaryrefslogtreecommitdiff
path: root/flatcc/test/README.md
diff options
context:
space:
mode:
authorToni Uhlig <matzeton@googlemail.com>2023-07-16 02:03:33 +0200
committerToni Uhlig <matzeton@googlemail.com>2023-07-16 02:03:33 +0200
commitb31e4bc16d1df62b50c6f77a77041f9e7b6c906d (patch)
tree024c74c13d918aa6bde302aab6836fa33607613c /flatcc/test/README.md
parentba6815ef8fb8ae472412b5af2837a7caba2799c2 (diff)
parent5a40295c4cf0af5ea8da9ced04a4ce7d3621a080 (diff)
Merge commit '5a40295c4cf0af5ea8da9ced04a4ce7d3621a080' as 'flatcc'
Diffstat (limited to 'flatcc/test/README.md')
-rw-r--r--flatcc/test/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/flatcc/test/README.md b/flatcc/test/README.md
new file mode 100644
index 0000000..4c0b485
--- /dev/null
+++ b/flatcc/test/README.md
@@ -0,0 +1,19 @@
+NOTE: shell scripts driven by flatcc/test/test.sh have been ported to CMake.
+use flatcc/scripts/test.sh to drive CMake tests.
+
+Run `leakcheck.sh` and `leakcheck-full.sh` for memory checks.
+
+To install valgrind on OS-X Yosemite use `brew install --HEAD valgrind`
+
+For decoding valgrind error messages:
+<http://derickrethans.nl/valgrind-null.html>
+
+clang has built-in memory check, but only for `x86_64 Linux`:
+<http://clang.llvm.org/docs/LeakSanitizer.html>
+
+On OS-X Yosemite with valgrind that isn't officially supported for that
+platform, a few spurious unitialized memory access errors are reported
+when printing the filextension in `codegen_c.c`. and in the equivalent
+builder. After inspection, nothing suggests this is an actual bug - more
+likely it relates to a strnlen optimization in fprintf `"%.*s"` syntax
+that valgrind doesn't catch.