aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEvan Huus <eapache@gmail.com>2013-06-18 21:47:18 +0000
committerEvan Huus <eapache@gmail.com>2013-06-18 21:47:18 +0000
commit8e060a2ad5973f27292a29f5b2bd5533abe8fb4f (patch)
treeda227b6d70f71d9cfb268b718c1cfd832c052c56 /doc
parent868f74d62898402784819d575639958f47102dcf (diff)
Update READMEs.
svn path=/trunk/; revision=50020
Diffstat (limited to 'doc')
-rw-r--r--doc/README.malloc9
-rw-r--r--doc/README.wmem24
2 files changed, 14 insertions, 19 deletions
diff --git a/doc/README.malloc b/doc/README.malloc
index 76ebb38ac3..a62291f0bb 100644
--- a/doc/README.malloc
+++ b/doc/README.malloc
@@ -1,11 +1,10 @@
$Id$
IMPORTANT NOTE:
- The emem interface (as described in this file) is gradually being
- deprecated. Please use wmem (as described in README.wmem) for new code
- where possible. This file is left as a reference since a great deal of
- existing code still uses emem, and because wmem does not yet have
- complete feature-parity with emem.
+ The emem interface (as described in this file) is deprecated.
+ Please use wmem (as described in README.wmem) for all new code.
+ This file is left as a reference since a great deal of existing
+ code still uses emem.
1. Introduction
diff --git a/doc/README.wmem b/doc/README.wmem
index be6662516c..d49dfb7b11 100644
--- a/doc/README.wmem
+++ b/doc/README.wmem
@@ -2,19 +2,15 @@ $Id$
1. Introduction
-NB: Wmem still does not provide all of the functionality of emem
- (see README.malloc), although it should provide most of it. New code
- may still need to use emem for the time being.
-
The 'emem' memory manager (described in README.malloc) has been a part of
Wireshark since 2005 and has served us well, but is starting to show its age.
The framework has become increasingly difficult to maintain, and limitations
in the API have blocked progress on other long-term goals such as multi-
threading, and opening multiple files at once.
-The 'wmem' memory manager is an attempt to write a new memory management
-framework to replace emem. It provides a significantly updated API, a more
-modular design, and it isn't all jammed into one 2500-line file.
+The 'wmem' memory manager is a new memory management framework that replaces
+emem. It provides a significantly updated API, a more modular design, and it
+isn't all jammed into one 2500-line file.
Wmem was originally conceived in this email to the wireshark-dev mailing list:
https://www.wireshark.org/lists/wireshark-dev/201210/msg00178.html
@@ -105,6 +101,11 @@ wmem_stack.h
wmem_tree.h
- A red-black tree implementation.
+2.2.4 Miscellanious Utilities
+
+wmem_miscutl.h
+ - Misc. utility functions like memdup.
+
2.3 Callbacks
WARNING: You probably don't actually need these; use them only when you're
@@ -329,13 +330,8 @@ intimately familiar with Glib's testing framework, but it does the job.
5. TODO List
-The following is an incomplete list of things that emem provides but wmem has
-not yet implemented:
-
- - tvb_memdup
-
-The following is a list of things that emem doesn't provide but that it might
-be nice if wmem did provide them:
+The following is a list of things that emem didn't provide but that it might
+be nice if wmem did:
- radix tree
- dynamic array