Rev 3203: Update GraphIndex documentation. in http://people.ubuntu.com/~robertc/baz2.0/index.hashed

[Robert Collins]

At http://people.ubuntu.com/~robertc/baz2.0/index.hashed

------------------------------------------------------------
revno: 3203
revision-id:robertc at robertcollins.net-20080127054739-2ryl6fjj1fuyfnjo
parent: robertc at robertcollins.net-20080127054626-tr8weet92u1x5ls2
committer: Robert Collins <robertc at robertcollins.net>
branch nick: index.hashed
timestamp: Sun 2008-01-27 16:47:39 +1100
message:
  Update GraphIndex documentation.
modified:
  bzrlib/index.py                index.py-20070712131115-lolkarso50vjr64s-1
=== modified file 'bzrlib/index.py'
--- a/bzrlib/index.py	2008-01-27 05:46:26 +0000
+++ b/bzrlib/index.py	2008-01-27 05:47:39 +0000
@@ -302,10 +302,8 @@
 
     It is presumed that the index will not be mutated - it is static data.
 
-    Successive iter_all_entries calls will read the entire index each time.
-    Additionally, iter_entries calls will read the index linearly until the
-    desired keys are found. XXX: This must be fixed before the index is
-    suitable for production use. :XXX
+    Successive iter_all_entries calls return results from a cache within the
+    index object, if those results have already been parsed.
     """
 
     def __init__(self, transport, name, size):