/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/transform.py

  • Committer: Aaron Bentley
  • Date: 2007-11-25 16:42:55 UTC
  • mto: This revision was merged to the branch mainline in revision 3023.
  • Revision ID: aaron.bentley@utoronto.ca-20071125164255-e1b2xnv0ssn6naif
Documentation tweaks for TreeTransform

Show diffs side-by-side

added added

removed removed

Lines of Context:
106
106
    Limbo
107
107
    -----
108
108
    Limbo is a temporary directory use to hold new versions of files.
109
 
    Files are added to limbo by new_file, new_directory, new_symlink, and their
110
 
    convenience variants (create_*).  Files may be removed from limbo using
111
 
    cancel_creation.  Files are renamed from limbo into their final location as
112
 
    part of TreeTransform.apply
 
109
    Files are added to limbo by create_file, create_directory, create_symlink,
 
110
    and their convenience variants (new_*).  Files may be removed from limbo
 
111
    using cancel_creation.  Files are renamed from limbo into their final
 
112
    location as part of TreeTransform.apply
113
113
 
114
114
    Limbo must be cleaned up, by either calling TreeTransform.apply or
115
115
    calling TreeTransform.finalize.
116
116
 
117
117
    Files are placed into limbo inside their parent directories, where
118
118
    possible.  This reduces subsequent renames, and makes operations involving
119
 
    lots of files faster.  This is only possible if the parent directory
120
 
    is created *before* creating any of its children.
 
119
    lots of files faster.  This optimization is only possible if the parent
 
120
    directory is created *before* creating any of its children, so avoid
 
121
    creating children before parents, where possible.
121
122
 
122
123
    Pending-deletion
123
124
    ----------------
124
125
    This temporary directory is used by _FileMover for storing files that are
125
 
    about to be deleted.  FileMover does not delete files until it is
126
 
    sure that a rollback will not happen.  In case of rollback, the files
127
 
    will be restored.
 
126
    about to be deleted.  In case of rollback, the files will be restored.
 
127
    FileMover does not delete files until it is sure that a rollback will not
 
128
    happen.  
128
129
    """
129
130
    def __init__(self, tree, pb=DummyProgress()):
130
131
        """Note: a tree_write lock is taken on the tree.