summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorGustavo Sverzut Barbieri <barbieri@gmail.com>2013-01-07 22:24:53 +0000
committerGustavo Sverzut Barbieri <barbieri@gmail.com>2013-01-07 22:24:53 +0000
commit5286e5bfe01e48f1ea55eba1dfa4dabc07fb20b4 (patch)
treea381ec68047e1057718458949eeeb2e381a93699 /README
parenta69ba655a2ad566f68dd98d0bbc38a4280e50a1a (diff)
downloadefl-5286e5bfe01e48f1ea55eba1dfa4dabc07fb20b4.tar.gz
efl: add back valgrind check, with enable option and warning.
SVN revision: 82368
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 18 insertions, 0 deletions
diff --git a/README b/README
index d3d6257499..4b19c23c8b 100644
--- a/README
+++ b/README
@@ -11,6 +11,24 @@ EFL is a collection of libraries for handling many common tasks a
developer man have such as data structures, communication, rendering,
widgets and more.
+VALGRIND DEPENDENCY:
+------------------------------------------------------------------------------
+EFL uses the concept of memory pools (mempool) and this will confuse
+valgrind memcheck tool. By using memory pool, the memory is still
+owned by EFL, then valgrind won't alert on memory leaks or use of
+unused memory. EFL will use memcheck.h from valgrind to declare its
+memory pools to valgrind, producing better debugging results.
+
+However valgrind is only available to limited platforms, making us
+hard to declare it a mandatory requirement. Based on
+--with-profile={dev,debug} valgrind will be used if available or will
+be issued a warning. You can force valgrind with --enable-valgrind, or
+disable it and the warning with --disable-valgrind.
+
+EFL does NOT link to valgrind libraries. Then there is NO runtime
+dependency on valgrind.
+
+
BULLET PHYSICS DEPENDENCY:
------------------------------------------------------------------------------
EFL comes with EPhysics(a physics wrapper library) enabled by default, to