← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/lockable_files.py

  • Committer: Martin Pool
  • Date: 2006-03-03 02:47:03 UTC
  • mto: This revision was merged to the branch mainline in revision 1593.
  • Revision ID: mbp@sourcefrog.net-20060303024703-fef1181ba3398271
More explanation for LockableFiles

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/lockable_files.py
29
29
 
30
30
 
31
31
class LockableFiles(object):
32
 
    """Object representing a set of files locked within the same scope
 
32
    """Object representing a set of related files locked within the same scope.
 
33
 
 
34
    These files are used by a WorkingTree, Repository or Branch, and should
 
35
    generally only be touched by that object.
 
36
 
 
37
    LockableFiles also provides some policy on top of Transport for encoding
 
38
    control files as utf-8.
 
39
 
 
40
    Instances of this class are often called control_files.
 
41
    
 
42
    This object builds on top of a Transport, which is used to actually 
 
43
    write the files to disk, and a Lock or LockDir, which controls how 
 
44
    access to the files is controlled.  The particular type of locking used
 
45
    is set when the object is constructed.
 
46
 
 
47
    This class 
33
48
 
34
49
    _lock_mode
35
50
        None, or 'r' or 'w'