diff options
author | Evan Huus <eapache@gmail.com> | 2012-12-27 22:57:05 +0000 |
---|---|---|
committer | Evan Huus <eapache@gmail.com> | 2012-12-27 22:57:05 +0000 |
commit | 439eaf4aa5d3de5229bf696ca0caa21ad19fd2dc (patch) | |
tree | 2cf31c019895a2e7278ee436bab9a6314ba99176 | |
parent | 442b61d0a41b18951366a17e8f612d1ccbb00a1a (diff) |
Add documentation about the environment variable.
svn path=/trunk/; revision=46817
-rw-r--r-- | doc/README.wmem | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/README.wmem b/doc/README.wmem index 1475d242e1..afba6025cd 100644 --- a/doc/README.wmem +++ b/doc/README.wmem @@ -158,6 +158,12 @@ helper functions in their headers). The "myPool" variable can be passed around and used as normal in allocation requests as described in section 2 of this document. +Note that the type of pool you request won't always be the type you get - the +WIRESHARK_DEBUG_WMEM_OVERRIDE environment variable (if set) can be used to +force all calls to wmem_allocator_new() to returns a specific type for debugging +purposes. It will always be safe to call allocator-specific helpers though, they +will simply be no-ops if the type doesn't match. + 3.3 Destroying a Pool Regardless of which allocator you used to create a pool, it can be destroyed |