summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Mann <mmann78@netscape.net>2016-05-12 13:39:15 -0400
committerMichael Mann <mmann78@netscape.net>2016-05-13 16:00:58 +0000
commit4d4190f12791ca04599c616800b6f7803b1d5f54 (patch)
tree1bd25c14b2cb3a28ff7e4ea61c2710ce1349e713 /doc
parentf3e120816c1e74eda131f95a74e61777995c2c7b (diff)
downloadwireshark-4d4190f12791ca04599c616800b6f7803b1d5f54.tar.gz
Have wmem conform to checkAPIs.pl
Yes, the rename of structure members is a bit hacky. Yes, catering to Windows since "GLib's v*printf routines are surprisingly slow on Windows". But it does pass checkAPIs.pl Change-Id: I5b1552472c83aa2e159f17b5b7eb70b37d03eff9 Reviewed-on: https://code.wireshark.org/review/15404 Reviewed-by: Michael Mann <mmann78@netscape.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/README.wmem12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/README.wmem b/doc/README.wmem
index 455a608f88..7751a7ba7d 100644
--- a/doc/README.wmem
+++ b/doc/README.wmem
@@ -255,15 +255,15 @@ read-only by the allocator implementation.
4.1.2 Consumer Functions
- - alloc()
- - free()
- - realloc()
+ - walloc()
+ - wfree()
+ - wrealloc()
These function pointers should be set to functions with semantics obviously
similar to their standard-library namesakes. Each one takes an extra parameter
that is a copy of the allocator's private_data pointer.
-Note that realloc() and free() are not expected to be called directly by user
+Note that wrealloc() and wfree() are not expected to be called directly by user
code in most cases - they are primarily optimisations for use by data
structures that wmem might want to implement (it's inefficient, for example, to
implement a dynamically sized array without some form of realloc).
@@ -271,8 +271,8 @@ implement a dynamically sized array without some form of realloc).
Also note that allocators do not have to handle NULL pointers or 0-length
requests in any way - those checks are done in an allocator-agnostic way
higher up in wmem. Allocator authors can assume that all incoming pointers
-(to realloc and free) are non-NULL, and that all incoming lengths (to malloc
-and realloc) are non-0.
+(to wrealloc and wfree) are non-NULL, and that all incoming lengths (to walloc
+and wrealloc) are non-0.
4.1.3 Producer/Manager Functions