Update wmem docs to include new type field.

svn path=/trunk/; revision=46815

1 files changed, 11 insertions, 3 deletions

diff --git a/doc/README.wmem b/doc/README.wmem
index dc8c6ab70b..1475d242e1 100644
--- a/doc/README.wmem
+++ b/doc/README.wmem
@@ -214,15 +214,18 @@ class' to those of you who are more familiar with C++).
 
 Different allocator implementations can provide exactly the same interface by
 assigning their own functions (of the appropriate signature) to the members of
-an instance of the structure. The structure currently has four values:
+an instance of the structure. The structure currently has five values:
 
  - alloc()
  - free_all()
  - destroy()
  - private_data
+ - type
 
 The private_data pointer is a void pointer that the implementation can use to
-store whatever internal structures it needs. The other three functions should
+store whatever internal structures it needs. The type field is an enumeration of
+type wmem_allocator_type_t (see section 3.1) set by the wmem_allocator_new()
+function and not by the implementation. The three function pointers should
 be fairly obvious - each one is called with a pointer to the private_data in
 addition to any other arguments.
 
@@ -242,10 +245,15 @@ pointer is stored internally with the data structure, and subsequent calls
 
 5. TODO List
 
+The following is a list of things that wmem provides but are incomplete
+(i.e. missing common operations):
+
+ - string buffers
+ - singly-linked list
+
 The following is an incomplete list of things that emem provides but wmem has
 not yet implemented:
 
- - strbuf
  - red-black tree
  - tvb_memdup
  - canaries