← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/index.py

  • Committer: Robert Collins
  • Date: 2007-07-15 07:31:37 UTC
  • mto: (2592.3.29 repository)
  • mto: This revision was merged to the branch mainline in revision 2624.
  • Revision ID: robertc@robertcollins.net-20070715073137-cd9kb764q4e40o0f
Tweak documentation as per Aaron's review.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/index.py
176
176
    The index maps keys to a list of key reference lists, and a value.
177
177
    Each node has the same number of key reference lists. Each key reference
178
178
    list can be empty or an arbitrary length. The value is an opaque NULL
179
 
    terminated string without any newlines.
 
179
    terminated string without any newlines. The storage of the index is 
 
180
    hidden in the interface: keys and key references are always bytestrings,
 
181
    never the internal representation (e.g. dictionary offsets).
180
182
 
181
183
    It is presumed that the index will not be mutated - it is static data.
182
184
 
284
286
    
285
287
    The backing indices must implement GraphIndex, and are presumed to be
286
288
    static data.
 
289
 
 
290
    Queries against the combined index will be made against the first index,
 
291
    and then the second and so on. The order of index's can thus influence
 
292
    performance significantly. For example, if one index is on local disk and a
 
293
    second on a remote server, the local disk index should be before the other
 
294
    in the index list.
287
295
    """
288
296
 
289
297
    def __init__(self, indices):
290
298
        """Create a CombinedGraphIndex backed by indices.
291
299
 
292
 
        :param indices: The indices to query for data.
 
300
        :param indices: An ordered list of indices to query for data.
293
301
        """
294
302
        self._indices = indices
295
303