1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib import registry
53
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
# TODO: Maybe include checks for common corruption of newlines, etc?
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas. We could perhaps have a weakref
69
# cache in memory to make this faster. In general anything can be
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
74
######################################################################
78
"""Branch holding a history of revisions.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def _activate_fallback_location(self, url, lock_style):
105
"""Activate the branch/repository from url as a fallback repository."""
106
repo = self._get_fallback_repository(url)
107
if lock_style == 'write':
109
elif lock_style == 'read':
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
133
def open(base, _unsupported=False, possible_transports=None):
134
"""Open the branch rooted at base.
136
For instance, if the branch is at URL/.bzr/branch,
137
Branch.open(URL) -> a Branch instance.
139
control = bzrdir.BzrDir.open(base, _unsupported,
140
possible_transports=possible_transports)
141
return control.open_branch(_unsupported)
144
def open_from_transport(transport, _unsupported=False):
145
"""Open the branch rooted at transport"""
146
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
147
return control.open_branch(_unsupported)
150
def open_containing(url, possible_transports=None):
151
"""Open an existing branch which contains url.
153
This probes for a branch at url, and searches upwards from there.
155
Basically we keep looking up until we find the control directory or
156
run into the root. If there isn't one, raises NotBranchError.
157
If there is one and it is either an unrecognised format or an unsupported
158
format, UnknownFormatError or UnsupportedFormatError are raised.
159
If there is one, it is returned, along with the unused portion of url.
161
control, relpath = bzrdir.BzrDir.open_containing(url,
163
return control.open_branch(), relpath
165
def _push_should_merge_tags(self):
166
"""Should _basic_push merge this branch's tags into the target?
168
The default implementation returns False if this branch has no tags,
169
and True the rest of the time. Subclasses may override this.
171
return self.supports_tags() and self.tags.get_tag_dict()
173
def get_config(self):
174
return BranchConfig(self)
176
def _get_config(self):
177
"""Get the concrete config for just the config in this branch.
179
This is not intended for client use; see Branch.get_config for the
184
:return: An object supporting get_option and set_option.
186
raise NotImplementedError(self._get_config)
188
def _get_fallback_repository(self, url):
189
"""Get the repository we fallback to at url."""
190
url = urlutils.join(self.base, url)
191
a_bzrdir = bzrdir.BzrDir.open(url,
192
possible_transports=[self.bzrdir.root_transport])
193
return a_bzrdir.open_branch().repository
195
def _get_tags_bytes(self):
196
"""Get the bytes of a serialised tags dict.
198
Note that not all branches support tags, nor do all use the same tags
199
logic: this method is specific to BasicTags. Other tag implementations
200
may use the same method name and behave differently, safely, because
201
of the double-dispatch via
202
format.make_tags->tags_instance->get_tags_dict.
204
:return: The bytes of the tags file.
205
:seealso: Branch._set_tags_bytes.
207
return self._transport.get_bytes('tags')
209
def _get_nick(self, local=False, possible_transports=None):
210
config = self.get_config()
211
# explicit overrides master, but don't look for master if local is True
212
if not local and not config.has_explicit_nickname():
214
master = self.get_master_branch(possible_transports)
215
if master is not None:
216
# return the master branch value
218
except errors.BzrError, e:
219
# Silently fall back to local implicit nick if the master is
221
mutter("Could not connect to bound branch, "
222
"falling back to local nick.\n " + str(e))
223
return config.get_nickname()
225
def _set_nick(self, nick):
226
self.get_config().set_user_option('nickname', nick, warn_masked=True)
228
nick = property(_get_nick, _set_nick)
231
raise NotImplementedError(self.is_locked)
233
def _lefthand_history(self, revision_id, last_rev=None,
235
if 'evil' in debug.debug_flags:
236
mutter_callsite(4, "_lefthand_history scales with history.")
237
# stop_revision must be a descendant of last_revision
238
graph = self.repository.get_graph()
239
if last_rev is not None:
240
if not graph.is_ancestor(last_rev, revision_id):
241
# our previous tip is not merged into stop_revision
242
raise errors.DivergedBranches(self, other_branch)
243
# make a new revision history from the graph
244
parents_map = graph.get_parent_map([revision_id])
245
if revision_id not in parents_map:
246
raise errors.NoSuchRevision(self, revision_id)
247
current_rev_id = revision_id
249
check_not_reserved_id = _mod_revision.check_not_reserved_id
250
# Do not include ghosts or graph origin in revision_history
251
while (current_rev_id in parents_map and
252
len(parents_map[current_rev_id]) > 0):
253
check_not_reserved_id(current_rev_id)
254
new_history.append(current_rev_id)
255
current_rev_id = parents_map[current_rev_id][0]
256
parents_map = graph.get_parent_map([current_rev_id])
257
new_history.reverse()
260
def lock_write(self):
261
raise NotImplementedError(self.lock_write)
264
raise NotImplementedError(self.lock_read)
267
raise NotImplementedError(self.unlock)
269
def peek_lock_mode(self):
270
"""Return lock mode for the Branch: 'r', 'w' or None"""
271
raise NotImplementedError(self.peek_lock_mode)
273
def get_physical_lock_status(self):
274
raise NotImplementedError(self.get_physical_lock_status)
277
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
278
"""Return the revision_id for a dotted revno.
280
:param revno: a tuple like (1,) or (1,1,2)
281
:param _cache_reverse: a private parameter enabling storage
282
of the reverse mapping in a top level cache. (This should
283
only be done in selective circumstances as we want to
284
avoid having the mapping cached multiple times.)
285
:return: the revision_id
286
:raises errors.NoSuchRevision: if the revno doesn't exist
288
rev_id = self._do_dotted_revno_to_revision_id(revno)
290
self._partial_revision_id_to_revno_cache[rev_id] = revno
293
def _do_dotted_revno_to_revision_id(self, revno):
294
"""Worker function for dotted_revno_to_revision_id.
296
Subclasses should override this if they wish to
297
provide a more efficient implementation.
300
return self.get_rev_id(revno[0])
301
revision_id_to_revno = self.get_revision_id_to_revno_map()
302
revision_ids = [revision_id for revision_id, this_revno
303
in revision_id_to_revno.iteritems()
304
if revno == this_revno]
305
if len(revision_ids) == 1:
306
return revision_ids[0]
308
revno_str = '.'.join(map(str, revno))
309
raise errors.NoSuchRevision(self, revno_str)
312
def revision_id_to_dotted_revno(self, revision_id):
313
"""Given a revision id, return its dotted revno.
315
:return: a tuple like (1,) or (400,1,3).
317
return self._do_revision_id_to_dotted_revno(revision_id)
319
def _do_revision_id_to_dotted_revno(self, revision_id):
320
"""Worker function for revision_id_to_revno."""
321
# Try the caches if they are loaded
322
result = self._partial_revision_id_to_revno_cache.get(revision_id)
323
if result is not None:
325
if self._revision_id_to_revno_cache:
326
result = self._revision_id_to_revno_cache.get(revision_id)
328
raise errors.NoSuchRevision(self, revision_id)
329
# Try the mainline as it's optimised
331
revno = self.revision_id_to_revno(revision_id)
333
except errors.NoSuchRevision:
334
# We need to load and use the full revno map after all
335
result = self.get_revision_id_to_revno_map().get(revision_id)
337
raise errors.NoSuchRevision(self, revision_id)
341
def get_revision_id_to_revno_map(self):
342
"""Return the revision_id => dotted revno map.
344
This will be regenerated on demand, but will be cached.
346
:return: A dictionary mapping revision_id => dotted revno.
347
This dictionary should not be modified by the caller.
349
if self._revision_id_to_revno_cache is not None:
350
mapping = self._revision_id_to_revno_cache
352
mapping = self._gen_revno_map()
353
self._cache_revision_id_to_revno(mapping)
354
# TODO: jam 20070417 Since this is being cached, should we be returning
356
# I would rather not, and instead just declare that users should not
357
# modify the return value.
360
def _gen_revno_map(self):
361
"""Create a new mapping from revision ids to dotted revnos.
363
Dotted revnos are generated based on the current tip in the revision
365
This is the worker function for get_revision_id_to_revno_map, which
366
just caches the return value.
368
:return: A dictionary mapping revision_id => dotted revno.
370
revision_id_to_revno = dict((rev_id, revno)
371
for rev_id, depth, revno, end_of_merge
372
in self.iter_merge_sorted_revisions())
373
return revision_id_to_revno
376
def iter_merge_sorted_revisions(self, start_revision_id=None,
377
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
378
"""Walk the revisions for a branch in merge sorted order.
380
Merge sorted order is the output from a merge-aware,
381
topological sort, i.e. all parents come before their
382
children going forward; the opposite for reverse.
384
:param start_revision_id: the revision_id to begin walking from.
385
If None, the branch tip is used.
386
:param stop_revision_id: the revision_id to terminate the walk
387
after. If None, the rest of history is included.
388
:param stop_rule: if stop_revision_id is not None, the precise rule
389
to use for termination:
390
* 'exclude' - leave the stop revision out of the result (default)
391
* 'include' - the stop revision is the last item in the result
392
* 'with-merges' - include the stop revision and all of its
393
merged revisions in the result
394
:param direction: either 'reverse' or 'forward':
395
* reverse means return the start_revision_id first, i.e.
396
start at the most recent revision and go backwards in history
397
* forward returns tuples in the opposite order to reverse.
398
Note in particular that forward does *not* do any intelligent
399
ordering w.r.t. depth as some clients of this API may like.
400
(If required, that ought to be done at higher layers.)
402
:return: an iterator over (revision_id, depth, revno, end_of_merge)
405
* revision_id: the unique id of the revision
406
* depth: How many levels of merging deep this node has been
408
* revno_sequence: This field provides a sequence of
409
revision numbers for all revisions. The format is:
410
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
411
branch that the revno is on. From left to right the REVNO numbers
412
are the sequence numbers within that branch of the revision.
413
* end_of_merge: When True the next node (earlier in history) is
414
part of a different merge.
416
# Note: depth and revno values are in the context of the branch so
417
# we need the full graph to get stable numbers, regardless of the
419
if self._merge_sorted_revisions_cache is None:
420
last_revision = self.last_revision()
421
graph = self.repository.get_graph()
422
parent_map = dict(((key, value) for key, value in
423
graph.iter_ancestry([last_revision]) if value is not None))
424
revision_graph = repository._strip_NULL_ghosts(parent_map)
425
revs = tsort.merge_sort(revision_graph, last_revision, None,
427
# Drop the sequence # before caching
428
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
430
filtered = self._filter_merge_sorted_revisions(
431
self._merge_sorted_revisions_cache, start_revision_id,
432
stop_revision_id, stop_rule)
433
if direction == 'reverse':
435
if direction == 'forward':
436
return reversed(list(filtered))
438
raise ValueError('invalid direction %r' % direction)
440
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
441
start_revision_id, stop_revision_id, stop_rule):
442
"""Iterate over an inclusive range of sorted revisions."""
443
rev_iter = iter(merge_sorted_revisions)
444
if start_revision_id is not None:
445
for rev_id, depth, revno, end_of_merge in rev_iter:
446
if rev_id != start_revision_id:
449
# The decision to include the start or not
450
# depends on the stop_rule if a stop is provided
452
iter([(rev_id, depth, revno, end_of_merge)]),
455
if stop_revision_id is None:
456
for rev_id, depth, revno, end_of_merge in rev_iter:
457
yield rev_id, depth, revno, end_of_merge
458
elif stop_rule == 'exclude':
459
for rev_id, depth, revno, end_of_merge in rev_iter:
460
if rev_id == stop_revision_id:
462
yield rev_id, depth, revno, end_of_merge
463
elif stop_rule == 'include':
464
for rev_id, depth, revno, end_of_merge in rev_iter:
465
yield rev_id, depth, revno, end_of_merge
466
if rev_id == stop_revision_id:
468
elif stop_rule == 'with-merges':
469
stop_rev = self.repository.get_revision(stop_revision_id)
470
if stop_rev.parent_ids:
471
left_parent = stop_rev.parent_ids[0]
473
left_parent = _mod_revision.NULL_REVISION
474
for rev_id, depth, revno, end_of_merge in rev_iter:
475
if rev_id == left_parent:
477
yield rev_id, depth, revno, end_of_merge
479
raise ValueError('invalid stop_rule %r' % stop_rule)
481
def leave_lock_in_place(self):
482
"""Tell this branch object not to release the physical lock when this
485
If lock_write doesn't return a token, then this method is not supported.
487
self.control_files.leave_in_place()
489
def dont_leave_lock_in_place(self):
490
"""Tell this branch object to release the physical lock when this
491
object is unlocked, even if it didn't originally acquire it.
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.dont_leave_in_place()
497
def bind(self, other):
498
"""Bind the local branch the other branch.
500
:param other: The branch to bind to
503
raise errors.UpgradeRequired(self.base)
505
def set_reference_info(self, file_id, tree_path, branch_location):
506
"""Set the branch location to use for a tree reference."""
507
raise errors.UnsupportedOperation(self.set_reference_info, self)
509
def get_reference_info(self, file_id):
510
"""Get the tree_path and branch_location for a tree reference."""
511
raise errors.UnsupportedOperation(self.get_reference_info, self)
514
def fetch(self, from_branch, last_revision=None, pb=None):
515
"""Copy revisions from from_branch into this branch.
517
:param from_branch: Where to copy from.
518
:param last_revision: What revision to stop at (None for at the end
520
:param pb: An optional progress bar to use.
523
if self.base == from_branch.base:
526
symbol_versioning.warn(
527
symbol_versioning.deprecated_in((1, 14, 0))
528
% "pb parameter to fetch()")
529
from_branch.lock_read()
531
if last_revision is None:
532
last_revision = from_branch.last_revision()
533
last_revision = _mod_revision.ensure_null(last_revision)
534
return self.repository.fetch(from_branch.repository,
535
revision_id=last_revision,
540
def get_bound_location(self):
541
"""Return the URL of the branch we are bound to.
543
Older format branches cannot bind, please be sure to use a metadir
548
def get_old_bound_location(self):
549
"""Return the URL of the branch we used to be bound to
551
raise errors.UpgradeRequired(self.base)
553
def get_commit_builder(self, parents, config=None, timestamp=None,
554
timezone=None, committer=None, revprops=None,
556
"""Obtain a CommitBuilder for this branch.
558
:param parents: Revision ids of the parents of the new revision.
559
:param config: Optional configuration to use.
560
:param timestamp: Optional timestamp recorded for commit.
561
:param timezone: Optional timezone for timestamp.
562
:param committer: Optional committer to set for commit.
563
:param revprops: Optional dictionary of revision properties.
564
:param revision_id: Optional revision id.
568
config = self.get_config()
570
return self.repository.get_commit_builder(self, parents, config,
571
timestamp, timezone, committer, revprops, revision_id)
573
def get_master_branch(self, possible_transports=None):
574
"""Return the branch we are bound to.
576
:return: Either a Branch, or None
580
def get_revision_delta(self, revno):
581
"""Return the delta for one revision.
583
The delta is relative to its mainline predecessor, or the
584
empty tree for revision 1.
586
rh = self.revision_history()
587
if not (1 <= revno <= len(rh)):
588
raise errors.InvalidRevisionNumber(revno)
589
return self.repository.get_revision_delta(rh[revno-1])
591
def get_stacked_on_url(self):
592
"""Get the URL this branch is stacked against.
594
:raises NotStacked: If the branch is not stacked.
595
:raises UnstackableBranchFormat: If the branch does not support
598
raise NotImplementedError(self.get_stacked_on_url)
600
def print_file(self, file, revision_id):
601
"""Print `file` to stdout."""
602
raise NotImplementedError(self.print_file)
604
def set_revision_history(self, rev_history):
605
raise NotImplementedError(self.set_revision_history)
608
def set_parent(self, url):
609
"""See Branch.set_parent."""
610
# TODO: Maybe delete old location files?
611
# URLs should never be unicode, even on the local fs,
612
# FIXUP this and get_parent in a future branch format bump:
613
# read and rewrite the file. RBC 20060125
615
if isinstance(url, unicode):
617
url = url.encode('ascii')
618
except UnicodeEncodeError:
619
raise errors.InvalidURL(url,
620
"Urls must be 7-bit ascii, "
621
"use bzrlib.urlutils.escape")
622
url = urlutils.relative_url(self.base, url)
623
self._set_parent_location(url)
626
def set_stacked_on_url(self, url):
627
"""Set the URL this branch is stacked against.
629
:raises UnstackableBranchFormat: If the branch does not support
631
:raises UnstackableRepositoryFormat: If the repository does not support
634
if not self._format.supports_stacking():
635
raise errors.UnstackableBranchFormat(self._format, self.base)
636
self._check_stackable_repo()
639
old_url = self.get_stacked_on_url()
640
except (errors.NotStacked, errors.UnstackableBranchFormat,
641
errors.UnstackableRepositoryFormat):
644
# XXX: Lock correctness - should unlock our old repo if we were
646
# repositories don't offer an interface to remove fallback
647
# repositories today; take the conceptually simpler option and just
649
self.repository = self.bzrdir.find_repository()
650
self.repository.lock_write()
651
# for every revision reference the branch has, ensure it is pulled
653
source_repository = self._get_fallback_repository(old_url)
654
for revision_id in chain([self.last_revision()],
655
self.tags.get_reverse_tag_dict()):
656
self.repository.fetch(source_repository, revision_id,
659
self._activate_fallback_location(url, 'write')
660
# write this out after the repository is stacked to avoid setting a
661
# stacked config that doesn't work.
662
self._set_config_location('stacked_on_location', url)
665
def _set_tags_bytes(self, bytes):
666
"""Mirror method for _get_tags_bytes.
668
:seealso: Branch._get_tags_bytes.
670
return _run_with_write_locked_target(self, self._transport.put_bytes,
673
def _cache_revision_history(self, rev_history):
674
"""Set the cached revision history to rev_history.
676
The revision_history method will use this cache to avoid regenerating
677
the revision history.
679
This API is semi-public; it only for use by subclasses, all other code
680
should consider it to be private.
682
self._revision_history_cache = rev_history
684
def _cache_revision_id_to_revno(self, revision_id_to_revno):
685
"""Set the cached revision_id => revno map to revision_id_to_revno.
687
This API is semi-public; it only for use by subclasses, all other code
688
should consider it to be private.
690
self._revision_id_to_revno_cache = revision_id_to_revno
692
def _clear_cached_state(self):
693
"""Clear any cached data on this branch, e.g. cached revision history.
695
This means the next call to revision_history will need to call
696
_gen_revision_history.
698
This API is semi-public; it only for use by subclasses, all other code
699
should consider it to be private.
701
self._revision_history_cache = None
702
self._revision_id_to_revno_cache = None
703
self._last_revision_info_cache = None
704
self._merge_sorted_revisions_cache = None
706
def _gen_revision_history(self):
707
"""Return sequence of revision hashes on to this branch.
709
Unlike revision_history, this method always regenerates or rereads the
710
revision history, i.e. it does not cache the result, so repeated calls
713
Concrete subclasses should override this instead of revision_history so
714
that subclasses do not need to deal with caching logic.
716
This API is semi-public; it only for use by subclasses, all other code
717
should consider it to be private.
719
raise NotImplementedError(self._gen_revision_history)
722
def revision_history(self):
723
"""Return sequence of revision ids on this branch.
725
This method will cache the revision history for as long as it is safe to
728
if 'evil' in debug.debug_flags:
729
mutter_callsite(3, "revision_history scales with history.")
730
if self._revision_history_cache is not None:
731
history = self._revision_history_cache
733
history = self._gen_revision_history()
734
self._cache_revision_history(history)
738
"""Return current revision number for this branch.
740
That is equivalent to the number of revisions committed to
743
return self.last_revision_info()[0]
746
"""Older format branches cannot bind or unbind."""
747
raise errors.UpgradeRequired(self.base)
749
def set_append_revisions_only(self, enabled):
750
"""Older format branches are never restricted to append-only"""
751
raise errors.UpgradeRequired(self.base)
753
def last_revision(self):
754
"""Return last revision id, or NULL_REVISION."""
755
return self.last_revision_info()[1]
758
def last_revision_info(self):
759
"""Return information about the last revision.
761
:return: A tuple (revno, revision_id).
763
if self._last_revision_info_cache is None:
764
self._last_revision_info_cache = self._last_revision_info()
765
return self._last_revision_info_cache
767
def _last_revision_info(self):
768
rh = self.revision_history()
771
return (revno, rh[-1])
773
return (0, _mod_revision.NULL_REVISION)
775
@deprecated_method(deprecated_in((1, 6, 0)))
776
def missing_revisions(self, other, stop_revision=None):
777
"""Return a list of new revisions that would perfectly fit.
779
If self and other have not diverged, return a list of the revisions
780
present in other, but missing from self.
782
self_history = self.revision_history()
783
self_len = len(self_history)
784
other_history = other.revision_history()
785
other_len = len(other_history)
786
common_index = min(self_len, other_len) -1
787
if common_index >= 0 and \
788
self_history[common_index] != other_history[common_index]:
789
raise errors.DivergedBranches(self, other)
791
if stop_revision is None:
792
stop_revision = other_len
794
if stop_revision > other_len:
795
raise errors.NoSuchRevision(self, stop_revision)
796
return other_history[self_len:stop_revision]
799
def update_revisions(self, other, stop_revision=None, overwrite=False,
801
"""Pull in new perfect-fit revisions.
803
:param other: Another Branch to pull from
804
:param stop_revision: Updated until the given revision
805
:param overwrite: Always set the branch pointer, rather than checking
806
to see if it is a proper descendant.
807
:param graph: A Graph object that can be used to query history
808
information. This can be None.
811
return InterBranch.get(other, self).update_revisions(stop_revision,
814
def import_last_revision_info(self, source_repo, revno, revid):
815
"""Set the last revision info, importing from another repo if necessary.
817
This is used by the bound branch code to upload a revision to
818
the master branch first before updating the tip of the local branch.
820
:param source_repo: Source repository to optionally fetch from
821
:param revno: Revision number of the new tip
822
:param revid: Revision id of the new tip
824
if not self.repository.has_same_location(source_repo):
825
self.repository.fetch(source_repo, revision_id=revid)
826
self.set_last_revision_info(revno, revid)
828
def revision_id_to_revno(self, revision_id):
829
"""Given a revision id, return its revno"""
830
if _mod_revision.is_null(revision_id):
832
history = self.revision_history()
834
return history.index(revision_id) + 1
836
raise errors.NoSuchRevision(self, revision_id)
838
def get_rev_id(self, revno, history=None):
839
"""Find the revision id of the specified revno."""
841
return _mod_revision.NULL_REVISION
843
history = self.revision_history()
844
if revno <= 0 or revno > len(history):
845
raise errors.NoSuchRevision(self, revno)
846
return history[revno - 1]
849
def pull(self, source, overwrite=False, stop_revision=None,
850
possible_transports=None, *args, **kwargs):
851
"""Mirror source into this branch.
853
This branch is considered to be 'local', having low latency.
855
:returns: PullResult instance
857
return InterBranch.get(source, self).pull(overwrite=overwrite,
858
stop_revision=stop_revision,
859
possible_transports=possible_transports, *args, **kwargs)
861
def push(self, target, overwrite=False, stop_revision=None, *args,
863
"""Mirror this branch into target.
865
This branch is considered to be 'local', having low latency.
867
return InterBranch.get(self, target).push(overwrite, stop_revision,
870
def lossy_push(self, target, stop_revision=None):
871
"""Push deltas into another branch.
873
:note: This does not, like push, retain the revision ids from
874
the source branch and will, rather than adding bzr-specific
875
metadata, push only those semantics of the revision that can be
876
natively represented by this branch' VCS.
878
:param target: Target branch
879
:param stop_revision: Revision to push, defaults to last revision.
880
:return: BranchPushResult with an extra member revidmap:
881
A dictionary mapping revision ids from the target branch
882
to new revision ids in the target branch, for each
883
revision that was pushed.
885
inter = InterBranch.get(self, target)
886
lossy_push = getattr(inter, "lossy_push", None)
887
if lossy_push is None:
888
raise errors.LossyPushToSameVCS(self, target)
889
return lossy_push(stop_revision)
891
def basis_tree(self):
892
"""Return `Tree` object for last revision."""
893
return self.repository.revision_tree(self.last_revision())
895
def get_parent(self):
896
"""Return the parent location of the branch.
898
This is the default location for pull/missing. The usual
899
pattern is that the user can override it by specifying a
902
parent = self._get_parent_location()
905
# This is an old-format absolute path to a local branch
907
if parent.startswith('/'):
908
parent = urlutils.local_path_to_url(parent.decode('utf8'))
910
return urlutils.join(self.base[:-1], parent)
911
except errors.InvalidURLJoin, e:
912
raise errors.InaccessibleParent(parent, self.base)
914
def _get_parent_location(self):
915
raise NotImplementedError(self._get_parent_location)
917
def _set_config_location(self, name, url, config=None,
918
make_relative=False):
920
config = self.get_config()
924
url = urlutils.relative_url(self.base, url)
925
config.set_user_option(name, url, warn_masked=True)
927
def _get_config_location(self, name, config=None):
929
config = self.get_config()
930
location = config.get_user_option(name)
935
def get_child_submit_format(self):
936
"""Return the preferred format of submissions to this branch."""
937
return self.get_config().get_user_option("child_submit_format")
939
def get_submit_branch(self):
940
"""Return the submit location of the branch.
942
This is the default location for bundle. The usual
943
pattern is that the user can override it by specifying a
946
return self.get_config().get_user_option('submit_branch')
948
def set_submit_branch(self, location):
949
"""Return the submit location of the branch.
951
This is the default location for bundle. The usual
952
pattern is that the user can override it by specifying a
955
self.get_config().set_user_option('submit_branch', location,
958
def get_public_branch(self):
959
"""Return the public location of the branch.
961
This is used by merge directives.
963
return self._get_config_location('public_branch')
965
def set_public_branch(self, location):
966
"""Return the submit location of the branch.
968
This is the default location for bundle. The usual
969
pattern is that the user can override it by specifying a
972
self._set_config_location('public_branch', location)
974
def get_push_location(self):
975
"""Return the None or the location to push this branch to."""
976
push_loc = self.get_config().get_user_option('push_location')
979
def set_push_location(self, location):
980
"""Set a new push location for this branch."""
981
raise NotImplementedError(self.set_push_location)
983
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
984
"""Run the post_change_branch_tip hooks."""
985
hooks = Branch.hooks['post_change_branch_tip']
988
new_revno, new_revid = self.last_revision_info()
989
params = ChangeBranchTipParams(
990
self, old_revno, new_revno, old_revid, new_revid)
994
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
995
"""Run the pre_change_branch_tip hooks."""
996
hooks = Branch.hooks['pre_change_branch_tip']
999
old_revno, old_revid = self.last_revision_info()
1000
params = ChangeBranchTipParams(
1001
self, old_revno, new_revno, old_revid, new_revid)
1005
except errors.TipChangeRejected:
1008
exc_info = sys.exc_info()
1009
hook_name = Branch.hooks.get_hook_name(hook)
1010
raise errors.HookFailed(
1011
'pre_change_branch_tip', hook_name, exc_info)
1015
"""Synchronise this branch with the master branch if any.
1017
:return: None or the last_revision pivoted out during the update.
1021
def check_revno(self, revno):
1023
Check whether a revno corresponds to any revision.
1024
Zero (the NULL revision) is considered valid.
1027
self.check_real_revno(revno)
1029
def check_real_revno(self, revno):
1031
Check whether a revno corresponds to a real revision.
1032
Zero (the NULL revision) is considered invalid
1034
if revno < 1 or revno > self.revno():
1035
raise errors.InvalidRevisionNumber(revno)
1038
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1039
"""Clone this branch into to_bzrdir preserving all semantic values.
1041
Most API users will want 'create_clone_on_transport', which creates a
1042
new bzrdir and branch on the fly.
1044
revision_id: if not None, the revision history in the new branch will
1045
be truncated to end with revision_id.
1047
result = to_bzrdir.create_branch()
1050
if repository_policy is not None:
1051
repository_policy.configure_branch(result)
1052
self.copy_content_into(result, revision_id=revision_id)
1058
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1059
"""Create a new line of development from the branch, into to_bzrdir.
1061
to_bzrdir controls the branch format.
1063
revision_id: if not None, the revision history in the new branch will
1064
be truncated to end with revision_id.
1066
result = to_bzrdir.create_branch()
1069
if repository_policy is not None:
1070
repository_policy.configure_branch(result)
1071
self.copy_content_into(result, revision_id=revision_id)
1072
result.set_parent(self.bzrdir.root_transport.base)
1077
def _synchronize_history(self, destination, revision_id):
1078
"""Synchronize last revision and revision history between branches.
1080
This version is most efficient when the destination is also a
1081
BzrBranch6, but works for BzrBranch5, as long as the destination's
1082
repository contains all the lefthand ancestors of the intended
1083
last_revision. If not, set_last_revision_info will fail.
1085
:param destination: The branch to copy the history into
1086
:param revision_id: The revision-id to truncate history at. May
1087
be None to copy complete history.
1089
source_revno, source_revision_id = self.last_revision_info()
1090
if revision_id is None:
1091
revno, revision_id = source_revno, source_revision_id
1093
graph = self.repository.get_graph()
1095
revno = graph.find_distance_to_null(revision_id,
1096
[(source_revision_id, source_revno)])
1097
except errors.GhostRevisionsHaveNoRevno:
1098
# Default to 1, if we can't find anything else
1100
destination.set_last_revision_info(revno, revision_id)
1103
def copy_content_into(self, destination, revision_id=None):
1104
"""Copy the content of self into destination.
1106
revision_id: if not None, the revision history in the new branch will
1107
be truncated to end with revision_id.
1109
self.update_references(destination)
1110
self._synchronize_history(destination, revision_id)
1112
parent = self.get_parent()
1113
except errors.InaccessibleParent, e:
1114
mutter('parent was not accessible to copy: %s', e)
1117
destination.set_parent(parent)
1118
if self._push_should_merge_tags():
1119
self.tags.merge_to(destination.tags)
1121
def update_references(self, target):
1122
if not getattr(self._format, 'supports_reference_locations', False):
1124
reference_dict = self._get_all_reference_info()
1125
if len(reference_dict) == 0:
1127
old_base = self.base
1128
new_base = target.base
1129
target_reference_dict = target._get_all_reference_info()
1130
for file_id, (tree_path, branch_location) in (
1131
reference_dict.items()):
1132
branch_location = urlutils.rebase_url(branch_location,
1134
target_reference_dict.setdefault(
1135
file_id, (tree_path, branch_location))
1136
target._set_all_reference_info(target_reference_dict)
1140
"""Check consistency of the branch.
1142
In particular this checks that revisions given in the revision-history
1143
do actually match up in the revision graph, and that they're all
1144
present in the repository.
1146
Callers will typically also want to check the repository.
1148
:return: A BranchCheckResult.
1150
ret = BranchCheckResult(self)
1151
mainline_parent_id = None
1152
last_revno, last_revision_id = self.last_revision_info()
1153
real_rev_history = []
1155
for revid in self.repository.iter_reverse_revision_history(
1157
real_rev_history.append(revid)
1158
except errors.RevisionNotPresent:
1159
ret.ghosts_in_mainline = True
1161
ret.ghosts_in_mainline = False
1162
real_rev_history.reverse()
1163
if len(real_rev_history) != last_revno:
1164
raise errors.BzrCheckError('revno does not match len(mainline)'
1165
' %s != %s' % (last_revno, len(real_rev_history)))
1166
# TODO: We should probably also check that real_rev_history actually
1167
# matches self.revision_history()
1168
for revision_id in real_rev_history:
1170
revision = self.repository.get_revision(revision_id)
1171
except errors.NoSuchRevision, e:
1172
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1174
# In general the first entry on the revision history has no parents.
1175
# But it's not illegal for it to have parents listed; this can happen
1176
# in imports from Arch when the parents weren't reachable.
1177
if mainline_parent_id is not None:
1178
if mainline_parent_id not in revision.parent_ids:
1179
raise errors.BzrCheckError("previous revision {%s} not listed among "
1181
% (mainline_parent_id, revision_id))
1182
mainline_parent_id = revision_id
1185
def _get_checkout_format(self):
1186
"""Return the most suitable metadir for a checkout of this branch.
1187
Weaves are used if this branch's repository uses weaves.
1189
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1190
from bzrlib.repofmt import weaverepo
1191
format = bzrdir.BzrDirMetaFormat1()
1192
format.repository_format = weaverepo.RepositoryFormat7()
1194
format = self.repository.bzrdir.checkout_metadir()
1195
format.set_branch_format(self._format)
1198
def create_clone_on_transport(self, to_transport, revision_id=None,
1199
stacked_on=None, create_prefix=False, use_existing_dir=False):
1200
"""Create a clone of this branch and its bzrdir.
1202
:param to_transport: The transport to clone onto.
1203
:param revision_id: The revision id to use as tip in the new branch.
1204
If None the tip is obtained from this branch.
1205
:param stacked_on: An optional URL to stack the clone on.
1206
:param create_prefix: Create any missing directories leading up to
1208
:param use_existing_dir: Use an existing directory if one exists.
1210
# XXX: Fix the bzrdir API to allow getting the branch back from the
1211
# clone call. Or something. 20090224 RBC/spiv.
1212
if revision_id is None:
1213
revision_id = self.last_revision()
1215
dir_to = self.bzrdir.clone_on_transport(to_transport,
1216
revision_id=revision_id, stacked_on=stacked_on,
1217
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1218
except errors.FileExists:
1219
if not use_existing_dir:
1221
except errors.NoSuchFile:
1222
if not create_prefix:
1224
return dir_to.open_branch()
1226
def create_checkout(self, to_location, revision_id=None,
1227
lightweight=False, accelerator_tree=None,
1229
"""Create a checkout of a branch.
1231
:param to_location: The url to produce the checkout at
1232
:param revision_id: The revision to check out
1233
:param lightweight: If True, produce a lightweight checkout, otherwise,
1234
produce a bound branch (heavyweight checkout)
1235
:param accelerator_tree: A tree which can be used for retrieving file
1236
contents more quickly than the revision tree, i.e. a workingtree.
1237
The revision tree will be used for cases where accelerator_tree's
1238
content is different.
1239
:param hardlink: If true, hard-link files from accelerator_tree,
1241
:return: The tree of the created checkout
1243
t = transport.get_transport(to_location)
1246
format = self._get_checkout_format()
1247
checkout = format.initialize_on_transport(t)
1248
from_branch = BranchReferenceFormat().initialize(checkout, self)
1250
format = self._get_checkout_format()
1251
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1252
to_location, force_new_tree=False, format=format)
1253
checkout = checkout_branch.bzrdir
1254
checkout_branch.bind(self)
1255
# pull up to the specified revision_id to set the initial
1256
# branch tip correctly, and seed it with history.
1257
checkout_branch.pull(self, stop_revision=revision_id)
1259
tree = checkout.create_workingtree(revision_id,
1260
from_branch=from_branch,
1261
accelerator_tree=accelerator_tree,
1263
basis_tree = tree.basis_tree()
1264
basis_tree.lock_read()
1266
for path, file_id in basis_tree.iter_references():
1267
reference_parent = self.reference_parent(file_id, path)
1268
reference_parent.create_checkout(tree.abspath(path),
1269
basis_tree.get_reference_revision(file_id, path),
1276
def reconcile(self, thorough=True):
1277
"""Make sure the data stored in this branch is consistent."""
1278
from bzrlib.reconcile import BranchReconciler
1279
reconciler = BranchReconciler(self, thorough=thorough)
1280
reconciler.reconcile()
1283
def reference_parent(self, file_id, path, possible_transports=None):
1284
"""Return the parent branch for a tree-reference file_id
1285
:param file_id: The file_id of the tree reference
1286
:param path: The path of the file_id in the tree
1287
:return: A branch associated with the file_id
1289
# FIXME should provide multiple branches, based on config
1290
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1291
possible_transports=possible_transports)
1293
def supports_tags(self):
1294
return self._format.supports_tags()
1296
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1298
"""Ensure that revision_b is a descendant of revision_a.
1300
This is a helper function for update_revisions.
1302
:raises: DivergedBranches if revision_b has diverged from revision_a.
1303
:returns: True if revision_b is a descendant of revision_a.
1305
relation = self._revision_relations(revision_a, revision_b, graph)
1306
if relation == 'b_descends_from_a':
1308
elif relation == 'diverged':
1309
raise errors.DivergedBranches(self, other_branch)
1310
elif relation == 'a_descends_from_b':
1313
raise AssertionError("invalid relation: %r" % (relation,))
1315
def _revision_relations(self, revision_a, revision_b, graph):
1316
"""Determine the relationship between two revisions.
1318
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1320
heads = graph.heads([revision_a, revision_b])
1321
if heads == set([revision_b]):
1322
return 'b_descends_from_a'
1323
elif heads == set([revision_a, revision_b]):
1324
# These branches have diverged
1326
elif heads == set([revision_a]):
1327
return 'a_descends_from_b'
1329
raise AssertionError("invalid heads: %r" % (heads,))
1332
class BranchFormat(object):
1333
"""An encapsulation of the initialization and open routines for a format.
1335
Formats provide three things:
1336
* An initialization routine,
1340
Formats are placed in an dict by their format string for reference
1341
during branch opening. Its not required that these be instances, they
1342
can be classes themselves with class methods - it simply depends on
1343
whether state is needed for a given format or not.
1345
Once a format is deprecated, just deprecate the initialize and open
1346
methods on the format class. Do not deprecate the object, as the
1347
object will be created every time regardless.
1350
_default_format = None
1351
"""The default format used for new branches."""
1354
"""The known formats."""
1356
def __eq__(self, other):
1357
return self.__class__ is other.__class__
1359
def __ne__(self, other):
1360
return not (self == other)
1363
def find_format(klass, a_bzrdir):
1364
"""Return the format for the branch object in a_bzrdir."""
1366
transport = a_bzrdir.get_branch_transport(None)
1367
format_string = transport.get("format").read()
1368
return klass._formats[format_string]
1369
except errors.NoSuchFile:
1370
raise errors.NotBranchError(path=transport.base)
1372
raise errors.UnknownFormatError(format=format_string, kind='branch')
1375
def get_default_format(klass):
1376
"""Return the current default format."""
1377
return klass._default_format
1379
def get_reference(self, a_bzrdir):
1380
"""Get the target reference of the branch in a_bzrdir.
1382
format probing must have been completed before calling
1383
this method - it is assumed that the format of the branch
1384
in a_bzrdir is correct.
1386
:param a_bzrdir: The bzrdir to get the branch data from.
1387
:return: None if the branch is not a reference branch.
1392
def set_reference(self, a_bzrdir, to_branch):
1393
"""Set the target reference of the branch in a_bzrdir.
1395
format probing must have been completed before calling
1396
this method - it is assumed that the format of the branch
1397
in a_bzrdir is correct.
1399
:param a_bzrdir: The bzrdir to set the branch reference for.
1400
:param to_branch: branch that the checkout is to reference
1402
raise NotImplementedError(self.set_reference)
1404
def get_format_string(self):
1405
"""Return the ASCII format string that identifies this format."""
1406
raise NotImplementedError(self.get_format_string)
1408
def get_format_description(self):
1409
"""Return the short format description for this format."""
1410
raise NotImplementedError(self.get_format_description)
1412
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1414
"""Initialize a branch in a bzrdir, with specified files
1416
:param a_bzrdir: The bzrdir to initialize the branch in
1417
:param utf8_files: The files to create as a list of
1418
(filename, content) tuples
1419
:param set_format: If True, set the format with
1420
self.get_format_string. (BzrBranch4 has its format set
1422
:return: a branch in this format
1424
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1425
branch_transport = a_bzrdir.get_branch_transport(self)
1427
'metadir': ('lock', lockdir.LockDir),
1428
'branch4': ('branch-lock', lockable_files.TransportLock),
1430
lock_name, lock_class = lock_map[lock_type]
1431
control_files = lockable_files.LockableFiles(branch_transport,
1432
lock_name, lock_class)
1433
control_files.create_lock()
1435
control_files.lock_write()
1436
except errors.LockContention:
1437
if lock_type != 'branch4':
1443
utf8_files += [('format', self.get_format_string())]
1445
for (filename, content) in utf8_files:
1446
branch_transport.put_bytes(
1448
mode=a_bzrdir._get_file_mode())
1451
control_files.unlock()
1452
return self.open(a_bzrdir, _found=True)
1454
def initialize(self, a_bzrdir):
1455
"""Create a branch of this format in a_bzrdir."""
1456
raise NotImplementedError(self.initialize)
1458
def is_supported(self):
1459
"""Is this format supported?
1461
Supported formats can be initialized and opened.
1462
Unsupported formats may not support initialization or committing or
1463
some other features depending on the reason for not being supported.
1467
def make_tags(self, branch):
1468
"""Create a tags object for branch.
1470
This method is on BranchFormat, because BranchFormats are reflected
1471
over the wire via network_name(), whereas full Branch instances require
1472
multiple VFS method calls to operate at all.
1474
The default implementation returns a disabled-tags instance.
1476
Note that it is normal for branch to be a RemoteBranch when using tags
1479
return DisabledTags(branch)
1481
def network_name(self):
1482
"""A simple byte string uniquely identifying this format for RPC calls.
1484
MetaDir branch formats use their disk format string to identify the
1485
repository over the wire. All in one formats such as bzr < 0.8, and
1486
foreign formats like svn/git and hg should use some marker which is
1487
unique and immutable.
1489
raise NotImplementedError(self.network_name)
1491
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1492
"""Return the branch object for a_bzrdir
1494
:param a_bzrdir: A BzrDir that contains a branch.
1495
:param _found: a private parameter, do not use it. It is used to
1496
indicate if format probing has already be done.
1497
:param ignore_fallbacks: when set, no fallback branches will be opened
1498
(if there are any). Default is to open fallbacks.
1500
raise NotImplementedError(self.open)
1503
def register_format(klass, format):
1504
"""Register a metadir format."""
1505
klass._formats[format.get_format_string()] = format
1506
# Metadir formats have a network name of their format string, and get
1507
# registered as class factories.
1508
network_format_registry.register(format.get_format_string(), format.__class__)
1511
def set_default_format(klass, format):
1512
klass._default_format = format
1514
def supports_stacking(self):
1515
"""True if this format records a stacked-on branch."""
1519
def unregister_format(klass, format):
1520
del klass._formats[format.get_format_string()]
1523
return self.get_format_description().rstrip()
1525
def supports_tags(self):
1526
"""True if this format supports tags stored in the branch"""
1527
return False # by default
1530
class BranchHooks(Hooks):
1531
"""A dictionary mapping hook name to a list of callables for branch hooks.
1533
e.g. ['set_rh'] Is the list of items to be called when the
1534
set_revision_history function is invoked.
1538
"""Create the default hooks.
1540
These are all empty initially, because by default nothing should get
1543
Hooks.__init__(self)
1544
self.create_hook(HookPoint('set_rh',
1545
"Invoked whenever the revision history has been set via "
1546
"set_revision_history. The api signature is (branch, "
1547
"revision_history), and the branch will be write-locked. "
1548
"The set_rh hook can be expensive for bzr to trigger, a better "
1549
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1550
self.create_hook(HookPoint('open',
1551
"Called with the Branch object that has been opened after a "
1552
"branch is opened.", (1, 8), None))
1553
self.create_hook(HookPoint('post_push',
1554
"Called after a push operation completes. post_push is called "
1555
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1556
"bzr client.", (0, 15), None))
1557
self.create_hook(HookPoint('post_pull',
1558
"Called after a pull operation completes. post_pull is called "
1559
"with a bzrlib.branch.PullResult object and only runs in the "
1560
"bzr client.", (0, 15), None))
1561
self.create_hook(HookPoint('pre_commit',
1562
"Called after a commit is calculated but before it is is "
1563
"completed. pre_commit is called with (local, master, old_revno, "
1564
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1565
"). old_revid is NULL_REVISION for the first commit to a branch, "
1566
"tree_delta is a TreeDelta object describing changes from the "
1567
"basis revision. hooks MUST NOT modify this delta. "
1568
" future_tree is an in-memory tree obtained from "
1569
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1570
"tree.", (0,91), None))
1571
self.create_hook(HookPoint('post_commit',
1572
"Called in the bzr client after a commit has completed. "
1573
"post_commit is called with (local, master, old_revno, old_revid, "
1574
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1575
"commit to a branch.", (0, 15), None))
1576
self.create_hook(HookPoint('post_uncommit',
1577
"Called in the bzr client after an uncommit completes. "
1578
"post_uncommit is called with (local, master, old_revno, "
1579
"old_revid, new_revno, new_revid) where local is the local branch "
1580
"or None, master is the target branch, and an empty branch "
1581
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1582
self.create_hook(HookPoint('pre_change_branch_tip',
1583
"Called in bzr client and server before a change to the tip of a "
1584
"branch is made. pre_change_branch_tip is called with a "
1585
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1586
"commit, uncommit will all trigger this hook.", (1, 6), None))
1587
self.create_hook(HookPoint('post_change_branch_tip',
1588
"Called in bzr client and server after a change to the tip of a "
1589
"branch is made. post_change_branch_tip is called with a "
1590
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1591
"commit, uncommit will all trigger this hook.", (1, 4), None))
1592
self.create_hook(HookPoint('transform_fallback_location',
1593
"Called when a stacked branch is activating its fallback "
1594
"locations. transform_fallback_location is called with (branch, "
1595
"url), and should return a new url. Returning the same url "
1596
"allows it to be used as-is, returning a different one can be "
1597
"used to cause the branch to stack on a closer copy of that "
1598
"fallback_location. Note that the branch cannot have history "
1599
"accessing methods called on it during this hook because the "
1600
"fallback locations have not been activated. When there are "
1601
"multiple hooks installed for transform_fallback_location, "
1602
"all are called with the url returned from the previous hook."
1603
"The order is however undefined.", (1, 9), None))
1606
# install the default hooks into the Branch class.
1607
Branch.hooks = BranchHooks()
1610
class ChangeBranchTipParams(object):
1611
"""Object holding parameters passed to *_change_branch_tip hooks.
1613
There are 5 fields that hooks may wish to access:
1615
:ivar branch: the branch being changed
1616
:ivar old_revno: revision number before the change
1617
:ivar new_revno: revision number after the change
1618
:ivar old_revid: revision id before the change
1619
:ivar new_revid: revision id after the change
1621
The revid fields are strings. The revno fields are integers.
1624
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1625
"""Create a group of ChangeBranchTip parameters.
1627
:param branch: The branch being changed.
1628
:param old_revno: Revision number before the change.
1629
:param new_revno: Revision number after the change.
1630
:param old_revid: Tip revision id before the change.
1631
:param new_revid: Tip revision id after the change.
1633
self.branch = branch
1634
self.old_revno = old_revno
1635
self.new_revno = new_revno
1636
self.old_revid = old_revid
1637
self.new_revid = new_revid
1639
def __eq__(self, other):
1640
return self.__dict__ == other.__dict__
1643
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1644
self.__class__.__name__, self.branch,
1645
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1648
class BzrBranchFormat4(BranchFormat):
1649
"""Bzr branch format 4.
1652
- a revision-history file.
1653
- a branch-lock lock file [ to be shared with the bzrdir ]
1656
def get_format_description(self):
1657
"""See BranchFormat.get_format_description()."""
1658
return "Branch format 4"
1660
def initialize(self, a_bzrdir):
1661
"""Create a branch of this format in a_bzrdir."""
1662
utf8_files = [('revision-history', ''),
1663
('branch-name', ''),
1665
return self._initialize_helper(a_bzrdir, utf8_files,
1666
lock_type='branch4', set_format=False)
1669
super(BzrBranchFormat4, self).__init__()
1670
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1672
def network_name(self):
1673
"""The network name for this format is the control dirs disk label."""
1674
return self._matchingbzrdir.get_format_string()
1676
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1677
"""See BranchFormat.open()."""
1679
# we are being called directly and must probe.
1680
raise NotImplementedError
1681
return BzrBranch(_format=self,
1682
_control_files=a_bzrdir._control_files,
1684
_repository=a_bzrdir.open_repository())
1687
return "Bazaar-NG branch format 4"
1690
class BranchFormatMetadir(BranchFormat):
1691
"""Common logic for meta-dir based branch formats."""
1693
def _branch_class(self):
1694
"""What class to instantiate on open calls."""
1695
raise NotImplementedError(self._branch_class)
1697
def network_name(self):
1698
"""A simple byte string uniquely identifying this format for RPC calls.
1700
Metadir branch formats use their format string.
1702
return self.get_format_string()
1704
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1705
"""See BranchFormat.open()."""
1707
format = BranchFormat.find_format(a_bzrdir)
1708
if format.__class__ != self.__class__:
1709
raise AssertionError("wrong format %r found for %r" %
1712
transport = a_bzrdir.get_branch_transport(None)
1713
control_files = lockable_files.LockableFiles(transport, 'lock',
1715
return self._branch_class()(_format=self,
1716
_control_files=control_files,
1718
_repository=a_bzrdir.find_repository(),
1719
ignore_fallbacks=ignore_fallbacks)
1720
except errors.NoSuchFile:
1721
raise errors.NotBranchError(path=transport.base)
1724
super(BranchFormatMetadir, self).__init__()
1725
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1726
self._matchingbzrdir.set_branch_format(self)
1728
def supports_tags(self):
1732
class BzrBranchFormat5(BranchFormatMetadir):
1733
"""Bzr branch format 5.
1736
- a revision-history file.
1738
- a lock dir guarding the branch itself
1739
- all of this stored in a branch/ subdirectory
1740
- works with shared repositories.
1742
This format is new in bzr 0.8.
1745
def _branch_class(self):
1748
def get_format_string(self):
1749
"""See BranchFormat.get_format_string()."""
1750
return "Bazaar-NG branch format 5\n"
1752
def get_format_description(self):
1753
"""See BranchFormat.get_format_description()."""
1754
return "Branch format 5"
1756
def initialize(self, a_bzrdir):
1757
"""Create a branch of this format in a_bzrdir."""
1758
utf8_files = [('revision-history', ''),
1759
('branch-name', ''),
1761
return self._initialize_helper(a_bzrdir, utf8_files)
1763
def supports_tags(self):
1767
class BzrBranchFormat6(BranchFormatMetadir):
1768
"""Branch format with last-revision and tags.
1770
Unlike previous formats, this has no explicit revision history. Instead,
1771
this just stores the last-revision, and the left-hand history leading
1772
up to there is the history.
1774
This format was introduced in bzr 0.15
1775
and became the default in 0.91.
1778
def _branch_class(self):
1781
def get_format_string(self):
1782
"""See BranchFormat.get_format_string()."""
1783
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1785
def get_format_description(self):
1786
"""See BranchFormat.get_format_description()."""
1787
return "Branch format 6"
1789
def initialize(self, a_bzrdir):
1790
"""Create a branch of this format in a_bzrdir."""
1791
utf8_files = [('last-revision', '0 null:\n'),
1792
('branch.conf', ''),
1795
return self._initialize_helper(a_bzrdir, utf8_files)
1797
def make_tags(self, branch):
1798
"""See bzrlib.branch.BranchFormat.make_tags()."""
1799
return BasicTags(branch)
1803
class BzrBranchFormat8(BranchFormatMetadir):
1804
"""Metadir format supporting storing locations of subtree branches."""
1806
def _branch_class(self):
1809
def get_format_string(self):
1810
"""See BranchFormat.get_format_string()."""
1811
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1813
def get_format_description(self):
1814
"""See BranchFormat.get_format_description()."""
1815
return "Branch format 8"
1817
def initialize(self, a_bzrdir):
1818
"""Create a branch of this format in a_bzrdir."""
1819
utf8_files = [('last-revision', '0 null:\n'),
1820
('branch.conf', ''),
1824
return self._initialize_helper(a_bzrdir, utf8_files)
1827
super(BzrBranchFormat8, self).__init__()
1828
self._matchingbzrdir.repository_format = \
1829
RepositoryFormatKnitPack5RichRoot()
1831
def make_tags(self, branch):
1832
"""See bzrlib.branch.BranchFormat.make_tags()."""
1833
return BasicTags(branch)
1835
def supports_stacking(self):
1838
supports_reference_locations = True
1841
class BzrBranchFormat7(BzrBranchFormat8):
1842
"""Branch format with last-revision, tags, and a stacked location pointer.
1844
The stacked location pointer is passed down to the repository and requires
1845
a repository format with supports_external_lookups = True.
1847
This format was introduced in bzr 1.6.
1850
def initialize(self, a_bzrdir):
1851
"""Create a branch of this format in a_bzrdir."""
1852
utf8_files = [('last-revision', '0 null:\n'),
1853
('branch.conf', ''),
1856
return self._initialize_helper(a_bzrdir, utf8_files)
1858
def _branch_class(self):
1861
def get_format_string(self):
1862
"""See BranchFormat.get_format_string()."""
1863
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1865
def get_format_description(self):
1866
"""See BranchFormat.get_format_description()."""
1867
return "Branch format 7"
1869
supports_reference_locations = False
1872
class BranchReferenceFormat(BranchFormat):
1873
"""Bzr branch reference format.
1875
Branch references are used in implementing checkouts, they
1876
act as an alias to the real branch which is at some other url.
1883
def get_format_string(self):
1884
"""See BranchFormat.get_format_string()."""
1885
return "Bazaar-NG Branch Reference Format 1\n"
1887
def get_format_description(self):
1888
"""See BranchFormat.get_format_description()."""
1889
return "Checkout reference format 1"
1891
def get_reference(self, a_bzrdir):
1892
"""See BranchFormat.get_reference()."""
1893
transport = a_bzrdir.get_branch_transport(None)
1894
return transport.get('location').read()
1896
def set_reference(self, a_bzrdir, to_branch):
1897
"""See BranchFormat.set_reference()."""
1898
transport = a_bzrdir.get_branch_transport(None)
1899
location = transport.put_bytes('location', to_branch.base)
1901
def initialize(self, a_bzrdir, target_branch=None):
1902
"""Create a branch of this format in a_bzrdir."""
1903
if target_branch is None:
1904
# this format does not implement branch itself, thus the implicit
1905
# creation contract must see it as uninitializable
1906
raise errors.UninitializableFormat(self)
1907
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1908
branch_transport = a_bzrdir.get_branch_transport(self)
1909
branch_transport.put_bytes('location',
1910
target_branch.bzrdir.root_transport.base)
1911
branch_transport.put_bytes('format', self.get_format_string())
1913
a_bzrdir, _found=True,
1914
possible_transports=[target_branch.bzrdir.root_transport])
1917
super(BranchReferenceFormat, self).__init__()
1918
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1919
self._matchingbzrdir.set_branch_format(self)
1921
def _make_reference_clone_function(format, a_branch):
1922
"""Create a clone() routine for a branch dynamically."""
1923
def clone(to_bzrdir, revision_id=None,
1924
repository_policy=None):
1925
"""See Branch.clone()."""
1926
return format.initialize(to_bzrdir, a_branch)
1927
# cannot obey revision_id limits when cloning a reference ...
1928
# FIXME RBC 20060210 either nuke revision_id for clone, or
1929
# emit some sort of warning/error to the caller ?!
1932
def open(self, a_bzrdir, _found=False, location=None,
1933
possible_transports=None, ignore_fallbacks=False):
1934
"""Return the branch that the branch reference in a_bzrdir points at.
1936
:param a_bzrdir: A BzrDir that contains a branch.
1937
:param _found: a private parameter, do not use it. It is used to
1938
indicate if format probing has already be done.
1939
:param ignore_fallbacks: when set, no fallback branches will be opened
1940
(if there are any). Default is to open fallbacks.
1941
:param location: The location of the referenced branch. If
1942
unspecified, this will be determined from the branch reference in
1944
:param possible_transports: An optional reusable transports list.
1947
format = BranchFormat.find_format(a_bzrdir)
1948
if format.__class__ != self.__class__:
1949
raise AssertionError("wrong format %r found for %r" %
1951
if location is None:
1952
location = self.get_reference(a_bzrdir)
1953
real_bzrdir = bzrdir.BzrDir.open(
1954
location, possible_transports=possible_transports)
1955
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1956
# this changes the behaviour of result.clone to create a new reference
1957
# rather than a copy of the content of the branch.
1958
# I did not use a proxy object because that needs much more extensive
1959
# testing, and we are only changing one behaviour at the moment.
1960
# If we decide to alter more behaviours - i.e. the implicit nickname
1961
# then this should be refactored to introduce a tested proxy branch
1962
# and a subclass of that for use in overriding clone() and ....
1964
result.clone = self._make_reference_clone_function(result)
1968
network_format_registry = registry.FormatRegistry()
1969
"""Registry of formats indexed by their network name.
1971
The network name for a branch format is an identifier that can be used when
1972
referring to formats with smart server operations. See
1973
BranchFormat.network_name() for more detail.
1977
# formats which have no format string are not discoverable
1978
# and not independently creatable, so are not registered.
1979
__format5 = BzrBranchFormat5()
1980
__format6 = BzrBranchFormat6()
1981
__format7 = BzrBranchFormat7()
1982
__format8 = BzrBranchFormat8()
1983
BranchFormat.register_format(__format5)
1984
BranchFormat.register_format(BranchReferenceFormat())
1985
BranchFormat.register_format(__format6)
1986
BranchFormat.register_format(__format7)
1987
BranchFormat.register_format(__format8)
1988
BranchFormat.set_default_format(__format6)
1989
_legacy_formats = [BzrBranchFormat4(),
1991
network_format_registry.register(
1992
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1995
class BzrBranch(Branch):
1996
"""A branch stored in the actual filesystem.
1998
Note that it's "local" in the context of the filesystem; it doesn't
1999
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2000
it's writable, and can be accessed via the normal filesystem API.
2002
:ivar _transport: Transport for file operations on this branch's
2003
control files, typically pointing to the .bzr/branch directory.
2004
:ivar repository: Repository for this branch.
2005
:ivar base: The url of the base directory for this branch; the one
2006
containing the .bzr directory.
2009
def __init__(self, _format=None,
2010
_control_files=None, a_bzrdir=None, _repository=None,
2011
ignore_fallbacks=False):
2012
"""Create new branch object at a particular location."""
2013
if a_bzrdir is None:
2014
raise ValueError('a_bzrdir must be supplied')
2016
self.bzrdir = a_bzrdir
2017
self._base = self.bzrdir.transport.clone('..').base
2018
# XXX: We should be able to just do
2019
# self.base = self.bzrdir.root_transport.base
2020
# but this does not quite work yet -- mbp 20080522
2021
self._format = _format
2022
if _control_files is None:
2023
raise ValueError('BzrBranch _control_files is None')
2024
self.control_files = _control_files
2025
self._transport = _control_files._transport
2026
self.repository = _repository
2027
Branch.__init__(self)
2030
return '%s(%r)' % (self.__class__.__name__, self.base)
2034
def _get_base(self):
2035
"""Returns the directory containing the control directory."""
2038
base = property(_get_base, doc="The URL for the root of this branch.")
2040
def _get_config(self):
2041
return TransportConfig(self._transport, 'branch.conf')
2043
def is_locked(self):
2044
return self.control_files.is_locked()
2046
def lock_write(self, token=None):
2047
# All-in-one needs to always unlock/lock.
2048
repo_control = getattr(self.repository, 'control_files', None)
2049
if self.control_files == repo_control or not self.is_locked():
2050
self.repository.lock_write()
2055
return self.control_files.lock_write(token=token)
2058
self.repository.unlock()
2061
def lock_read(self):
2062
# All-in-one needs to always unlock/lock.
2063
repo_control = getattr(self.repository, 'control_files', None)
2064
if self.control_files == repo_control or not self.is_locked():
2065
self.repository.lock_read()
2070
self.control_files.lock_read()
2073
self.repository.unlock()
2078
self.control_files.unlock()
2080
# All-in-one needs to always unlock/lock.
2081
repo_control = getattr(self.repository, 'control_files', None)
2082
if (self.control_files == repo_control or
2083
not self.control_files.is_locked()):
2084
self.repository.unlock()
2085
if not self.control_files.is_locked():
2086
# we just released the lock
2087
self._clear_cached_state()
2089
def peek_lock_mode(self):
2090
if self.control_files._lock_count == 0:
2093
return self.control_files._lock_mode
2095
def get_physical_lock_status(self):
2096
return self.control_files.get_physical_lock_status()
2099
def print_file(self, file, revision_id):
2100
"""See Branch.print_file."""
2101
return self.repository.print_file(file, revision_id)
2103
def _write_revision_history(self, history):
2104
"""Factored out of set_revision_history.
2106
This performs the actual writing to disk.
2107
It is intended to be called by BzrBranch5.set_revision_history."""
2108
self._transport.put_bytes(
2109
'revision-history', '\n'.join(history),
2110
mode=self.bzrdir._get_file_mode())
2113
def set_revision_history(self, rev_history):
2114
"""See Branch.set_revision_history."""
2115
if 'evil' in debug.debug_flags:
2116
mutter_callsite(3, "set_revision_history scales with history.")
2117
check_not_reserved_id = _mod_revision.check_not_reserved_id
2118
for rev_id in rev_history:
2119
check_not_reserved_id(rev_id)
2120
if Branch.hooks['post_change_branch_tip']:
2121
# Don't calculate the last_revision_info() if there are no hooks
2123
old_revno, old_revid = self.last_revision_info()
2124
if len(rev_history) == 0:
2125
revid = _mod_revision.NULL_REVISION
2127
revid = rev_history[-1]
2128
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2129
self._write_revision_history(rev_history)
2130
self._clear_cached_state()
2131
self._cache_revision_history(rev_history)
2132
for hook in Branch.hooks['set_rh']:
2133
hook(self, rev_history)
2134
if Branch.hooks['post_change_branch_tip']:
2135
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2137
def _synchronize_history(self, destination, revision_id):
2138
"""Synchronize last revision and revision history between branches.
2140
This version is most efficient when the destination is also a
2141
BzrBranch5, but works for BzrBranch6 as long as the revision
2142
history is the true lefthand parent history, and all of the revisions
2143
are in the destination's repository. If not, set_revision_history
2146
:param destination: The branch to copy the history into
2147
:param revision_id: The revision-id to truncate history at. May
2148
be None to copy complete history.
2150
if not isinstance(destination._format, BzrBranchFormat5):
2151
super(BzrBranch, self)._synchronize_history(
2152
destination, revision_id)
2154
if revision_id == _mod_revision.NULL_REVISION:
2157
new_history = self.revision_history()
2158
if revision_id is not None and new_history != []:
2160
new_history = new_history[:new_history.index(revision_id) + 1]
2162
rev = self.repository.get_revision(revision_id)
2163
new_history = rev.get_history(self.repository)[1:]
2164
destination.set_revision_history(new_history)
2167
def set_last_revision_info(self, revno, revision_id):
2168
"""Set the last revision of this branch.
2170
The caller is responsible for checking that the revno is correct
2171
for this revision id.
2173
It may be possible to set the branch last revision to an id not
2174
present in the repository. However, branches can also be
2175
configured to check constraints on history, in which case this may not
2178
revision_id = _mod_revision.ensure_null(revision_id)
2179
# this old format stores the full history, but this api doesn't
2180
# provide it, so we must generate, and might as well check it's
2182
history = self._lefthand_history(revision_id)
2183
if len(history) != revno:
2184
raise AssertionError('%d != %d' % (len(history), revno))
2185
self.set_revision_history(history)
2187
def _gen_revision_history(self):
2188
history = self._transport.get_bytes('revision-history').split('\n')
2189
if history[-1:] == ['']:
2190
# There shouldn't be a trailing newline, but just in case.
2195
def generate_revision_history(self, revision_id, last_rev=None,
2197
"""Create a new revision history that will finish with revision_id.
2199
:param revision_id: the new tip to use.
2200
:param last_rev: The previous last_revision. If not None, then this
2201
must be a ancestory of revision_id, or DivergedBranches is raised.
2202
:param other_branch: The other branch that DivergedBranches should
2203
raise with respect to.
2205
self.set_revision_history(self._lefthand_history(revision_id,
2206
last_rev, other_branch))
2208
def basis_tree(self):
2209
"""See Branch.basis_tree."""
2210
return self.repository.revision_tree(self.last_revision())
2212
def _get_parent_location(self):
2213
_locs = ['parent', 'pull', 'x-pull']
2216
return self._transport.get_bytes(l).strip('\n')
2217
except errors.NoSuchFile:
2221
def _basic_push(self, target, overwrite, stop_revision):
2222
"""Basic implementation of push without bound branches or hooks.
2224
Must be called with source read locked and target write locked.
2226
result = BranchPushResult()
2227
result.source_branch = self
2228
result.target_branch = target
2229
result.old_revno, result.old_revid = target.last_revision_info()
2230
self.update_references(target)
2231
if result.old_revid != self.last_revision():
2232
# We assume that during 'push' this repository is closer than
2234
graph = self.repository.get_graph(target.repository)
2235
target.update_revisions(self, stop_revision,
2236
overwrite=overwrite, graph=graph)
2237
if self._push_should_merge_tags():
2238
result.tag_conflicts = self.tags.merge_to(target.tags,
2240
result.new_revno, result.new_revid = target.last_revision_info()
2243
def get_stacked_on_url(self):
2244
raise errors.UnstackableBranchFormat(self._format, self.base)
2246
def set_push_location(self, location):
2247
"""See Branch.set_push_location."""
2248
self.get_config().set_user_option(
2249
'push_location', location,
2250
store=_mod_config.STORE_LOCATION_NORECURSE)
2252
def _set_parent_location(self, url):
2254
self._transport.delete('parent')
2256
self._transport.put_bytes('parent', url + '\n',
2257
mode=self.bzrdir._get_file_mode())
2260
class BzrBranch5(BzrBranch):
2261
"""A format 5 branch. This supports new features over plain branches.
2263
It has support for a master_branch which is the data for bound branches.
2266
def get_bound_location(self):
2268
return self._transport.get_bytes('bound')[:-1]
2269
except errors.NoSuchFile:
2273
def get_master_branch(self, possible_transports=None):
2274
"""Return the branch we are bound to.
2276
:return: Either a Branch, or None
2278
This could memoise the branch, but if thats done
2279
it must be revalidated on each new lock.
2280
So for now we just don't memoise it.
2281
# RBC 20060304 review this decision.
2283
bound_loc = self.get_bound_location()
2287
return Branch.open(bound_loc,
2288
possible_transports=possible_transports)
2289
except (errors.NotBranchError, errors.ConnectionError), e:
2290
raise errors.BoundBranchConnectionFailure(
2294
def set_bound_location(self, location):
2295
"""Set the target where this branch is bound to.
2297
:param location: URL to the target branch
2300
self._transport.put_bytes('bound', location+'\n',
2301
mode=self.bzrdir._get_file_mode())
2304
self._transport.delete('bound')
2305
except errors.NoSuchFile:
2310
def bind(self, other):
2311
"""Bind this branch to the branch other.
2313
This does not push or pull data between the branches, though it does
2314
check for divergence to raise an error when the branches are not
2315
either the same, or one a prefix of the other. That behaviour may not
2316
be useful, so that check may be removed in future.
2318
:param other: The branch to bind to
2321
# TODO: jam 20051230 Consider checking if the target is bound
2322
# It is debatable whether you should be able to bind to
2323
# a branch which is itself bound.
2324
# Committing is obviously forbidden,
2325
# but binding itself may not be.
2326
# Since we *have* to check at commit time, we don't
2327
# *need* to check here
2329
# we want to raise diverged if:
2330
# last_rev is not in the other_last_rev history, AND
2331
# other_last_rev is not in our history, and do it without pulling
2333
self.set_bound_location(other.base)
2337
"""If bound, unbind"""
2338
return self.set_bound_location(None)
2341
def update(self, possible_transports=None):
2342
"""Synchronise this branch with the master branch if any.
2344
:return: None or the last_revision that was pivoted out during the
2347
master = self.get_master_branch(possible_transports)
2348
if master is not None:
2349
old_tip = _mod_revision.ensure_null(self.last_revision())
2350
self.pull(master, overwrite=True)
2351
if self.repository.get_graph().is_ancestor(old_tip,
2352
_mod_revision.ensure_null(self.last_revision())):
2358
class BzrBranch8(BzrBranch5):
2359
"""A branch that stores tree-reference locations."""
2361
def _open_hook(self):
2362
if self._ignore_fallbacks:
2365
url = self.get_stacked_on_url()
2366
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2367
errors.UnstackableBranchFormat):
2370
for hook in Branch.hooks['transform_fallback_location']:
2371
url = hook(self, url)
2373
hook_name = Branch.hooks.get_hook_name(hook)
2374
raise AssertionError(
2375
"'transform_fallback_location' hook %s returned "
2376
"None, not a URL." % hook_name)
2377
self._activate_fallback_location(url, None)
2379
def __init__(self, *args, **kwargs):
2380
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2381
super(BzrBranch8, self).__init__(*args, **kwargs)
2382
self._last_revision_info_cache = None
2383
self._partial_revision_history_cache = []
2384
self._reference_info = None
2386
def _clear_cached_state(self):
2387
super(BzrBranch8, self)._clear_cached_state()
2388
self._last_revision_info_cache = None
2389
self._partial_revision_history_cache = []
2390
self._reference_info = None
2392
def _last_revision_info(self):
2393
revision_string = self._transport.get_bytes('last-revision')
2394
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2395
revision_id = cache_utf8.get_cached_utf8(revision_id)
2397
return revno, revision_id
2399
def _write_last_revision_info(self, revno, revision_id):
2400
"""Simply write out the revision id, with no checks.
2402
Use set_last_revision_info to perform this safely.
2404
Does not update the revision_history cache.
2405
Intended to be called by set_last_revision_info and
2406
_write_revision_history.
2408
revision_id = _mod_revision.ensure_null(revision_id)
2409
out_string = '%d %s\n' % (revno, revision_id)
2410
self._transport.put_bytes('last-revision', out_string,
2411
mode=self.bzrdir._get_file_mode())
2414
def set_last_revision_info(self, revno, revision_id):
2415
revision_id = _mod_revision.ensure_null(revision_id)
2416
old_revno, old_revid = self.last_revision_info()
2417
if self._get_append_revisions_only():
2418
self._check_history_violation(revision_id)
2419
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2420
self._write_last_revision_info(revno, revision_id)
2421
self._clear_cached_state()
2422
self._last_revision_info_cache = revno, revision_id
2423
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2425
def _synchronize_history(self, destination, revision_id):
2426
"""Synchronize last revision and revision history between branches.
2428
:see: Branch._synchronize_history
2430
# XXX: The base Branch has a fast implementation of this method based
2431
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2432
# that uses set_revision_history. This class inherits from BzrBranch5,
2433
# but wants the fast implementation, so it calls
2434
# Branch._synchronize_history directly.
2435
Branch._synchronize_history(self, destination, revision_id)
2437
def _check_history_violation(self, revision_id):
2438
last_revision = _mod_revision.ensure_null(self.last_revision())
2439
if _mod_revision.is_null(last_revision):
2441
if last_revision not in self._lefthand_history(revision_id):
2442
raise errors.AppendRevisionsOnlyViolation(self.base)
2444
def _gen_revision_history(self):
2445
"""Generate the revision history from last revision
2447
last_revno, last_revision = self.last_revision_info()
2448
self._extend_partial_history(stop_index=last_revno-1)
2449
return list(reversed(self._partial_revision_history_cache))
2451
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2452
"""Extend the partial history to include a given index
2454
If a stop_index is supplied, stop when that index has been reached.
2455
If a stop_revision is supplied, stop when that revision is
2456
encountered. Otherwise, stop when the beginning of history is
2459
:param stop_index: The index which should be present. When it is
2460
present, history extension will stop.
2461
:param revision_id: The revision id which should be present. When
2462
it is encountered, history extension will stop.
2464
repo = self.repository
2465
if len(self._partial_revision_history_cache) == 0:
2466
iterator = repo.iter_reverse_revision_history(self.last_revision())
2468
start_revision = self._partial_revision_history_cache[-1]
2469
iterator = repo.iter_reverse_revision_history(start_revision)
2470
#skip the last revision in the list
2471
next_revision = iterator.next()
2472
for revision_id in iterator:
2473
self._partial_revision_history_cache.append(revision_id)
2474
if (stop_index is not None and
2475
len(self._partial_revision_history_cache) > stop_index):
2477
if revision_id == stop_revision:
2480
def _write_revision_history(self, history):
2481
"""Factored out of set_revision_history.
2483
This performs the actual writing to disk, with format-specific checks.
2484
It is intended to be called by BzrBranch5.set_revision_history.
2486
if len(history) == 0:
2487
last_revision = 'null:'
2489
if history != self._lefthand_history(history[-1]):
2490
raise errors.NotLefthandHistory(history)
2491
last_revision = history[-1]
2492
if self._get_append_revisions_only():
2493
self._check_history_violation(last_revision)
2494
self._write_last_revision_info(len(history), last_revision)
2497
def _set_parent_location(self, url):
2498
"""Set the parent branch"""
2499
self._set_config_location('parent_location', url, make_relative=True)
2502
def _get_parent_location(self):
2503
"""Set the parent branch"""
2504
return self._get_config_location('parent_location')
2507
def _set_all_reference_info(self, info_dict):
2508
"""Replace all reference info stored in a branch.
2510
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2513
writer = rio.RioWriter(s)
2514
for key, (tree_path, branch_location) in info_dict.iteritems():
2515
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2516
branch_location=branch_location)
2517
writer.write_stanza(stanza)
2518
self._transport.put_bytes('references', s.getvalue())
2519
self._reference_info = info_dict
2522
def _get_all_reference_info(self):
2523
"""Return all the reference info stored in a branch.
2525
:return: A dict of {file_id: (tree_path, branch_location)}
2527
if self._reference_info is not None:
2528
return self._reference_info
2529
rio_file = self._transport.get('references')
2531
stanzas = rio.read_stanzas(rio_file)
2532
info_dict = dict((s['file_id'], (s['tree_path'],
2533
s['branch_location'])) for s in stanzas)
2536
self._reference_info = info_dict
2539
def set_reference_info(self, file_id, tree_path, branch_location):
2540
"""Set the branch location to use for a tree reference.
2542
:param file_id: The file-id of the tree reference.
2543
:param tree_path: The path of the tree reference in the tree.
2544
:param branch_location: The location of the branch to retrieve tree
2547
info_dict = self._get_all_reference_info()
2548
info_dict[file_id] = (tree_path, branch_location)
2549
if None in (tree_path, branch_location):
2550
if tree_path is not None:
2551
raise ValueError('tree_path must be None when branch_location'
2553
if branch_location is not None:
2554
raise ValueError('branch_location must be None when tree_path'
2556
del info_dict[file_id]
2557
self._set_all_reference_info(info_dict)
2559
def get_reference_info(self, file_id):
2560
"""Get the tree_path and branch_location for a tree reference.
2562
:return: a tuple of (tree_path, branch_location)
2564
return self._get_all_reference_info().get(file_id, (None, None))
2566
def reference_parent(self, file_id, path, possible_transports=None):
2567
"""Return the parent branch for a tree-reference file_id.
2569
:param file_id: The file_id of the tree reference
2570
:param path: The path of the file_id in the tree
2571
:return: A branch associated with the file_id
2573
branch_location = self.get_reference_info(file_id)[1]
2574
if branch_location is None:
2575
return Branch.reference_parent(self, file_id, path,
2576
possible_transports)
2577
branch_location = urlutils.join(self.base, branch_location)
2578
return Branch.open(branch_location,
2579
possible_transports=possible_transports)
2581
def set_push_location(self, location):
2582
"""See Branch.set_push_location."""
2583
self._set_config_location('push_location', location)
2585
def set_bound_location(self, location):
2586
"""See Branch.set_push_location."""
2588
config = self.get_config()
2589
if location is None:
2590
if config.get_user_option('bound') != 'True':
2593
config.set_user_option('bound', 'False', warn_masked=True)
2596
self._set_config_location('bound_location', location,
2598
config.set_user_option('bound', 'True', warn_masked=True)
2601
def _get_bound_location(self, bound):
2602
"""Return the bound location in the config file.
2604
Return None if the bound parameter does not match"""
2605
config = self.get_config()
2606
config_bound = (config.get_user_option('bound') == 'True')
2607
if config_bound != bound:
2609
return self._get_config_location('bound_location', config=config)
2611
def get_bound_location(self):
2612
"""See Branch.set_push_location."""
2613
return self._get_bound_location(True)
2615
def get_old_bound_location(self):
2616
"""See Branch.get_old_bound_location"""
2617
return self._get_bound_location(False)
2619
def get_stacked_on_url(self):
2620
# you can always ask for the URL; but you might not be able to use it
2621
# if the repo can't support stacking.
2622
## self._check_stackable_repo()
2623
stacked_url = self._get_config_location('stacked_on_location')
2624
if stacked_url is None:
2625
raise errors.NotStacked(self)
2628
def set_append_revisions_only(self, enabled):
2633
self.get_config().set_user_option('append_revisions_only', value,
2636
def _get_append_revisions_only(self):
2637
value = self.get_config().get_user_option('append_revisions_only')
2638
return value == 'True'
2641
def generate_revision_history(self, revision_id, last_rev=None,
2643
"""See BzrBranch5.generate_revision_history"""
2644
history = self._lefthand_history(revision_id, last_rev, other_branch)
2645
revno = len(history)
2646
self.set_last_revision_info(revno, revision_id)
2649
def get_rev_id(self, revno, history=None):
2650
"""Find the revision id of the specified revno."""
2652
return _mod_revision.NULL_REVISION
2654
last_revno, last_revision_id = self.last_revision_info()
2655
if revno <= 0 or revno > last_revno:
2656
raise errors.NoSuchRevision(self, revno)
2658
if history is not None:
2659
return history[revno - 1]
2661
index = last_revno - revno
2662
if len(self._partial_revision_history_cache) <= index:
2663
self._extend_partial_history(stop_index=index)
2664
if len(self._partial_revision_history_cache) > index:
2665
return self._partial_revision_history_cache[index]
2667
raise errors.NoSuchRevision(self, revno)
2670
def revision_id_to_revno(self, revision_id):
2671
"""Given a revision id, return its revno"""
2672
if _mod_revision.is_null(revision_id):
2675
index = self._partial_revision_history_cache.index(revision_id)
2677
self._extend_partial_history(stop_revision=revision_id)
2678
index = len(self._partial_revision_history_cache) - 1
2679
if self._partial_revision_history_cache[index] != revision_id:
2680
raise errors.NoSuchRevision(self, revision_id)
2681
return self.revno() - index
2684
class BzrBranch7(BzrBranch8):
2685
"""A branch with support for a fallback repository."""
2687
def set_reference_info(self, file_id, tree_path, branch_location):
2688
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2690
def get_reference_info(self, file_id):
2691
Branch.get_reference_info(self, file_id)
2693
def reference_parent(self, file_id, path, possible_transports=None):
2694
return Branch.reference_parent(self, file_id, path,
2695
possible_transports)
2698
class BzrBranch6(BzrBranch7):
2699
"""See BzrBranchFormat6 for the capabilities of this branch.
2701
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2705
def get_stacked_on_url(self):
2706
raise errors.UnstackableBranchFormat(self._format, self.base)
2709
######################################################################
2710
# results of operations
2713
class _Result(object):
2715
def _show_tag_conficts(self, to_file):
2716
if not getattr(self, 'tag_conflicts', None):
2718
to_file.write('Conflicting tags:\n')
2719
for name, value1, value2 in self.tag_conflicts:
2720
to_file.write(' %s\n' % (name, ))
2723
class PullResult(_Result):
2724
"""Result of a Branch.pull operation.
2726
:ivar old_revno: Revision number before pull.
2727
:ivar new_revno: Revision number after pull.
2728
:ivar old_revid: Tip revision id before pull.
2729
:ivar new_revid: Tip revision id after pull.
2730
:ivar source_branch: Source (local) branch object. (read locked)
2731
:ivar master_branch: Master branch of the target, or the target if no
2733
:ivar local_branch: target branch if there is a Master, else None
2734
:ivar target_branch: Target/destination branch object. (write locked)
2735
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2739
# DEPRECATED: pull used to return the change in revno
2740
return self.new_revno - self.old_revno
2742
def report(self, to_file):
2744
if self.old_revid == self.new_revid:
2745
to_file.write('No revisions to pull.\n')
2747
to_file.write('Now on revision %d.\n' % self.new_revno)
2748
self._show_tag_conficts(to_file)
2751
class BranchPushResult(_Result):
2752
"""Result of a Branch.push operation.
2754
:ivar old_revno: Revision number (eg 10) of the target before push.
2755
:ivar new_revno: Revision number (eg 12) of the target after push.
2756
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2758
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2760
:ivar source_branch: Source branch object that the push was from. This is
2761
read locked, and generally is a local (and thus low latency) branch.
2762
:ivar master_branch: If target is a bound branch, the master branch of
2763
target, or target itself. Always write locked.
2764
:ivar target_branch: The direct Branch where data is being sent (write
2766
:ivar local_branch: If the target is a bound branch this will be the
2767
target, otherwise it will be None.
2771
# DEPRECATED: push used to return the change in revno
2772
return self.new_revno - self.old_revno
2774
def report(self, to_file):
2775
"""Write a human-readable description of the result."""
2776
if self.old_revid == self.new_revid:
2777
note('No new revisions to push.')
2779
note('Pushed up to revision %d.' % self.new_revno)
2780
self._show_tag_conficts(to_file)
2783
class BranchCheckResult(object):
2784
"""Results of checking branch consistency.
2789
def __init__(self, branch):
2790
self.branch = branch
2791
self.ghosts_in_mainline = False
2793
def report_results(self, verbose):
2794
"""Report the check results via trace.note.
2796
:param verbose: Requests more detailed display of what was checked,
2799
note('checked branch %s format %s',
2801
self.branch._format)
2802
if self.ghosts_in_mainline:
2803
note('branch contains ghosts in mainline')
2806
class Converter5to6(object):
2807
"""Perform an in-place upgrade of format 5 to format 6"""
2809
def convert(self, branch):
2810
# Data for 5 and 6 can peacefully coexist.
2811
format = BzrBranchFormat6()
2812
new_branch = format.open(branch.bzrdir, _found=True)
2814
# Copy source data into target
2815
new_branch._write_last_revision_info(*branch.last_revision_info())
2816
new_branch.set_parent(branch.get_parent())
2817
new_branch.set_bound_location(branch.get_bound_location())
2818
new_branch.set_push_location(branch.get_push_location())
2820
# New branch has no tags by default
2821
new_branch.tags._set_tag_dict({})
2823
# Copying done; now update target format
2824
new_branch._transport.put_bytes('format',
2825
format.get_format_string(),
2826
mode=new_branch.bzrdir._get_file_mode())
2828
# Clean up old files
2829
new_branch._transport.delete('revision-history')
2831
branch.set_parent(None)
2832
except errors.NoSuchFile:
2834
branch.set_bound_location(None)
2837
class Converter6to7(object):
2838
"""Perform an in-place upgrade of format 6 to format 7"""
2840
def convert(self, branch):
2841
format = BzrBranchFormat7()
2842
branch._set_config_location('stacked_on_location', '')
2843
# update target format
2844
branch._transport.put_bytes('format', format.get_format_string())
2847
class Converter7to8(object):
2848
"""Perform an in-place upgrade of format 6 to format 7"""
2850
def convert(self, branch):
2851
format = BzrBranchFormat8()
2852
branch._transport.put_bytes('references', '')
2853
# update target format
2854
branch._transport.put_bytes('format', format.get_format_string())
2857
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2858
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2861
_run_with_write_locked_target will attempt to release the lock it acquires.
2863
If an exception is raised by callable, then that exception *will* be
2864
propagated, even if the unlock attempt raises its own error. Thus
2865
_run_with_write_locked_target should be preferred to simply doing::
2869
return callable(*args, **kwargs)
2874
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2875
# should share code?
2878
result = callable(*args, **kwargs)
2880
exc_info = sys.exc_info()
2884
raise exc_info[0], exc_info[1], exc_info[2]
2890
class InterBranch(InterObject):
2891
"""This class represents operations taking place between two branches.
2893
Its instances have methods like pull() and push() and contain
2894
references to the source and target repositories these operations
2895
can be carried out on.
2899
"""The available optimised InterBranch types."""
2902
def _get_branch_formats_to_test():
2903
"""Return a tuple with the Branch formats to use when testing."""
2904
raise NotImplementedError(self._get_branch_formats_to_test)
2906
def pull(self, overwrite=False, stop_revision=None,
2907
possible_transports=None, local=False):
2908
"""Mirror source into target branch.
2910
The target branch is considered to be 'local', having low latency.
2912
:returns: PullResult instance
2914
raise NotImplementedError(self.pull)
2916
def update_revisions(self, stop_revision=None, overwrite=False,
2918
"""Pull in new perfect-fit revisions.
2920
:param stop_revision: Updated until the given revision
2921
:param overwrite: Always set the branch pointer, rather than checking
2922
to see if it is a proper descendant.
2923
:param graph: A Graph object that can be used to query history
2924
information. This can be None.
2927
raise NotImplementedError(self.update_revisions)
2929
def push(self, overwrite=False, stop_revision=None,
2930
_override_hook_source_branch=None):
2931
"""Mirror the source branch into the target branch.
2933
The source branch is considered to be 'local', having low latency.
2935
raise NotImplementedError(self.push)
2938
class GenericInterBranch(InterBranch):
2939
"""InterBranch implementation that uses public Branch functions.
2943
def _get_branch_formats_to_test():
2944
return BranchFormat._default_format, BranchFormat._default_format
2946
def update_revisions(self, stop_revision=None, overwrite=False,
2948
"""See InterBranch.update_revisions()."""
2949
self.source.lock_read()
2951
other_revno, other_last_revision = self.source.last_revision_info()
2952
stop_revno = None # unknown
2953
if stop_revision is None:
2954
stop_revision = other_last_revision
2955
if _mod_revision.is_null(stop_revision):
2956
# if there are no commits, we're done.
2958
stop_revno = other_revno
2960
# what's the current last revision, before we fetch [and change it
2962
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2963
# we fetch here so that we don't process data twice in the common
2964
# case of having something to pull, and so that the check for
2965
# already merged can operate on the just fetched graph, which will
2966
# be cached in memory.
2967
self.target.fetch(self.source, stop_revision)
2968
# Check to see if one is an ancestor of the other
2971
graph = self.target.repository.get_graph()
2972
if self.target._check_if_descendant_or_diverged(
2973
stop_revision, last_rev, graph, self.source):
2974
# stop_revision is a descendant of last_rev, but we aren't
2975
# overwriting, so we're done.
2977
if stop_revno is None:
2979
graph = self.target.repository.get_graph()
2980
this_revno, this_last_revision = \
2981
self.target.last_revision_info()
2982
stop_revno = graph.find_distance_to_null(stop_revision,
2983
[(other_last_revision, other_revno),
2984
(this_last_revision, this_revno)])
2985
self.target.set_last_revision_info(stop_revno, stop_revision)
2987
self.source.unlock()
2989
def pull(self, overwrite=False, stop_revision=None,
2990
possible_transports=None, _hook_master=None, run_hooks=True,
2991
_override_hook_target=None, local=False):
2994
:param _hook_master: Private parameter - set the branch to
2995
be supplied as the master to pull hooks.
2996
:param run_hooks: Private parameter - if false, this branch
2997
is being called because it's the master of the primary branch,
2998
so it should not run its hooks.
2999
:param _override_hook_target: Private parameter - set the branch to be
3000
supplied as the target_branch to pull hooks.
3001
:param local: Only update the local branch, and not the bound branch.
3003
# This type of branch can't be bound.
3005
raise errors.LocalRequiresBoundBranch()
3006
result = PullResult()
3007
result.source_branch = self.source
3008
if _override_hook_target is None:
3009
result.target_branch = self.target
3011
result.target_branch = _override_hook_target
3012
self.source.lock_read()
3014
# We assume that during 'pull' the target repository is closer than
3016
self.source.update_references(self.target)
3017
graph = self.target.repository.get_graph(self.source.repository)
3018
# TODO: Branch formats should have a flag that indicates
3019
# that revno's are expensive, and pull() should honor that flag.
3021
result.old_revno, result.old_revid = \
3022
self.target.last_revision_info()
3023
self.target.update_revisions(self.source, stop_revision,
3024
overwrite=overwrite, graph=graph)
3025
# TODO: The old revid should be specified when merging tags,
3026
# so a tags implementation that versions tags can only
3027
# pull in the most recent changes. -- JRV20090506
3028
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3030
result.new_revno, result.new_revid = self.target.last_revision_info()
3032
result.master_branch = _hook_master
3033
result.local_branch = result.target_branch
3035
result.master_branch = result.target_branch
3036
result.local_branch = None
3038
for hook in Branch.hooks['post_pull']:
3041
self.source.unlock()
3044
def push(self, overwrite=False, stop_revision=None,
3045
_override_hook_source_branch=None):
3046
"""See InterBranch.push.
3048
This is the basic concrete implementation of push()
3050
:param _override_hook_source_branch: If specified, run
3051
the hooks passing this Branch as the source, rather than self.
3052
This is for use of RemoteBranch, where push is delegated to the
3053
underlying vfs-based Branch.
3055
# TODO: Public option to disable running hooks - should be trivial but
3057
self.source.lock_read()
3059
return _run_with_write_locked_target(
3060
self.target, self._push_with_bound_branches, overwrite,
3062
_override_hook_source_branch=_override_hook_source_branch)
3064
self.source.unlock()
3067
def _push_with_bound_branches(self, overwrite, stop_revision,
3068
_override_hook_source_branch=None):
3069
"""Push from source into target, and into target's master if any.
3072
if _override_hook_source_branch:
3073
result.source_branch = _override_hook_source_branch
3074
for hook in Branch.hooks['post_push']:
3077
bound_location = self.target.get_bound_location()
3078
if bound_location and self.target.base != bound_location:
3079
# there is a master branch.
3081
# XXX: Why the second check? Is it even supported for a branch to
3082
# be bound to itself? -- mbp 20070507
3083
master_branch = self.target.get_master_branch()
3084
master_branch.lock_write()
3086
# push into the master from the source branch.
3087
self.source._basic_push(master_branch, overwrite, stop_revision)
3088
# and push into the target branch from the source. Note that we
3089
# push from the source branch again, because its considered the
3090
# highest bandwidth repository.
3091
result = self.source._basic_push(self.target, overwrite,
3093
result.master_branch = master_branch
3094
result.local_branch = self.target
3098
master_branch.unlock()
3101
result = self.source._basic_push(self.target, overwrite,
3103
# TODO: Why set master_branch and local_branch if there's no
3104
# binding? Maybe cleaner to just leave them unset? -- mbp
3106
result.master_branch = self.target
3107
result.local_branch = None
3112
def is_compatible(self, source, target):
3113
# GenericBranch uses the public API, so always compatible
3117
class InterToBranch5(GenericInterBranch):
3120
def _get_branch_formats_to_test():
3121
return BranchFormat._default_format, BzrBranchFormat5()
3123
def pull(self, overwrite=False, stop_revision=None,
3124
possible_transports=None, run_hooks=True,
3125
_override_hook_target=None, local=False):
3126
"""Pull from source into self, updating my master if any.
3128
:param run_hooks: Private parameter - if false, this branch
3129
is being called because it's the master of the primary branch,
3130
so it should not run its hooks.
3132
bound_location = self.target.get_bound_location()
3133
if local and not bound_location:
3134
raise errors.LocalRequiresBoundBranch()
3135
master_branch = None
3136
if not local and bound_location and self.source.base != bound_location:
3137
# not pulling from master, so we need to update master.
3138
master_branch = self.target.get_master_branch(possible_transports)
3139
master_branch.lock_write()
3142
# pull from source into master.
3143
master_branch.pull(self.source, overwrite, stop_revision,
3145
return super(InterToBranch5, self).pull(overwrite,
3146
stop_revision, _hook_master=master_branch,
3147
run_hooks=run_hooks,
3148
_override_hook_target=_override_hook_target)
3151
master_branch.unlock()
3154
InterBranch.register_optimiser(GenericInterBranch)
3155
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
