/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Robert Collins
  • Date: 2008-06-17 05:02:34 UTC
  • mto: This revision was merged to the branch mainline in revision 3510.
  • Revision ID: robertc@robertcollins.net-20080617050234-knib0hpz6pjx3sl1
Review feedback, making things more clear, adding documentation on what is used where.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/repository.py
446
446
    revisions and file history.  It's normally accessed only by the Branch,
447
447
    which views a particular line of development through that history.
448
448
 
449
 
    The Repository builds on top of Stores and a Transport, which respectively 
450
 
    describe the disk data format and the way of accessing the (possibly 
 
449
    The Repository builds on top of some byte storage facilies (the revisions,
 
450
    signatures, inventories and texts attributes) and a Transport, which
 
451
    respectively provide byte storage and a means to access the (possibly
451
452
    remote) disk.
452
453
 
 
454
    The byte storage facilities are addressed via tuples, which we refer to
 
455
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
 
456
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
 
457
    (file_id, revision_id). We use this interface because it allows low
 
458
    friction with the underlying code that implements disk indices, network
 
459
    encoding and other parts of bzrlib.
 
460
 
453
461
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
454
462
        the serialised revisions for the repository. This can be used to obtain
455
463
        revision graph information or to access raw serialised revisions.
456
464
        The result of trying to insert data into the repository via this store
457
465
        is undefined: it should be considered read-only except for implementors
458
466
        of repositories.
 
467
    :ivar signatures: A bzrlib.versionedfile.VersionedFiles instance containing
 
468
        the serialised signatures for the repository. This can be used to
 
469
        obtain access to raw serialised signatures.  The result of trying to
 
470
        insert data into the repository via this store is undefined: it should
 
471
        be considered read-only except for implementors of repositories.
 
472
    :ivar inventories: A bzrlib.versionedfile.VersionedFiles instance containing
 
473
        the serialised inventories for the repository. This can be used to
 
474
        obtain unserialised inventories.  The result of trying to insert data
 
475
        into the repository via this store is undefined: it should be
 
476
        considered read-only except for implementors of repositories.
 
477
    :ivar texts: A bzrlib.versionedfile.VersionedFiles instance containing the
 
478
        texts of files and directories for the repository. This can be used to
 
479
        obtain file texts or file graphs. Note that Repository.iter_file_bytes
 
480
        is usually a better interface for accessing file texts.
 
481
        The result of trying to insert data into the repository via this store
 
482
        is undefined: it should be considered read-only except for implementors
 
483
        of repositories.
459
484
    :ivar _transport: Transport for file access to repository, typically
460
485
        pointing to .bzr/repository.
461
486
    """