~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2005-10-10 08:27:26 UTC
  • mfrom: (1185.15.9)
  • Revision ID: robertc@robertcollins.net-20051010082726-b709d6577691ba69
mergeĀ fromĀ upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
17
17
 
18
18
import sys
19
19
import os
 
20
import errno
 
21
from warnings import warn
 
22
from cStringIO import StringIO
 
23
 
20
24
 
21
25
import bzrlib
 
26
from bzrlib.inventory import InventoryEntry
 
27
import bzrlib.inventory as inventory
22
28
from bzrlib.trace import mutter, note
23
 
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
24
 
     splitpath, \
25
 
     sha_file, appendpath, file_kind
26
 
 
27
 
from bzrlib.errors import BzrError, InvalidRevisionNumber, InvalidRevisionId, \
28
 
     DivergedBranches, NotBranchError
 
29
from bzrlib.osutils import (isdir, quotefn, compact_date, rand_bytes, 
 
30
                            rename, splitpath, sha_file, appendpath, 
 
31
                            file_kind)
 
32
import bzrlib.errors as errors
 
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
 
34
                           NoSuchRevision, HistoryMissing, NotBranchError,
 
35
                           DivergedBranches, LockError, UnlistableStore,
 
36
                           UnlistableBranch, NoSuchFile)
29
37
from bzrlib.textui import show_status
30
38
from bzrlib.revision import Revision
31
39
from bzrlib.delta import compare_trees
32
40
from bzrlib.tree import EmptyTree, RevisionTree
33
 
import bzrlib.xml
 
41
from bzrlib.inventory import Inventory
 
42
from bzrlib.store import copy_all
 
43
from bzrlib.store.compressed_text import CompressedTextStore
 
44
from bzrlib.store.text import TextStore
 
45
from bzrlib.store.weave import WeaveStore
 
46
import bzrlib.transactions as transactions
 
47
from bzrlib.transport import Transport, get_transport
 
48
import bzrlib.xml5
34
49
import bzrlib.ui
35
50
 
36
51
 
37
 
 
38
 
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
 
52
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
 
53
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
 
54
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
39
55
## TODO: Maybe include checks for common corruption of newlines, etc?
40
56
 
41
57
 
42
58
# TODO: Some operations like log might retrieve the same revisions
43
59
# repeatedly to calculate deltas.  We could perhaps have a weakref
44
 
# cache in memory to make this faster.
 
60
# cache in memory to make this faster.  In general anything can be
 
61
# cached in memory between lock and unlock operations.
45
62
 
46
63
def find_branch(*ignored, **ignored_too):
47
64
    # XXX: leave this here for about one release, then remove it
48
65
    raise NotImplementedError('find_branch() is not supported anymore, '
49
66
                              'please use one of the new branch constructors')
50
 
 
51
67
def _relpath(base, path):
52
68
    """Return path relative to base, or raise exception.
53
69
 
75
91
    return os.sep.join(s)
76
92
        
77
93
 
78
 
def find_branch_root(f=None):
79
 
    """Find the branch root enclosing f, or pwd.
80
 
 
81
 
    f may be a filename or a URL.
82
 
 
83
 
    It is not necessary that f exists.
 
94
def find_branch_root(t):
 
95
    """Find the branch root enclosing the transport's base.
 
96
 
 
97
    t is a Transport object.
 
98
 
 
99
    It is not necessary that the base of t exists.
84
100
 
85
101
    Basically we keep looking up until we find the control directory or
86
102
    run into the root.  If there isn't one, raises NotBranchError.
87
103
    """
88
 
    if f == None:
89
 
        f = os.getcwd()
90
 
    elif hasattr(os.path, 'realpath'):
91
 
        f = os.path.realpath(f)
92
 
    else:
93
 
        f = os.path.abspath(f)
94
 
    if not os.path.exists(f):
95
 
        raise BzrError('%r does not exist' % f)
96
 
        
97
 
 
98
 
    orig_f = f
99
 
 
 
104
    orig_base = t.base
100
105
    while True:
101
 
        if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
102
 
            return f
103
 
        head, tail = os.path.split(f)
104
 
        if head == f:
 
106
        if t.has(bzrlib.BZRDIR):
 
107
            return t
 
108
        new_t = t.clone('..')
 
109
        if new_t.base == t.base:
105
110
            # reached the root, whatever that may be
106
 
            raise NotBranchError('%s is not in a branch' % orig_f)
107
 
        f = head
108
 
 
109
 
 
 
111
            raise NotBranchError('%s is not in a branch' % orig_base)
 
112
        t = new_t
110
113
 
111
114
 
112
115
######################################################################
124
127
        raise NotImplementedError('The Branch class is abstract')
125
128
 
126
129
    @staticmethod
 
130
    def open_downlevel(base):
 
131
        """Open a branch which may be of an old format.
 
132
        
 
133
        Only local branches are supported."""
 
134
        return _Branch(get_transport(base), relax_version_check=True)
 
135
        
 
136
    @staticmethod
127
137
    def open(base):
128
138
        """Open an existing branch, rooted at 'base' (url)"""
129
 
        if base and (base.startswith('http://') or base.startswith('https://')):
130
 
            from bzrlib.remotebranch import RemoteBranch
131
 
            return RemoteBranch(base, find_root=False)
132
 
        else:
133
 
            return LocalBranch(base, find_root=False)
 
139
        t = get_transport(base)
 
140
        mutter("trying to open %r with transport %r", base, t)
 
141
        return _Branch(t)
134
142
 
135
143
    @staticmethod
136
144
    def open_containing(url):
137
 
        """Open an existing branch, containing url (search upwards for the root)
 
145
        """Open an existing branch which contains url.
 
146
        
 
147
        This probes for a branch at url, and searches upwards from there.
138
148
        """
139
 
        if url and (url.startswith('http://') or url.startswith('https://')):
140
 
            from bzrlib.remotebranch import RemoteBranch
141
 
            return RemoteBranch(url)
142
 
        else:
143
 
            return LocalBranch(url)
 
149
        t = get_transport(url)
 
150
        t = find_branch_root(t)
 
151
        return _Branch(t)
144
152
 
145
153
    @staticmethod
146
154
    def initialize(base):
147
155
        """Create a new branch, rooted at 'base' (url)"""
148
 
        if base and (base.startswith('http://') or base.startswith('https://')):
149
 
            from bzrlib.remotebranch import RemoteBranch
150
 
            return RemoteBranch(base, init=True)
151
 
        else:
152
 
            return LocalBranch(base, init=True)
 
156
        t = get_transport(base)
 
157
        return _Branch(t, init=True)
153
158
 
154
159
    def setup_caching(self, cache_root):
155
160
        """Subclasses that care about caching should override this, and set
156
161
        up cached stores located under cache_root.
157
162
        """
158
 
 
159
 
 
160
 
class LocalBranch(Branch):
 
163
        self.cache_root = cache_root
 
164
 
 
165
 
 
166
class _Branch(Branch):
161
167
    """A branch stored in the actual filesystem.
162
168
 
163
169
    Note that it's "local" in the context of the filesystem; it doesn't
181
187
    _lock_mode = None
182
188
    _lock_count = None
183
189
    _lock = None
184
 
 
185
 
    def __init__(self, base, init=False, find_root=True):
 
190
    _inventory_weave = None
 
191
    
 
192
    # Map some sort of prefix into a namespace
 
193
    # stuff like "revno:10", "revid:", etc.
 
194
    # This should match a prefix with a function which accepts
 
195
    REVISION_NAMESPACES = {}
 
196
 
 
197
    def push_stores(self, branch_to):
 
198
        """Copy the content of this branches store to branch_to."""
 
199
        if (self._branch_format != branch_to._branch_format
 
200
            or self._branch_format != 4):
 
201
            from bzrlib.fetch import greedy_fetch
 
202
            mutter("falling back to fetch logic to push between %s(%s) and %s(%s)",
 
203
                   self, self._branch_format, branch_to, branch_to._branch_format)
 
204
            greedy_fetch(to_branch=branch_to, from_branch=self,
 
205
                         revision=self.last_revision())
 
206
            return
 
207
 
 
208
        store_pairs = ((self.text_store,      branch_to.text_store),
 
209
                       (self.inventory_store, branch_to.inventory_store),
 
210
                       (self.revision_store,  branch_to.revision_store))
 
211
        try:
 
212
            for from_store, to_store in store_pairs: 
 
213
                copy_all(from_store, to_store)
 
214
        except UnlistableStore:
 
215
            raise UnlistableBranch(from_store)
 
216
 
 
217
    def __init__(self, transport, init=False,
 
218
                 relax_version_check=False):
186
219
        """Create new branch object at a particular location.
187
220
 
188
 
        base -- Base directory for the branch. May be a file:// url.
 
221
        transport -- A Transport object, defining how to access files.
 
222
                (If a string, transport.transport() will be used to
 
223
                create a Transport object)
189
224
        
190
225
        init -- If True, create new control files in a previously
191
226
             unversioned directory.  If False, the branch must already
192
227
             be versioned.
193
228
 
194
 
        find_root -- If true and init is false, find the root of the
195
 
             existing branch containing base.
 
229
        relax_version_check -- If true, the usual check for the branch
 
230
            version is not applied.  This is intended only for
 
231
            upgrade/recovery type use; it's not guaranteed that
 
232
            all operations will work on old format branches.
196
233
 
197
234
        In the test suite, creation of new trees is tested using the
198
235
        `ScratchBranch` class.
199
236
        """
200
 
        from bzrlib.store import ImmutableStore
 
237
        assert isinstance(transport, Transport), \
 
238
            "%r is not a Transport" % transport
 
239
        self._transport = transport
201
240
        if init:
202
 
            self.base = os.path.realpath(base)
203
241
            self._make_control()
204
 
        elif find_root:
205
 
            self.base = find_branch_root(base)
206
 
        else:
207
 
            if base.startswith("file://"):
208
 
                base = base[7:]
209
 
            self.base = os.path.realpath(base)
210
 
            if not isdir(self.controlfilename('.')):
211
 
                raise NotBranchError("not a bzr branch: %s" % quotefn(base),
212
 
                                     ['use "bzr init" to initialize a new working tree',
213
 
                                      'current bzr can only operate from top-of-tree'])
214
 
        self._check_format()
215
 
 
216
 
        self.text_store = ImmutableStore(self.controlfilename('text-store'))
217
 
        self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
218
 
        self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
219
 
 
 
242
        self._check_format(relax_version_check)
 
243
 
 
244
        def get_store(name, compressed=True, prefixed=False):
 
245
            # FIXME: This approach of assuming stores are all entirely compressed
 
246
            # or entirely uncompressed is tidy, but breaks upgrade from 
 
247
            # some existing branches where there's a mixture; we probably 
 
248
            # still want the option to look for both.
 
249
            relpath = self._rel_controlfilename(name)
 
250
            if compressed:
 
251
                store = CompressedTextStore(self._transport.clone(relpath),
 
252
                                            prefixed=prefixed)
 
253
            else:
 
254
                store = TextStore(self._transport.clone(relpath),
 
255
                                  prefixed=prefixed)
 
256
            #if self._transport.should_cache():
 
257
            #    cache_path = os.path.join(self.cache_root, name)
 
258
            #    os.mkdir(cache_path)
 
259
            #    store = bzrlib.store.CachedStore(store, cache_path)
 
260
            return store
 
261
        def get_weave(name, prefixed=False):
 
262
            relpath = self._rel_controlfilename(name)
 
263
            ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
 
264
            if self._transport.should_cache():
 
265
                ws.enable_cache = True
 
266
            return ws
 
267
 
 
268
        if self._branch_format == 4:
 
269
            self.inventory_store = get_store('inventory-store')
 
270
            self.text_store = get_store('text-store')
 
271
            self.revision_store = get_store('revision-store')
 
272
        elif self._branch_format == 5:
 
273
            self.control_weaves = get_weave([])
 
274
            self.weave_store = get_weave('weaves')
 
275
            self.revision_store = get_store('revision-store', compressed=False)
 
276
        elif self._branch_format == 6:
 
277
            self.control_weaves = get_weave([])
 
278
            self.weave_store = get_weave('weaves', prefixed=True)
 
279
            self.revision_store = get_store('revision-store', compressed=False,
 
280
                                            prefixed=True)
 
281
        self._transaction = None
220
282
 
221
283
    def __str__(self):
222
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
284
        return '%s(%r)' % (self.__class__.__name__, self._transport.base)
223
285
 
224
286
 
225
287
    __repr__ = __str__
227
289
 
228
290
    def __del__(self):
229
291
        if self._lock_mode or self._lock:
230
 
            from bzrlib.warnings import warn
 
292
            # XXX: This should show something every time, and be suitable for
 
293
            # headless operation and embedding
231
294
            warn("branch %r was not explicitly unlocked" % self)
232
295
            self._lock.unlock()
233
296
 
 
297
        # TODO: It might be best to do this somewhere else,
 
298
        # but it is nice for a Branch object to automatically
 
299
        # cache it's information.
 
300
        # Alternatively, we could have the Transport objects cache requests
 
301
        # See the earlier discussion about how major objects (like Branch)
 
302
        # should never expect their __del__ function to run.
 
303
        if hasattr(self, 'cache_root') and self.cache_root is not None:
 
304
            try:
 
305
                import shutil
 
306
                shutil.rmtree(self.cache_root)
 
307
            except:
 
308
                pass
 
309
            self.cache_root = None
 
310
 
 
311
    def _get_base(self):
 
312
        if self._transport:
 
313
            return self._transport.base
 
314
        return None
 
315
 
 
316
    base = property(_get_base)
 
317
 
 
318
    def _finish_transaction(self):
 
319
        """Exit the current transaction."""
 
320
        if self._transaction is None:
 
321
            raise errors.LockError('Branch %s is not in a transaction' %
 
322
                                   self)
 
323
        transaction = self._transaction
 
324
        self._transaction = None
 
325
        transaction.finish()
 
326
 
 
327
    def get_transaction(self):
 
328
        """Return the current active transaction.
 
329
 
 
330
        If no transaction is active, this returns a passthrough object
 
331
        for which all data is immedaitely flushed and no caching happens.
 
332
        """
 
333
        if self._transaction is None:
 
334
            return transactions.PassThroughTransaction()
 
335
        else:
 
336
            return self._transaction
 
337
 
 
338
    def _set_transaction(self, new_transaction):
 
339
        """Set a new active transaction."""
 
340
        if self._transaction is not None:
 
341
            raise errors.LockError('Branch %s is in a transaction already.' %
 
342
                                   self)
 
343
        self._transaction = new_transaction
 
344
 
234
345
    def lock_write(self):
 
346
        # TODO: Upgrade locking to support using a Transport,
 
347
        # and potentially a remote locking protocol
235
348
        if self._lock_mode:
236
349
            if self._lock_mode != 'w':
237
 
                from bzrlib.errors import LockError
238
350
                raise LockError("can't upgrade to a write lock from %r" %
239
351
                                self._lock_mode)
240
352
            self._lock_count += 1
241
353
        else:
242
 
            from bzrlib.lock import WriteLock
243
 
 
244
 
            self._lock = WriteLock(self.controlfilename('branch-lock'))
 
354
            self._lock = self._transport.lock_write(
 
355
                    self._rel_controlfilename('branch-lock'))
245
356
            self._lock_mode = 'w'
246
357
            self._lock_count = 1
 
358
            self._set_transaction(transactions.PassThroughTransaction())
247
359
 
248
360
 
249
361
    def lock_read(self):
252
364
                   "invalid lock mode %r" % self._lock_mode
253
365
            self._lock_count += 1
254
366
        else:
255
 
            from bzrlib.lock import ReadLock
256
 
 
257
 
            self._lock = ReadLock(self.controlfilename('branch-lock'))
 
367
            self._lock = self._transport.lock_read(
 
368
                    self._rel_controlfilename('branch-lock'))
258
369
            self._lock_mode = 'r'
259
370
            self._lock_count = 1
 
371
            self._set_transaction(transactions.ReadOnlyTransaction())
260
372
                        
261
373
    def unlock(self):
262
374
        if not self._lock_mode:
263
 
            from bzrlib.errors import LockError
264
375
            raise LockError('branch %r is not locked' % (self))
265
376
 
266
377
        if self._lock_count > 1:
267
378
            self._lock_count -= 1
268
379
        else:
 
380
            self._finish_transaction()
269
381
            self._lock.unlock()
270
382
            self._lock = None
271
383
            self._lock_mode = self._lock_count = None
272
384
 
273
385
    def abspath(self, name):
274
386
        """Return absolute filename for something in the branch"""
275
 
        return os.path.join(self.base, name)
 
387
        return self._transport.abspath(name)
276
388
 
277
389
    def relpath(self, path):
278
390
        """Return path relative to this branch of something inside it.
279
391
 
280
392
        Raises an error if path is not in this branch."""
281
 
        return _relpath(self.base, path)
 
393
        return self._transport.relpath(path)
 
394
 
 
395
 
 
396
    def _rel_controlfilename(self, file_or_path):
 
397
        if isinstance(file_or_path, basestring):
 
398
            file_or_path = [file_or_path]
 
399
        return [bzrlib.BZRDIR] + file_or_path
282
400
 
283
401
    def controlfilename(self, file_or_path):
284
402
        """Return location relative to branch."""
285
 
        if isinstance(file_or_path, basestring):
286
 
            file_or_path = [file_or_path]
287
 
        return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
 
403
        return self._transport.abspath(self._rel_controlfilename(file_or_path))
288
404
 
289
405
 
290
406
    def controlfile(self, file_or_path, mode='r'):
298
414
        Controlfiles should almost never be opened in write mode but
299
415
        rather should be atomically copied and replaced using atomicfile.
300
416
        """
301
 
 
302
 
        fn = self.controlfilename(file_or_path)
303
 
 
304
 
        if mode == 'rb' or mode == 'wb':
305
 
            return file(fn, mode)
306
 
        elif mode == 'r' or mode == 'w':
307
 
            # open in binary mode anyhow so there's no newline translation;
308
 
            # codecs uses line buffering by default; don't want that.
309
 
            import codecs
310
 
            return codecs.open(fn, mode + 'b', 'utf-8',
311
 
                               buffering=60000)
 
417
        import codecs
 
418
 
 
419
        relpath = self._rel_controlfilename(file_or_path)
 
420
        #TODO: codecs.open() buffers linewise, so it was overloaded with
 
421
        # a much larger buffer, do we need to do the same for getreader/getwriter?
 
422
        if mode == 'rb': 
 
423
            return self._transport.get(relpath)
 
424
        elif mode == 'wb':
 
425
            raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
 
426
        elif mode == 'r':
 
427
            return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
 
428
        elif mode == 'w':
 
429
            raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
312
430
        else:
313
431
            raise BzrError("invalid controlfile mode %r" % mode)
314
432
 
 
433
    def put_controlfile(self, path, f, encode=True):
 
434
        """Write an entry as a controlfile.
 
435
 
 
436
        :param path: The path to put the file, relative to the .bzr control
 
437
                     directory
 
438
        :param f: A file-like or string object whose contents should be copied.
 
439
        :param encode:  If true, encode the contents as utf-8
 
440
        """
 
441
        self.put_controlfiles([(path, f)], encode=encode)
 
442
 
 
443
    def put_controlfiles(self, files, encode=True):
 
444
        """Write several entries as controlfiles.
 
445
 
 
446
        :param files: A list of [(path, file)] pairs, where the path is the directory
 
447
                      underneath the bzr control directory
 
448
        :param encode:  If true, encode the contents as utf-8
 
449
        """
 
450
        import codecs
 
451
        ctrl_files = []
 
452
        for path, f in files:
 
453
            if encode:
 
454
                if isinstance(f, basestring):
 
455
                    f = f.encode('utf-8', 'replace')
 
456
                else:
 
457
                    f = codecs.getwriter('utf-8')(f, errors='replace')
 
458
            path = self._rel_controlfilename(path)
 
459
            ctrl_files.append((path, f))
 
460
        self._transport.put_multi(ctrl_files)
 
461
 
315
462
    def _make_control(self):
316
463
        from bzrlib.inventory import Inventory
 
464
        from bzrlib.weavefile import write_weave_v5
 
465
        from bzrlib.weave import Weave
317
466
        
318
 
        os.mkdir(self.controlfilename([]))
319
 
        self.controlfile('README', 'w').write(
320
 
            "This is a Bazaar-NG control directory.\n"
321
 
            "Do not change any files in this directory.\n")
322
 
        self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
323
 
        for d in ('text-store', 'inventory-store', 'revision-store'):
324
 
            os.mkdir(self.controlfilename(d))
325
 
        for f in ('revision-history', 'merged-patches',
326
 
                  'pending-merged-patches', 'branch-name',
327
 
                  'branch-lock',
328
 
                  'pending-merges'):
329
 
            self.controlfile(f, 'w').write('')
330
 
        mutter('created control directory in ' + self.base)
331
 
 
 
467
        # Create an empty inventory
 
468
        sio = StringIO()
332
469
        # if we want per-tree root ids then this is the place to set
333
470
        # them; they're not needed for now and so ommitted for
334
471
        # simplicity.
335
 
        f = self.controlfile('inventory','w')
336
 
        bzrlib.xml.serializer_v4.write_inventory(Inventory(), f)
337
 
 
338
 
 
339
 
    def _check_format(self):
 
472
        bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
 
473
        empty_inv = sio.getvalue()
 
474
        sio = StringIO()
 
475
        bzrlib.weavefile.write_weave_v5(Weave(), sio)
 
476
        empty_weave = sio.getvalue()
 
477
 
 
478
        dirs = [[], 'revision-store', 'weaves']
 
479
        files = [('README', 
 
480
            "This is a Bazaar-NG control directory.\n"
 
481
            "Do not change any files in this directory.\n"),
 
482
            ('branch-format', BZR_BRANCH_FORMAT_6),
 
483
            ('revision-history', ''),
 
484
            ('branch-name', ''),
 
485
            ('branch-lock', ''),
 
486
            ('pending-merges', ''),
 
487
            ('inventory', empty_inv),
 
488
            ('inventory.weave', empty_weave),
 
489
            ('ancestry.weave', empty_weave)
 
490
        ]
 
491
        cfn = self._rel_controlfilename
 
492
        self._transport.mkdir_multi([cfn(d) for d in dirs])
 
493
        self.put_controlfiles(files)
 
494
        mutter('created control directory in ' + self._transport.base)
 
495
 
 
496
    def _check_format(self, relax_version_check):
340
497
        """Check this branch format is supported.
341
498
 
342
 
        The current tool only supports the current unstable format.
 
499
        The format level is stored, as an integer, in
 
500
        self._branch_format for code that needs to check it later.
343
501
 
344
502
        In the future, we might need different in-memory Branch
345
503
        classes to support downlevel branches.  But not yet.
346
504
        """
347
 
        # This ignores newlines so that we can open branches created
348
 
        # on Windows from Linux and so on.  I think it might be better
349
 
        # to always make all internal files in unix format.
350
 
        fmt = self.controlfile('branch-format', 'r').read()
351
 
        fmt = fmt.replace('\r\n', '\n')
352
 
        if fmt != BZR_BRANCH_FORMAT:
353
 
            raise BzrError('sorry, branch format %r not supported' % fmt,
 
505
        try:
 
506
            fmt = self.controlfile('branch-format', 'r').read()
 
507
        except NoSuchFile:
 
508
            raise NotBranchError(self.base)
 
509
        mutter("got branch format %r", fmt)
 
510
        if fmt == BZR_BRANCH_FORMAT_6:
 
511
            self._branch_format = 6
 
512
        elif fmt == BZR_BRANCH_FORMAT_5:
 
513
            self._branch_format = 5
 
514
        elif fmt == BZR_BRANCH_FORMAT_4:
 
515
            self._branch_format = 4
 
516
 
 
517
        if (not relax_version_check
 
518
            and self._branch_format not in (5, 6)):
 
519
            raise errors.UnsupportedFormatError(
 
520
                           'sorry, branch format %r not supported' % fmt,
354
521
                           ['use a different bzr version',
355
 
                            'or remove the .bzr directory and "bzr init" again'])
 
522
                            'or remove the .bzr directory'
 
523
                            ' and "bzr init" again'])
356
524
 
357
525
    def get_root_id(self):
358
526
        """Return the id of this branches root"""
373
541
 
374
542
    def read_working_inventory(self):
375
543
        """Read the working inventory."""
376
 
        from bzrlib.inventory import Inventory
377
544
        self.lock_read()
378
545
        try:
379
546
            # ElementTree does its own conversion from UTF-8, so open in
380
547
            # binary.
381
548
            f = self.controlfile('inventory', 'rb')
382
 
            return bzrlib.xml.serializer_v4.read_inventory(f)
 
549
            return bzrlib.xml5.serializer_v5.read_inventory(f)
383
550
        finally:
384
551
            self.unlock()
385
552
            
390
557
        That is to say, the inventory describing changes underway, that
391
558
        will be committed to the next revision.
392
559
        """
393
 
        from bzrlib.atomicfile import AtomicFile
394
 
        
 
560
        from cStringIO import StringIO
395
561
        self.lock_write()
396
562
        try:
397
 
            f = AtomicFile(self.controlfilename('inventory'), 'wb')
398
 
            try:
399
 
                bzrlib.xml.serializer_v4.write_inventory(inv, f)
400
 
                f.commit()
401
 
            finally:
402
 
                f.close()
 
563
            sio = StringIO()
 
564
            bzrlib.xml5.serializer_v5.write_inventory(inv, sio)
 
565
            sio.seek(0)
 
566
            # Transport handles atomicity
 
567
            self.put_controlfile('inventory', sio)
403
568
        finally:
404
569
            self.unlock()
405
570
        
406
571
        mutter('wrote working inventory')
407
572
            
408
 
 
409
573
    inventory = property(read_working_inventory, _write_inventory, None,
410
574
                         """Inventory for the working copy.""")
411
575
 
412
 
 
413
576
    def add(self, files, ids=None):
414
577
        """Make files versioned.
415
578
 
463
626
                    kind = file_kind(fullpath)
464
627
                except OSError:
465
628
                    # maybe something better?
466
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
629
                    raise BzrError('cannot add: not a regular file, symlink or directory: %s' % quotefn(f))
467
630
 
468
 
                if kind != 'file' and kind != 'directory':
469
 
                    raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
 
631
                if not InventoryEntry.versionable_kind(kind):
 
632
                    raise BzrError('cannot add: not a versionable file ('
 
633
                                   'i.e. regular file, symlink or directory): %s' % quotefn(f))
470
634
 
471
635
                if file_id is None:
472
636
                    file_id = gen_file_id(f)
537
701
        finally:
538
702
            self.unlock()
539
703
 
540
 
 
541
704
    # FIXME: this doesn't need to be a branch method
542
705
    def set_inventory(self, new_inventory_list):
543
706
        from bzrlib.inventory import Inventory, InventoryEntry
546
709
            name = os.path.basename(path)
547
710
            if name == "":
548
711
                continue
549
 
            inv.add(InventoryEntry(file_id, name, kind, parent))
 
712
            # fixme, there should be a factory function inv,add_?? 
 
713
            if kind == 'directory':
 
714
                inv.add(inventory.InventoryDirectory(file_id, name, parent))
 
715
            elif kind == 'file':
 
716
                inv.add(inventory.InventoryFile(file_id, name, parent))
 
717
            elif kind == 'symlink':
 
718
                inv.add(inventory.InventoryLink(file_id, name, parent))
 
719
            else:
 
720
                raise BzrError("unknown kind %r" % kind)
550
721
        self._write_inventory(inv)
551
722
 
552
 
 
553
723
    def unknowns(self):
554
724
        """Return all unknown files.
555
725
 
570
740
 
571
741
 
572
742
    def append_revision(self, *revision_ids):
573
 
        from bzrlib.atomicfile import AtomicFile
574
 
 
575
743
        for revision_id in revision_ids:
576
744
            mutter("add {%s} to revision-history" % revision_id)
577
 
 
578
 
        rev_history = self.revision_history()
579
 
        rev_history.extend(revision_ids)
580
 
 
581
 
        f = AtomicFile(self.controlfilename('revision-history'))
 
745
        self.lock_write()
582
746
        try:
583
 
            for rev_id in rev_history:
584
 
                print >>f, rev_id
585
 
            f.commit()
 
747
            rev_history = self.revision_history()
 
748
            rev_history.extend(revision_ids)
 
749
            self.put_controlfile('revision-history', '\n'.join(rev_history))
586
750
        finally:
587
 
            f.close()
588
 
 
 
751
            self.unlock()
 
752
 
 
753
    def has_revision(self, revision_id):
 
754
        """True if this branch has a copy of the revision.
 
755
 
 
756
        This does not necessarily imply the revision is merge
 
757
        or on the mainline."""
 
758
        return (revision_id is None
 
759
                or revision_id in self.revision_store)
589
760
 
590
761
    def get_revision_xml_file(self, revision_id):
591
762
        """Return XML file object for revision object."""
601
772
        finally:
602
773
            self.unlock()
603
774
 
604
 
 
605
775
    #deprecated
606
776
    get_revision_xml = get_revision_xml_file
607
777
 
 
778
    def get_revision_xml(self, revision_id):
 
779
        return self.get_revision_xml_file(revision_id).read()
 
780
 
608
781
 
609
782
    def get_revision(self, revision_id):
610
783
        """Return the Revision object for a named revision"""
611
784
        xml_file = self.get_revision_xml_file(revision_id)
612
785
 
613
786
        try:
614
 
            r = bzrlib.xml.serializer_v4.read_revision(xml_file)
 
787
            r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
615
788
        except SyntaxError, e:
616
789
            raise bzrlib.errors.BzrError('failed to unpack revision_xml',
617
790
                                         [revision_id,
620
793
        assert r.revision_id == revision_id
621
794
        return r
622
795
 
623
 
 
624
796
    def get_revision_delta(self, revno):
625
797
        """Return the delta for one revision.
626
798
 
642
814
 
643
815
        return compare_trees(old_tree, new_tree)
644
816
 
645
 
        
646
 
 
647
817
    def get_revision_sha1(self, revision_id):
648
818
        """Hash the stored value of a revision, and return it."""
649
819
        # In the future, revision entries will be signed. At that
652
822
        # the revision, (add signatures/remove signatures) and still
653
823
        # have all hash pointers stay consistent.
654
824
        # But for now, just hash the contents.
655
 
        return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
656
 
 
657
 
 
658
 
    def get_inventory(self, inventory_id):
659
 
        """Get Inventory object by hash.
660
 
 
661
 
        TODO: Perhaps for this and similar methods, take a revision
662
 
               parameter which can be either an integer revno or a
663
 
               string hash."""
664
 
        from bzrlib.inventory import Inventory
665
 
 
666
 
        f = self.get_inventory_xml_file(inventory_id)
667
 
        return bzrlib.xml.serializer_v4.read_inventory(f)
668
 
 
669
 
 
670
 
    def get_inventory_xml(self, inventory_id):
 
825
        return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
 
826
 
 
827
    def get_ancestry(self, revision_id):
 
828
        """Return a list of revision-ids integrated by a revision.
 
829
        
 
830
        This currently returns a list, but the ordering is not guaranteed:
 
831
        treat it as a set.
 
832
        """
 
833
        if revision_id is None:
 
834
            return [None]
 
835
        w = self.get_inventory_weave()
 
836
        return [None] + map(w.idx_to_name,
 
837
                            w.inclusions([w.lookup(revision_id)]))
 
838
 
 
839
    def get_inventory_weave(self):
 
840
        return self.control_weaves.get_weave('inventory',
 
841
                                             self.get_transaction())
 
842
 
 
843
    def get_inventory(self, revision_id):
 
844
        """Get Inventory object by hash."""
 
845
        xml = self.get_inventory_xml(revision_id)
 
846
        return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
 
847
 
 
848
    def get_inventory_xml(self, revision_id):
671
849
        """Get inventory XML as a file object."""
672
 
        return self.inventory_store[inventory_id]
673
 
 
674
 
    get_inventory_xml_file = get_inventory_xml
675
 
            
676
 
 
677
 
    def get_inventory_sha1(self, inventory_id):
 
850
        try:
 
851
            assert isinstance(revision_id, basestring), type(revision_id)
 
852
            iw = self.get_inventory_weave()
 
853
            return iw.get_text(iw.lookup(revision_id))
 
854
        except IndexError:
 
855
            raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
 
856
 
 
857
    def get_inventory_sha1(self, revision_id):
678
858
        """Return the sha1 hash of the inventory entry
679
859
        """
680
 
        return sha_file(self.get_inventory_xml(inventory_id))
681
 
 
 
860
        return self.get_revision(revision_id).inventory_sha1
682
861
 
683
862
    def get_revision_inventory(self, revision_id):
684
863
        """Return inventory of a past revision."""
685
 
        # bzr 0.0.6 imposes the constraint that the inventory_id
 
864
        # TODO: Unify this with get_inventory()
 
865
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
686
866
        # must be the same as its revision, so this is trivial.
687
867
        if revision_id == None:
688
 
            from bzrlib.inventory import Inventory
689
868
            return Inventory(self.get_root_id())
690
869
        else:
691
870
            return self.get_inventory(revision_id)
692
871
 
693
 
 
694
872
    def revision_history(self):
695
 
        """Return sequence of revision hashes on to this branch.
696
 
 
697
 
        >>> ScratchBranch().revision_history()
698
 
        []
699
 
        """
 
873
        """Return sequence of revision hashes on to this branch."""
700
874
        self.lock_read()
701
875
        try:
702
876
            return [l.rstrip('\r\n') for l in
704
878
        finally:
705
879
            self.unlock()
706
880
 
707
 
 
708
881
    def common_ancestor(self, other, self_revno=None, other_revno=None):
709
882
        """
710
883
        >>> from bzrlib.commit import commit
759
932
        return len(self.revision_history())
760
933
 
761
934
 
762
 
    def last_patch(self):
 
935
    def last_revision(self):
763
936
        """Return last patch hash, or None if no history.
764
937
        """
765
938
        ph = self.revision_history()
770
943
 
771
944
 
772
945
    def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
773
 
        """
 
946
        """Return a list of new revisions that would perfectly fit.
 
947
        
774
948
        If self and other have not diverged, return a list of the revisions
775
949
        present in other, but missing from self.
776
950
 
796
970
        Traceback (most recent call last):
797
971
        DivergedBranches: These branches have diverged.
798
972
        """
 
973
        # FIXME: If the branches have diverged, but the latest
 
974
        # revision in this branch is completely merged into the other,
 
975
        # then we should still be able to pull.
799
976
        self_history = self.revision_history()
800
977
        self_len = len(self_history)
801
978
        other_history = other.revision_history()
807
984
 
808
985
        if stop_revision is None:
809
986
            stop_revision = other_len
810
 
        elif stop_revision > other_len:
811
 
            raise bzrlib.errors.NoSuchRevision(self, stop_revision)
812
 
        
 
987
        else:
 
988
            assert isinstance(stop_revision, int)
 
989
            if stop_revision > other_len:
 
990
                raise bzrlib.errors.NoSuchRevision(self, stop_revision)
813
991
        return other_history[self_len:stop_revision]
814
992
 
815
 
 
816
993
    def update_revisions(self, other, stop_revision=None):
817
 
        """Pull in all new revisions from other branch.
818
 
        """
 
994
        """Pull in new perfect-fit revisions."""
819
995
        from bzrlib.fetch import greedy_fetch
820
996
        from bzrlib.revision import get_intervening_revisions
821
 
 
822
 
        pb = bzrlib.ui.ui_factory.progress_bar()
823
 
        pb.update('comparing histories')
824
997
        if stop_revision is None:
825
 
            other_revision = other.last_patch()
826
 
        else:
827
 
            other_revision = other.get_rev_id(stop_revision)
828
 
        count = greedy_fetch(self, other, other_revision, pb)[0]
829
 
        try:
830
 
            revision_ids = self.missing_revisions(other, stop_revision)
831
 
        except DivergedBranches, e:
832
 
            try:
833
 
                revision_ids = get_intervening_revisions(self.last_patch(), 
834
 
                                                         other_revision, self)
835
 
                assert self.last_patch() not in revision_ids
836
 
            except bzrlib.errors.NotAncestor:
837
 
                raise e
838
 
 
839
 
        self.append_revision(*revision_ids)
840
 
        pb.clear()
841
 
 
842
 
    def install_revisions(self, other, revision_ids, pb):
843
 
        if hasattr(other.revision_store, "prefetch"):
844
 
            other.revision_store.prefetch(revision_ids)
845
 
        if hasattr(other.inventory_store, "prefetch"):
846
 
            inventory_ids = []
847
 
            for rev_id in revision_ids:
848
 
                try:
849
 
                    revision = other.get_revision(rev_id).inventory_id
850
 
                    inventory_ids.append(revision)
851
 
                except bzrlib.errors.NoSuchRevision:
852
 
                    pass
853
 
            other.inventory_store.prefetch(inventory_ids)
854
 
 
855
 
        if pb is None:
856
 
            pb = bzrlib.ui.ui_factory.progress_bar()
857
 
                
858
 
        revisions = []
859
 
        needed_texts = set()
860
 
        i = 0
861
 
 
862
 
        failures = set()
863
 
        for i, rev_id in enumerate(revision_ids):
864
 
            pb.update('fetching revision', i+1, len(revision_ids))
865
 
            try:
866
 
                rev = other.get_revision(rev_id)
867
 
            except bzrlib.errors.NoSuchRevision:
868
 
                failures.add(rev_id)
869
 
                continue
870
 
 
871
 
            revisions.append(rev)
872
 
            inv = other.get_inventory(str(rev.inventory_id))
873
 
            for key, entry in inv.iter_entries():
874
 
                if entry.text_id is None:
875
 
                    continue
876
 
                if entry.text_id not in self.text_store:
877
 
                    needed_texts.add(entry.text_id)
878
 
 
879
 
        pb.clear()
880
 
                    
881
 
        count, cp_fail = self.text_store.copy_multi(other.text_store, 
882
 
                                                    needed_texts)
883
 
        #print "Added %d texts." % count 
884
 
        inventory_ids = [ f.inventory_id for f in revisions ]
885
 
        count, cp_fail = self.inventory_store.copy_multi(other.inventory_store, 
886
 
                                                         inventory_ids)
887
 
        #print "Added %d inventories." % count 
888
 
        revision_ids = [ f.revision_id for f in revisions]
889
 
 
890
 
        count, cp_fail = self.revision_store.copy_multi(other.revision_store, 
891
 
                                                          revision_ids,
892
 
                                                          permit_failure=True)
893
 
        assert len(cp_fail) == 0 
894
 
        return count, failures
895
 
       
 
998
            stop_revision = other.last_revision()
 
999
        greedy_fetch(to_branch=self, from_branch=other,
 
1000
                     revision=stop_revision)
 
1001
        pullable_revs = self.missing_revisions(
 
1002
            other, other.revision_id_to_revno(stop_revision))
 
1003
        if pullable_revs:
 
1004
            greedy_fetch(to_branch=self,
 
1005
                         from_branch=other,
 
1006
                         revision=pullable_revs[-1])
 
1007
            self.append_revision(*pullable_revs)
 
1008
    
896
1009
 
897
1010
    def commit(self, *args, **kw):
898
 
        from bzrlib.commit import commit
899
 
        commit(self, *args, **kw)
900
 
        
 
1011
        from bzrlib.commit import Commit
 
1012
        Commit().commit(self, *args, **kw)
 
1013
    
901
1014
    def revision_id_to_revno(self, revision_id):
902
1015
        """Given a revision id, return its revno"""
 
1016
        if revision_id is None:
 
1017
            return 0
903
1018
        history = self.revision_history()
904
1019
        try:
905
1020
            return history.index(revision_id) + 1
916
1031
            raise bzrlib.errors.NoSuchRevision(self, revno)
917
1032
        return history[revno - 1]
918
1033
 
919
 
 
920
1034
    def revision_tree(self, revision_id):
921
1035
        """Return Tree for a revision on this branch.
922
1036
 
928
1042
            return EmptyTree()
929
1043
        else:
930
1044
            inv = self.get_revision_inventory(revision_id)
931
 
            return RevisionTree(self.text_store, inv)
 
1045
            return RevisionTree(self.weave_store, inv, revision_id)
932
1046
 
933
1047
 
934
1048
    def working_tree(self):
935
1049
        """Return a `Tree` for the working copy."""
936
1050
        from bzrlib.workingtree import WorkingTree
937
 
        return WorkingTree(self.base, self.read_working_inventory())
 
1051
        # TODO: In the future, WorkingTree should utilize Transport
 
1052
        # RobertCollins 20051003 - I don't think it should - working trees are
 
1053
        # much more complex to keep consistent than our careful .bzr subset.
 
1054
        # instead, we should say that working trees are local only, and optimise
 
1055
        # for that.
 
1056
        return WorkingTree(self._transport.base, self.read_working_inventory())
938
1057
 
939
1058
 
940
1059
    def basis_tree(self):
942
1061
 
943
1062
        If there are no revisions yet, return an `EmptyTree`.
944
1063
        """
945
 
        r = self.last_patch()
946
 
        if r == None:
947
 
            return EmptyTree()
948
 
        else:
949
 
            return RevisionTree(self.text_store, self.get_revision_inventory(r))
950
 
 
 
1064
        return self.revision_tree(self.last_revision())
951
1065
 
952
1066
 
953
1067
    def rename_one(self, from_rel, to_rel):
988
1102
            from_abs = self.abspath(from_rel)
989
1103
            to_abs = self.abspath(to_rel)
990
1104
            try:
991
 
                os.rename(from_abs, to_abs)
 
1105
                rename(from_abs, to_abs)
992
1106
            except OSError, e:
993
1107
                raise BzrError("failed to rename %r to %r: %s"
994
1108
                        % (from_abs, to_abs, e[1]),
1057
1171
                result.append((f, dest_path))
1058
1172
                inv.rename(inv.path2id(f), to_dir_id, name_tail)
1059
1173
                try:
1060
 
                    os.rename(self.abspath(f), self.abspath(dest_path))
 
1174
                    rename(self.abspath(f), self.abspath(dest_path))
1061
1175
                except OSError, e:
1062
1176
                    raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1063
1177
                            ["rename rolled back"])
1119
1233
        These are revisions that have been merged into the working
1120
1234
        directory but not yet committed.
1121
1235
        """
1122
 
        cfn = self.controlfilename('pending-merges')
1123
 
        if not os.path.exists(cfn):
 
1236
        cfn = self._rel_controlfilename('pending-merges')
 
1237
        if not self._transport.has(cfn):
1124
1238
            return []
1125
1239
        p = []
1126
1240
        for l in self.controlfile('pending-merges', 'r').readlines():
1128
1242
        return p
1129
1243
 
1130
1244
 
1131
 
    def add_pending_merge(self, revision_id):
1132
 
        from bzrlib.revision import validate_revision_id
1133
 
 
1134
 
        validate_revision_id(revision_id)
1135
 
 
 
1245
    def add_pending_merge(self, *revision_ids):
 
1246
        # TODO: Perhaps should check at this point that the
 
1247
        # history of the revision is actually present?
1136
1248
        p = self.pending_merges()
1137
 
        if revision_id in p:
1138
 
            return
1139
 
        p.append(revision_id)
1140
 
        self.set_pending_merges(p)
1141
 
 
 
1249
        updated = False
 
1250
        for rev_id in revision_ids:
 
1251
            if rev_id in p:
 
1252
                continue
 
1253
            p.append(rev_id)
 
1254
            updated = True
 
1255
        if updated:
 
1256
            self.set_pending_merges(p)
1142
1257
 
1143
1258
    def set_pending_merges(self, rev_list):
1144
 
        from bzrlib.atomicfile import AtomicFile
1145
1259
        self.lock_write()
1146
1260
        try:
1147
 
            f = AtomicFile(self.controlfilename('pending-merges'))
1148
 
            try:
1149
 
                for l in rev_list:
1150
 
                    print >>f, l
1151
 
                f.commit()
1152
 
            finally:
1153
 
                f.close()
 
1261
            self.put_controlfile('pending-merges', '\n'.join(rev_list))
1154
1262
        finally:
1155
1263
            self.unlock()
1156
1264
 
1207
1315
        
1208
1316
 
1209
1317
 
1210
 
class ScratchBranch(LocalBranch):
 
1318
class ScratchBranch(_Branch):
1211
1319
    """Special test class: a branch that cleans up after itself.
1212
1320
 
1213
1321
    >>> b = ScratchBranch()
1230
1338
        if base is None:
1231
1339
            base = mkdtemp()
1232
1340
            init = True
1233
 
        LocalBranch.__init__(self, base, init=init)
 
1341
        if isinstance(base, basestring):
 
1342
            base = get_transport(base)
 
1343
        _Branch.__init__(self, base, init=init)
1234
1344
        for d in dirs:
1235
 
            os.mkdir(self.abspath(d))
 
1345
            self._transport.mkdir(d)
1236
1346
            
1237
1347
        for f in files:
1238
 
            file(os.path.join(self.base, f), 'w').write('content of %s' % f)
 
1348
            self._transport.put(f, 'content of %s' % f)
1239
1349
 
1240
1350
 
1241
1351
    def clone(self):
1242
1352
        """
1243
1353
        >>> orig = ScratchBranch(files=["file1", "file2"])
1244
1354
        >>> clone = orig.clone()
1245
 
        >>> os.path.samefile(orig.base, clone.base)
 
1355
        >>> if os.name != 'nt':
 
1356
        ...   os.path.samefile(orig.base, clone.base)
 
1357
        ... else:
 
1358
        ...   orig.base == clone.base
 
1359
        ...
1246
1360
        False
1247
1361
        >>> os.path.isfile(os.path.join(clone.base, "file1"))
1248
1362
        True
1254
1368
        copytree(self.base, base, symlinks=True)
1255
1369
        return ScratchBranch(base=base)
1256
1370
 
1257
 
 
1258
 
        
1259
1371
    def __del__(self):
1260
1372
        self.destroy()
1261
1373
 
1274
1386
                for name in files:
1275
1387
                    os.chmod(os.path.join(root, name), 0700)
1276
1388
            rmtree(self.base)
1277
 
        self.base = None
 
1389
        self._transport = None
1278
1390
 
1279
1391
    
1280
1392
 
1331
1443
    return gen_file_id('TREE_ROOT')
1332
1444
 
1333
1445
 
1334
 
def copy_branch(branch_from, to_location, revision=None):
1335
 
    """Copy branch_from into the existing directory to_location.
1336
 
 
1337
 
    revision
1338
 
        If not None, only revisions up to this point will be copied.
1339
 
        The head of the new branch will be that revision.
1340
 
 
1341
 
    to_location
1342
 
        The name of a local directory that exists but is empty.
1343
 
    """
1344
 
    from bzrlib.merge import merge
1345
 
    from bzrlib.revisionspec import RevisionSpec
1346
 
 
1347
 
    assert isinstance(branch_from, Branch)
1348
 
    assert isinstance(to_location, basestring)
1349
 
    
1350
 
    br_to = Branch.initialize(to_location)
1351
 
    br_to.set_root_id(branch_from.get_root_id())
1352
 
    if revision is None:
1353
 
        revno = branch_from.revno()
1354
 
    else:
1355
 
        revno, rev_id = RevisionSpec(revision).in_history(branch_from)
1356
 
    br_to.update_revisions(branch_from, stop_revision=revno)
1357
 
    merge((to_location, -1), (to_location, 0), this_dir=to_location,
1358
 
          check_clean=False, ignore_zero=True)
1359
 
    br_to.set_parent(branch_from.base)
1360
 
    return br_to