Rev 3012: Documentation update for TreeTransform, suggested by Michael Hudson in file:///home/pqm/archives/thelove/bzr/%2Btrunk/
Canonical.com Patch Queue Manager
pqm at pqm.ubuntu.com
Thu Nov 22 05:09:41 GMT 2007
At file:///home/pqm/archives/thelove/bzr/%2Btrunk/
------------------------------------------------------------
revno: 3012
revision-id: pqm at pqm.ubuntu.com-20071122050938-la5hkrql1mag6u7p
parent: pqm at pqm.ubuntu.com-20071122042129-w0k63wqlxo09i4xb
parent: abentley at panoramicfeedback.com-20071121222444-l8qropwv3vcedv1j
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Thu 2007-11-22 05:09:38 +0000
message:
Documentation update for TreeTransform, suggested by Michael Hudson
modified:
bzrlib/transform.py transform.py-20060105172343-dd99e54394d91687
------------------------------------------------------------
revno: 1551.2.49.1.40.1.22.1.42.1.31.1.39.1.17.1.77.1.3.1.20.1.2
merged: abentley at panoramicfeedback.com-20071121222444-l8qropwv3vcedv1j
parent: abentley at panoramicfeedback.com-20071121222401-ygfx2bujtuuw29uz
parent: pqm at pqm.ubuntu.com-20071121045727-gqycrul94d0ssir1
committer: Aaron Bentley <abentley at panoramicfeedback.com>
branch nick: Aaron's mergeable stuff
timestamp: Wed 2007-11-21 17:24:44 -0500
message:
Merge from bzr.dev
------------------------------------------------------------
revno: 1551.2.49.1.40.1.22.1.42.1.31.1.39.1.17.1.77.1.3.1.20.1.1
merged: abentley at panoramicfeedback.com-20071121222401-ygfx2bujtuuw29uz
parent: abentley at panoramicfeedback.com-20071019135148-7567ag3iu82is1xk
committer: Aaron Bentley <abentley at panoramicfeedback.com>
branch nick: Aaron's mergeable stuff
timestamp: Wed 2007-11-21 17:24:01 -0500
message:
Documentation update for TreeTransform, suggested by Michael Hudson
=== modified file 'bzrlib/transform.py'
--- a/bzrlib/transform.py 2007-10-26 19:18:48 +0000
+++ b/bzrlib/transform.py 2007-11-21 22:24:44 +0000
@@ -89,6 +89,41 @@
* create_file or create_directory or create_symlink
* version_file
* set_executability
+
+ Transform/Transaction ids
+ -------------------------
+ trans_ids are temporary ids assigned to all files involved in a transform.
+ It's possible, even common, that not all files in the Tree have trans_ids.
+
+ trans_ids are used because filenames and file_ids are not good enough
+ identifiers; filenames change, and not all files have file_ids. File-ids
+ are also associated with trans-ids, so that moving a file moves its
+ file-id.
+
+ trans_ids are only valid for the TreeTransform that generated them.
+
+ Limbo
+ -----
+ Limbo is a temporary directory use to hold new versions of files.
+ Files are added to limbo by new_file, new_directory, new_symlink, and their
+ convenience variants (create_*). Files may be removed from limbo using
+ cancel_creation. Files are renamed from limbo into their final location as
+ part of TreeTransform.apply
+
+ Limbo must be cleaned up, by either calling TreeTransform.apply or
+ calling TreeTransform.finalize.
+
+ Files are placed into limbo inside their parent directories, where
+ possible. This reduces subsequent renames, and makes operations involving
+ lots of files faster. This is only possible if the parent directory
+ is created *before* creating any of its children.
+
+ Pending-deletion
+ ----------------
+ This temporary directory is used by _FileMover for storing files that are
+ about to be deleted. FileMover does not delete files until it is
+ sure that a rollback will not happen. In case of rollback, the files
+ will be restored.
"""
def __init__(self, tree, pb=DummyProgress()):
"""Note: a tree_write lock is taken on the tree.
@@ -120,9 +155,13 @@
self._tree.unlock()
raise
+ # counter used to generate trans-ids (which are locally unique)
self._id_number = 0
+ # mapping of trans_id -> new basename
self._new_name = {}
+ # mapping of trans_id -> new parent trans_id
self._new_parent = {}
+ # mapping of trans_id with new contents -> new file_kind
self._new_contents = {}
# A mapping of transform ids to their limbo filename
self._limbo_files = {}
@@ -133,22 +172,35 @@
self._limbo_children_names = {}
# List of transform ids that need to be renamed from limbo into place
self._needs_rename = set()
+ # Set of trans_ids whose contents will be removed
self._removed_contents = set()
+ # Mapping of trans_id -> new execute-bit value
self._new_executability = {}
+ # Mapping of trans_id -> new tree-reference value
self._new_reference_revision = {}
+ # Mapping of trans_id -> new file_id
self._new_id = {}
+ # Mapping of old file-id -> trans_id
self._non_present_ids = {}
+ # Mapping of new file_id -> trans_id
self._r_new_id = {}
+ # Set of file_ids that will be removed
self._removed_id = set()
+ # Mapping of path in old tree -> trans_id
self._tree_path_ids = {}
+ # Mapping trans_id -> path in old tree
self._tree_id_paths = {}
# Cache of realpath results, to speed up canonical_path
self._realpaths = {}
# Cache of relpath results, to speed up canonical_path
self._relpaths = {}
+ # The trans_id that will be used as the tree root
self._new_root = self.trans_id_tree_file_id(tree.get_root_id())
+ # Indictor of whether the transform has been applied
self.__done = False
+ # A progress bar
self._pb = pb
+ # A counter of how many files have been renamed
self.rename_count = 0
def __get_root(self):
More information about the bazaar-commits
mailing list