osmocom
/
wireshark
11
0
Fork 1
Code Issues Pull Requests Projects Releases Wiki Activity

Update READMEs. 

svn path=/trunk/; revision=50020
This commit is contained in:
Evan Huus 2013-06-18 21:47:18 +00:00
parent 868f74d628
commit 8e060a2ad5
2 changed files with 14 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/README.malloc
View File

@ -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

24
doc/README.wmem
View File

@ -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