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

  • Committer: Vincent Ladeuil
  • Date: 2010-06-17 07:11:55 UTC
  • mto: (5299.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5302.
  • Revision ID: v.ladeuil+lp@free.fr-20100617071155-by34vqnqqlvzuwt1
Fix typo.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
29
29
        errors,
30
30
        lockdir,
31
31
        lockable_files,
 
32
        remote,
32
33
        repository,
33
34
        revision as _mod_revision,
34
35
        rio,
49
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
51
from bzrlib.hooks import HookPoint, Hooks
51
52
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
54
from bzrlib import registry
54
55
from bzrlib.symbol_versioning import (
55
56
    deprecated_in,
197
198
        return self.supports_tags() and self.tags.get_tag_dict()
198
199
 
199
200
    def get_config(self):
 
201
        """Get a bzrlib.config.BranchConfig for this Branch.
 
202
 
 
203
        This can then be used to get and set configuration options for the
 
204
        branch.
 
205
 
 
206
        :return: A bzrlib.config.BranchConfig.
 
207
        """
200
208
        return BranchConfig(self)
201
209
 
202
210
    def _get_config(self):
295
303
    def lock_read(self):
296
304
        """Lock the branch for read operations.
297
305
 
298
 
        :return: An object with an unlock method which will release the lock
299
 
            obtained.
 
306
        :return: A bzrlib.lock.LogicalLockResult.
300
307
        """
301
308
        raise NotImplementedError(self.lock_read)
302
309
 
962
969
                raise errors.NoSuchRevision(self, stop_revision)
963
970
        return other_history[self_len:stop_revision]
964
971
 
965
 
    @needs_write_lock
966
972
    def update_revisions(self, other, stop_revision=None, overwrite=False,
967
973
                         graph=None):
968
974
        """Pull in new perfect-fit revisions.
1266
1272
                revno = 1
1267
1273
        destination.set_last_revision_info(revno, revision_id)
1268
1274
 
1269
 
    @needs_read_lock
1270
1275
    def copy_content_into(self, destination, revision_id=None):
1271
1276
        """Copy the content of self into destination.
1272
1277
 
1273
1278
        revision_id: if not None, the revision history in the new branch will
1274
1279
                     be truncated to end with revision_id.
1275
1280
        """
1276
 
        self.update_references(destination)
1277
 
        self._synchronize_history(destination, revision_id)
1278
 
        try:
1279
 
            parent = self.get_parent()
1280
 
        except errors.InaccessibleParent, e:
1281
 
            mutter('parent was not accessible to copy: %s', e)
1282
 
        else:
1283
 
            if parent:
1284
 
                destination.set_parent(parent)
1285
 
        if self._push_should_merge_tags():
1286
 
            self.tags.merge_to(destination.tags)
 
1281
        return InterBranch.get(self, destination).copy_content_into(
 
1282
            revision_id=revision_id)
1287
1283
 
1288
1284
    def update_references(self, target):
1289
1285
        if not getattr(self._format, 'supports_reference_locations', False):
1357
1353
        """
1358
1354
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1359
1355
        # clone call. Or something. 20090224 RBC/spiv.
 
1356
        # XXX: Should this perhaps clone colocated branches as well, 
 
1357
        # rather than just the default branch? 20100319 JRV
1360
1358
        if revision_id is None:
1361
1359
            revision_id = self.last_revision()
1362
1360
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1532
1530
        """Return the current default format."""
1533
1531
        return klass._default_format
1534
1532
 
1535
 
    def get_reference(self, a_bzrdir):
 
1533
    def get_reference(self, a_bzrdir, name=None):
1536
1534
        """Get the target reference of the branch in a_bzrdir.
1537
1535
 
1538
1536
        format probing must have been completed before calling
1540
1538
        in a_bzrdir is correct.
1541
1539
 
1542
1540
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1541
        :param name: Name of the colocated branch to fetch
1543
1542
        :return: None if the branch is not a reference branch.
1544
1543
        """
1545
1544
        return None
1546
1545
 
1547
1546
    @classmethod
1548
 
    def set_reference(self, a_bzrdir, to_branch):
 
1547
    def set_reference(self, a_bzrdir, name, to_branch):
1549
1548
        """Set the target reference of the branch in a_bzrdir.
1550
1549
 
1551
1550
        format probing must have been completed before calling
1553
1552
        in a_bzrdir is correct.
1554
1553
 
1555
1554
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1555
        :param name: Name of colocated branch to set, None for default
1556
1556
        :param to_branch: branch that the checkout is to reference
1557
1557
        """
1558
1558
        raise NotImplementedError(self.set_reference)
2168
2168
        """See BranchFormat.get_format_description()."""
2169
2169
        return "Checkout reference format 1"
2170
2170
 
2171
 
    def get_reference(self, a_bzrdir):
 
2171
    def get_reference(self, a_bzrdir, name=None):
2172
2172
        """See BranchFormat.get_reference()."""
2173
 
        transport = a_bzrdir.get_branch_transport(None)
 
2173
        transport = a_bzrdir.get_branch_transport(None, name=name)
2174
2174
        return transport.get_bytes('location')
2175
2175
 
2176
 
    def set_reference(self, a_bzrdir, to_branch):
 
2176
    def set_reference(self, a_bzrdir, name, to_branch):
2177
2177
        """See BranchFormat.set_reference()."""
2178
 
        transport = a_bzrdir.get_branch_transport(None)
 
2178
        transport = a_bzrdir.get_branch_transport(None, name=name)
2179
2179
        location = transport.put_bytes('location', to_branch.base)
2180
2180
 
2181
2181
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2232
2232
                raise AssertionError("wrong format %r found for %r" %
2233
2233
                    (format, self))
2234
2234
        if location is None:
2235
 
            location = self.get_reference(a_bzrdir)
 
2235
            location = self.get_reference(a_bzrdir, name)
2236
2236
        real_bzrdir = bzrdir.BzrDir.open(
2237
2237
            location, possible_transports=possible_transports)
2238
2238
        result = real_bzrdir.open_branch(name=name, 
2276
2276
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
2277
 
2278
2278
 
2279
 
class BranchWriteLockResult(object):
 
2279
class BranchWriteLockResult(LogicalLockResult):
2280
2280
    """The result of write locking a branch.
2281
2281
 
2282
2282
    :ivar branch_token: The token obtained from the underlying branch lock, or
2285
2285
    """
2286
2286
 
2287
2287
    def __init__(self, unlock, branch_token):
 
2288
        LogicalLockResult.__init__(self, unlock)
2288
2289
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
 
2290
 
 
2291
    def __repr__(self):
 
2292
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2293
            self.unlock)
2290
2294
 
2291
2295
 
2292
2296
class BzrBranch(Branch, _RelockDebugMixin):
2375
2379
    def lock_read(self):
2376
2380
        """Lock the branch for read operations.
2377
2381
 
2378
 
        :return: An object with an unlock method which will release the lock
2379
 
            obtained.
 
2382
        :return: A bzrlib.lock.LogicalLockResult.
2380
2383
        """
2381
2384
        if not self.is_locked():
2382
2385
            self._note_lock('r')
2390
2393
            took_lock = False
2391
2394
        try:
2392
2395
            self.control_files.lock_read()
2393
 
            return self
 
2396
            return LogicalLockResult(self.unlock)
2394
2397
        except:
2395
2398
            if took_lock:
2396
2399
                self.repository.unlock()
3220
3223
 
3221
3224
 
3222
3225
class GenericInterBranch(InterBranch):
3223
 
    """InterBranch implementation that uses public Branch functions.
3224
 
    """
 
3226
    """InterBranch implementation that uses public Branch functions."""
 
3227
 
 
3228
    @classmethod
 
3229
    def is_compatible(klass, source, target):
 
3230
        # GenericBranch uses the public API, so always compatible
 
3231
        return True
3225
3232
 
3226
3233
    @staticmethod
3227
3234
    def _get_branch_formats_to_test():
3228
3235
        return BranchFormat._default_format, BranchFormat._default_format
3229
3236
 
 
3237
    @classmethod
 
3238
    def unwrap_format(klass, format):
 
3239
        if isinstance(format, remote.RemoteBranchFormat):
 
3240
            format._ensure_real()
 
3241
            return format._custom_format
 
3242
        return format                                                                                                  
 
3243
 
 
3244
    @needs_write_lock
 
3245
    def copy_content_into(self, revision_id=None):
 
3246
        """Copy the content of source into target
 
3247
 
 
3248
        revision_id: if not None, the revision history in the new branch will
 
3249
                     be truncated to end with revision_id.
 
3250
        """
 
3251
        self.source.update_references(self.target)
 
3252
        self.source._synchronize_history(self.target, revision_id)
 
3253
        try:
 
3254
            parent = self.source.get_parent()
 
3255
        except errors.InaccessibleParent, e:
 
3256
            mutter('parent was not accessible to copy: %s', e)
 
3257
        else:
 
3258
            if parent:
 
3259
                self.target.set_parent(parent)
 
3260
        if self.source._push_should_merge_tags():
 
3261
            self.source.tags.merge_to(self.target.tags)
 
3262
 
 
3263
    @needs_write_lock
3230
3264
    def update_revisions(self, stop_revision=None, overwrite=False,
3231
3265
        graph=None):
3232
3266
        """See InterBranch.update_revisions()."""
3233
 
        self.source.lock_read()
3234
 
        try:
3235
 
            other_revno, other_last_revision = self.source.last_revision_info()
3236
 
            stop_revno = None # unknown
3237
 
            if stop_revision is None:
3238
 
                stop_revision = other_last_revision
3239
 
                if _mod_revision.is_null(stop_revision):
3240
 
                    # if there are no commits, we're done.
3241
 
                    return
3242
 
                stop_revno = other_revno
 
3267
        other_revno, other_last_revision = self.source.last_revision_info()
 
3268
        stop_revno = None # unknown
 
3269
        if stop_revision is None:
 
3270
            stop_revision = other_last_revision
 
3271
            if _mod_revision.is_null(stop_revision):
 
3272
                # if there are no commits, we're done.
 
3273
                return
 
3274
            stop_revno = other_revno
3243
3275
 
3244
 
            # what's the current last revision, before we fetch [and change it
3245
 
            # possibly]
3246
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3247
 
            # we fetch here so that we don't process data twice in the common
3248
 
            # case of having something to pull, and so that the check for
3249
 
            # already merged can operate on the just fetched graph, which will
3250
 
            # be cached in memory.
3251
 
            self.target.fetch(self.source, stop_revision)
3252
 
            # Check to see if one is an ancestor of the other
3253
 
            if not overwrite:
3254
 
                if graph is None:
3255
 
                    graph = self.target.repository.get_graph()
3256
 
                if self.target._check_if_descendant_or_diverged(
3257
 
                        stop_revision, last_rev, graph, self.source):
3258
 
                    # stop_revision is a descendant of last_rev, but we aren't
3259
 
                    # overwriting, so we're done.
3260
 
                    return
3261
 
            if stop_revno is None:
3262
 
                if graph is None:
3263
 
                    graph = self.target.repository.get_graph()
3264
 
                this_revno, this_last_revision = \
3265
 
                        self.target.last_revision_info()
3266
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3267
 
                                [(other_last_revision, other_revno),
3268
 
                                 (this_last_revision, this_revno)])
3269
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3270
 
        finally:
3271
 
            self.source.unlock()
 
3276
        # what's the current last revision, before we fetch [and change it
 
3277
        # possibly]
 
3278
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3279
        # we fetch here so that we don't process data twice in the common
 
3280
        # case of having something to pull, and so that the check for
 
3281
        # already merged can operate on the just fetched graph, which will
 
3282
        # be cached in memory.
 
3283
        self.target.fetch(self.source, stop_revision)
 
3284
        # Check to see if one is an ancestor of the other
 
3285
        if not overwrite:
 
3286
            if graph is None:
 
3287
                graph = self.target.repository.get_graph()
 
3288
            if self.target._check_if_descendant_or_diverged(
 
3289
                    stop_revision, last_rev, graph, self.source):
 
3290
                # stop_revision is a descendant of last_rev, but we aren't
 
3291
                # overwriting, so we're done.
 
3292
                return
 
3293
        if stop_revno is None:
 
3294
            if graph is None:
 
3295
                graph = self.target.repository.get_graph()
 
3296
            this_revno, this_last_revision = \
 
3297
                    self.target.last_revision_info()
 
3298
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3299
                            [(other_last_revision, other_revno),
 
3300
                             (this_last_revision, this_revno)])
 
3301
        self.target.set_last_revision_info(stop_revno, stop_revision)
3272
3302
 
3273
3303
    def pull(self, overwrite=False, stop_revision=None,
3274
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3304
             possible_transports=None, run_hooks=True,
3275
3305
             _override_hook_target=None, local=False):
3276
 
        """See Branch.pull.
 
3306
        """Pull from source into self, updating my master if any.
3277
3307
 
3278
 
        :param _hook_master: Private parameter - set the branch to
3279
 
            be supplied as the master to pull hooks.
3280
3308
        :param run_hooks: Private parameter - if false, this branch
3281
3309
            is being called because it's the master of the primary branch,
3282
3310
            so it should not run its hooks.
3283
 
        :param _override_hook_target: Private parameter - set the branch to be
3284
 
            supplied as the target_branch to pull hooks.
3285
 
        :param local: Only update the local branch, and not the bound branch.
3286
3311
        """
3287
 
        # This type of branch can't be bound.
3288
 
        if local:
 
3312
        bound_location = self.target.get_bound_location()
 
3313
        if local and not bound_location:
3289
3314
            raise errors.LocalRequiresBoundBranch()
3290
 
        result = PullResult()
3291
 
        result.source_branch = self.source
3292
 
        if _override_hook_target is None:
3293
 
            result.target_branch = self.target
3294
 
        else:
3295
 
            result.target_branch = _override_hook_target
3296
 
        self.source.lock_read()
 
3315
        master_branch = None
 
3316
        if not local and bound_location and self.source.user_url != bound_location:
 
3317
            # not pulling from master, so we need to update master.
 
3318
            master_branch = self.target.get_master_branch(possible_transports)
 
3319
            master_branch.lock_write()
3297
3320
        try:
3298
 
            # We assume that during 'pull' the target repository is closer than
3299
 
            # the source one.
3300
 
            self.source.update_references(self.target)
3301
 
            graph = self.target.repository.get_graph(self.source.repository)
3302
 
            # TODO: Branch formats should have a flag that indicates 
3303
 
            # that revno's are expensive, and pull() should honor that flag.
3304
 
            # -- JRV20090506
3305
 
            result.old_revno, result.old_revid = \
3306
 
                self.target.last_revision_info()
3307
 
            self.target.update_revisions(self.source, stop_revision,
3308
 
                overwrite=overwrite, graph=graph)
3309
 
            # TODO: The old revid should be specified when merging tags, 
3310
 
            # so a tags implementation that versions tags can only 
3311
 
            # pull in the most recent changes. -- JRV20090506
3312
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3313
 
                overwrite)
3314
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3315
 
            if _hook_master:
3316
 
                result.master_branch = _hook_master
3317
 
                result.local_branch = result.target_branch
3318
 
            else:
3319
 
                result.master_branch = result.target_branch
3320
 
                result.local_branch = None
3321
 
            if run_hooks:
3322
 
                for hook in Branch.hooks['post_pull']:
3323
 
                    hook(result)
 
3321
            if master_branch:
 
3322
                # pull from source into master.
 
3323
                master_branch.pull(self.source, overwrite, stop_revision,
 
3324
                    run_hooks=False)
 
3325
            return self._pull(overwrite,
 
3326
                stop_revision, _hook_master=master_branch,
 
3327
                run_hooks=run_hooks,
 
3328
                _override_hook_target=_override_hook_target)
3324
3329
        finally:
3325
 
            self.source.unlock()
3326
 
        return result
 
3330
            if master_branch:
 
3331
                master_branch.unlock()
3327
3332
 
3328
3333
    def push(self, overwrite=False, stop_revision=None,
3329
3334
             _override_hook_source_branch=None):
3391
3396
            _run_hooks()
3392
3397
            return result
3393
3398
 
3394
 
    @classmethod
3395
 
    def is_compatible(self, source, target):
3396
 
        # GenericBranch uses the public API, so always compatible
3397
 
        return True
3398
 
 
3399
 
 
3400
 
class InterToBranch5(GenericInterBranch):
3401
 
 
3402
 
    @staticmethod
3403
 
    def _get_branch_formats_to_test():
3404
 
        return BranchFormat._default_format, BzrBranchFormat5()
3405
 
 
3406
 
    def pull(self, overwrite=False, stop_revision=None,
3407
 
             possible_transports=None, run_hooks=True,
 
3399
    def _pull(self, overwrite=False, stop_revision=None,
 
3400
             possible_transports=None, _hook_master=None, run_hooks=True,
3408
3401
             _override_hook_target=None, local=False):
3409
 
        """Pull from source into self, updating my master if any.
3410
 
 
 
3402
        """See Branch.pull.
 
3403
 
 
3404
        This function is the core worker, used by GenericInterBranch.pull to
 
3405
        avoid duplication when pulling source->master and source->local.
 
3406
 
 
3407
        :param _hook_master: Private parameter - set the branch to
 
3408
            be supplied as the master to pull hooks.
3411
3409
        :param run_hooks: Private parameter - if false, this branch
3412
3410
            is being called because it's the master of the primary branch,
3413
3411
            so it should not run its hooks.
 
3412
        :param _override_hook_target: Private parameter - set the branch to be
 
3413
            supplied as the target_branch to pull hooks.
 
3414
        :param local: Only update the local branch, and not the bound branch.
3414
3415
        """
3415
 
        bound_location = self.target.get_bound_location()
3416
 
        if local and not bound_location:
 
3416
        # This type of branch can't be bound.
 
3417
        if local:
3417
3418
            raise errors.LocalRequiresBoundBranch()
3418
 
        master_branch = None
3419
 
        if not local and bound_location and self.source.user_url != bound_location:
3420
 
            # not pulling from master, so we need to update master.
3421
 
            master_branch = self.target.get_master_branch(possible_transports)
3422
 
            master_branch.lock_write()
 
3419
        result = PullResult()
 
3420
        result.source_branch = self.source
 
3421
        if _override_hook_target is None:
 
3422
            result.target_branch = self.target
 
3423
        else:
 
3424
            result.target_branch = _override_hook_target
 
3425
        self.source.lock_read()
3423
3426
        try:
3424
 
            if master_branch:
3425
 
                # pull from source into master.
3426
 
                master_branch.pull(self.source, overwrite, stop_revision,
3427
 
                    run_hooks=False)
3428
 
            return super(InterToBranch5, self).pull(overwrite,
3429
 
                stop_revision, _hook_master=master_branch,
3430
 
                run_hooks=run_hooks,
3431
 
                _override_hook_target=_override_hook_target)
 
3427
            # We assume that during 'pull' the target repository is closer than
 
3428
            # the source one.
 
3429
            self.source.update_references(self.target)
 
3430
            graph = self.target.repository.get_graph(self.source.repository)
 
3431
            # TODO: Branch formats should have a flag that indicates 
 
3432
            # that revno's are expensive, and pull() should honor that flag.
 
3433
            # -- JRV20090506
 
3434
            result.old_revno, result.old_revid = \
 
3435
                self.target.last_revision_info()
 
3436
            self.target.update_revisions(self.source, stop_revision,
 
3437
                overwrite=overwrite, graph=graph)
 
3438
            # TODO: The old revid should be specified when merging tags, 
 
3439
            # so a tags implementation that versions tags can only 
 
3440
            # pull in the most recent changes. -- JRV20090506
 
3441
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3442
                overwrite)
 
3443
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3444
            if _hook_master:
 
3445
                result.master_branch = _hook_master
 
3446
                result.local_branch = result.target_branch
 
3447
            else:
 
3448
                result.master_branch = result.target_branch
 
3449
                result.local_branch = None
 
3450
            if run_hooks:
 
3451
                for hook in Branch.hooks['post_pull']:
 
3452
                    hook(result)
3432
3453
        finally:
3433
 
            if master_branch:
3434
 
                master_branch.unlock()
 
3454
            self.source.unlock()
 
3455
        return result
3435
3456
 
3436
3457
 
3437
3458
InterBranch.register_optimiser(GenericInterBranch)
3438
 
InterBranch.register_optimiser(InterToBranch5)