Version 0.9.0

[ocaml-ancient.git] / README.txt

diff --git a/README.txt b/README.txt
index 1525c30..e2d9103 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -1,6 +1,5 @@
 'Ancient' module for OCaml
 ----------------------------------------------------------------------
-$Id: README.txt,v 1.4 2006-10-13 14:13:06 rich Exp $
 
 What does this module do?
 ----------------------------------------------------------------------
@@ -67,6 +66,9 @@ uses the Ancient module:
 Example
 ----------------------------------------------------------------------
 
+XXX Note the example code is really stupid, and fails for large
+dictionaries.  See bug (10) below.
+
 Run:
 
   ulimit -s unlimited
@@ -237,6 +239,13 @@ they are OK.
 
 The solution to this bug is non-trivial.
 
+(10) Example code is very stupid.  It fails with large dictionaries,
+eg. the one with nearly 500,000 words found in Fedora.
+
+(11) In function 'mark', the "// Ran out of memory.  Recover and throw
+an exception." codepath actually fails if you use it - segfaulting
+inside do_restore.
+
 Authors
 ----------------------------------------------------------------------