118
115
if master is not None:
119
116
master.break_lock()
121
def _check_stackable_repo(self):
122
if not self.repository._format.supports_external_lookups:
123
raise errors.UnstackableRepositoryFormat(self.repository._format,
124
self.repository.base)
127
def open(base, _unsupported=False, possible_transports=None):
119
@deprecated_method(zero_eight)
120
def open_downlevel(base):
121
"""Open a branch which may be of an old format."""
122
return Branch.open(base, _unsupported=True)
125
def open(base, _unsupported=False):
128
126
"""Open the branch rooted at base.
130
128
For instance, if the branch is at URL/.bzr/branch,
131
129
Branch.open(URL) -> a Branch instance.
133
control = bzrdir.BzrDir.open(base, _unsupported,
134
possible_transports=possible_transports)
135
return control.open_branch(_unsupported)
138
def open_from_transport(transport, _unsupported=False):
139
"""Open the branch rooted at transport"""
140
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
141
return control.open_branch(_unsupported)
144
def open_containing(url, possible_transports=None):
131
control = bzrdir.BzrDir.open(base, _unsupported)
132
return control.open_branch(_unsupported)
135
def open_containing(url):
145
136
"""Open an existing branch which contains url.
147
138
This probes for a branch at url, and searches upwards from there.
149
140
Basically we keep looking up until we find the control directory or
150
141
run into the root. If there isn't one, raises NotBranchError.
151
If there is one and it is either an unrecognised format or an unsupported
142
If there is one and it is either an unrecognised format or an unsupported
152
143
format, UnknownFormatError or UnsupportedFormatError are raised.
153
144
If there is one, it is returned, along with the unused portion of url.
155
control, relpath = bzrdir.BzrDir.open_containing(url,
146
control, relpath = bzrdir.BzrDir.open_containing(url)
157
147
return control.open_branch(), relpath
159
def _push_should_merge_tags(self):
160
"""Should _basic_push merge this branch's tags into the target?
162
The default implementation returns False if this branch has no tags,
163
and True the rest of the time. Subclasses may override this.
165
return self.supports_tags() and self.tags.get_tag_dict()
150
@deprecated_function(zero_eight)
151
def initialize(base):
152
"""Create a new working tree and branch, rooted at 'base' (url)
154
NOTE: This will soon be deprecated in favour of creation
157
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
159
@deprecated_function(zero_eight)
160
def setup_caching(self, cache_root):
161
"""Subclasses that care about caching should override this, and set
162
up cached stores located under cache_root.
164
NOTE: This is unused.
167
168
def get_config(self):
168
169
return BranchConfig(self)
170
def _get_config(self):
171
"""Get the concrete config for just the config in this branch.
173
This is not intended for client use; see Branch.get_config for the
178
:return: An object supporting get_option and set_option.
180
raise NotImplementedError(self._get_config)
182
def _get_fallback_repository(self, url):
183
"""Get the repository we fallback to at url."""
184
url = urlutils.join(self.base, url)
185
a_bzrdir = bzrdir.BzrDir.open(url,
186
possible_transports=[self.bzrdir.root_transport])
187
return a_bzrdir.open_branch().repository
189
def _get_tags_bytes(self):
190
"""Get the bytes of a serialised tags dict.
192
Note that not all branches support tags, nor do all use the same tags
193
logic: this method is specific to BasicTags. Other tag implementations
194
may use the same method name and behave differently, safely, because
195
of the double-dispatch via
196
format.make_tags->tags_instance->get_tags_dict.
198
:return: The bytes of the tags file.
199
:seealso: Branch._set_tags_bytes.
201
return self._transport.get_bytes('tags')
203
def _get_nick(self, local=False, possible_transports=None):
204
config = self.get_config()
205
# explicit overrides master, but don't look for master if local is True
206
if not local and not config.has_explicit_nickname():
208
master = self.get_master_branch(possible_transports)
209
if master is not None:
210
# return the master branch value
212
except errors.BzrError, e:
213
# Silently fall back to local implicit nick if the master is
215
mutter("Could not connect to bound branch, "
216
"falling back to local nick.\n " + str(e))
217
return config.get_nickname()
172
return self.get_config().get_nickname()
219
174
def _set_nick(self, nick):
220
175
self.get_config().set_user_option('nickname', nick, warn_masked=True)
268
196
raise NotImplementedError(self.get_physical_lock_status)
271
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
272
"""Return the revision_id for a dotted revno.
274
:param revno: a tuple like (1,) or (1,1,2)
275
:param _cache_reverse: a private parameter enabling storage
276
of the reverse mapping in a top level cache. (This should
277
only be done in selective circumstances as we want to
278
avoid having the mapping cached multiple times.)
279
:return: the revision_id
280
:raises errors.NoSuchRevision: if the revno doesn't exist
282
rev_id = self._do_dotted_revno_to_revision_id(revno)
284
self._partial_revision_id_to_revno_cache[rev_id] = revno
287
def _do_dotted_revno_to_revision_id(self, revno):
288
"""Worker function for dotted_revno_to_revision_id.
290
Subclasses should override this if they wish to
291
provide a more efficient implementation.
294
return self.get_rev_id(revno[0])
295
revision_id_to_revno = self.get_revision_id_to_revno_map()
296
revision_ids = [revision_id for revision_id, this_revno
297
in revision_id_to_revno.iteritems()
298
if revno == this_revno]
299
if len(revision_ids) == 1:
300
return revision_ids[0]
302
revno_str = '.'.join(map(str, revno))
303
raise errors.NoSuchRevision(self, revno_str)
306
def revision_id_to_dotted_revno(self, revision_id):
307
"""Given a revision id, return its dotted revno.
309
:return: a tuple like (1,) or (400,1,3).
311
return self._do_revision_id_to_dotted_revno(revision_id)
313
def _do_revision_id_to_dotted_revno(self, revision_id):
314
"""Worker function for revision_id_to_revno."""
315
# Try the caches if they are loaded
316
result = self._partial_revision_id_to_revno_cache.get(revision_id)
317
if result is not None:
319
if self._revision_id_to_revno_cache:
320
result = self._revision_id_to_revno_cache.get(revision_id)
322
raise errors.NoSuchRevision(self, revision_id)
323
# Try the mainline as it's optimised
325
revno = self.revision_id_to_revno(revision_id)
327
except errors.NoSuchRevision:
328
# We need to load and use the full revno map after all
329
result = self.get_revision_id_to_revno_map().get(revision_id)
331
raise errors.NoSuchRevision(self, revision_id)
335
199
def get_revision_id_to_revno_map(self):
336
200
"""Return the revision_id => dotted revno map.
362
226
:return: A dictionary mapping revision_id => dotted revno.
228
last_revision = self.last_revision()
229
revision_graph = self.repository.get_revision_graph(last_revision)
230
merge_sorted_revisions = tsort.merge_sort(
364
235
revision_id_to_revno = dict((rev_id, revno)
365
for rev_id, depth, revno, end_of_merge
366
in self.iter_merge_sorted_revisions())
236
for seq_num, rev_id, depth, revno, end_of_merge
237
in merge_sorted_revisions)
367
238
return revision_id_to_revno
370
def iter_merge_sorted_revisions(self, start_revision_id=None,
371
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
372
"""Walk the revisions for a branch in merge sorted order.
374
Merge sorted order is the output from a merge-aware,
375
topological sort, i.e. all parents come before their
376
children going forward; the opposite for reverse.
378
:param start_revision_id: the revision_id to begin walking from.
379
If None, the branch tip is used.
380
:param stop_revision_id: the revision_id to terminate the walk
381
after. If None, the rest of history is included.
382
:param stop_rule: if stop_revision_id is not None, the precise rule
383
to use for termination:
384
* 'exclude' - leave the stop revision out of the result (default)
385
* 'include' - the stop revision is the last item in the result
386
* 'with-merges' - include the stop revision and all of its
387
merged revisions in the result
388
:param direction: either 'reverse' or 'forward':
389
* reverse means return the start_revision_id first, i.e.
390
start at the most recent revision and go backwards in history
391
* forward returns tuples in the opposite order to reverse.
392
Note in particular that forward does *not* do any intelligent
393
ordering w.r.t. depth as some clients of this API may like.
394
(If required, that ought to be done at higher layers.)
396
:return: an iterator over (revision_id, depth, revno, end_of_merge)
399
* revision_id: the unique id of the revision
400
* depth: How many levels of merging deep this node has been
402
* revno_sequence: This field provides a sequence of
403
revision numbers for all revisions. The format is:
404
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
405
branch that the revno is on. From left to right the REVNO numbers
406
are the sequence numbers within that branch of the revision.
407
* end_of_merge: When True the next node (earlier in history) is
408
part of a different merge.
410
# Note: depth and revno values are in the context of the branch so
411
# we need the full graph to get stable numbers, regardless of the
413
if self._merge_sorted_revisions_cache is None:
414
last_revision = self.last_revision()
415
graph = self.repository.get_graph()
416
parent_map = dict(((key, value) for key, value in
417
graph.iter_ancestry([last_revision]) if value is not None))
418
revision_graph = repository._strip_NULL_ghosts(parent_map)
419
revs = tsort.merge_sort(revision_graph, last_revision, None,
421
# Drop the sequence # before caching
422
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
424
filtered = self._filter_merge_sorted_revisions(
425
self._merge_sorted_revisions_cache, start_revision_id,
426
stop_revision_id, stop_rule)
427
if direction == 'reverse':
429
if direction == 'forward':
430
return reversed(list(filtered))
432
raise ValueError('invalid direction %r' % direction)
434
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
435
start_revision_id, stop_revision_id, stop_rule):
436
"""Iterate over an inclusive range of sorted revisions."""
437
rev_iter = iter(merge_sorted_revisions)
438
if start_revision_id is not None:
439
for rev_id, depth, revno, end_of_merge in rev_iter:
440
if rev_id != start_revision_id:
443
# The decision to include the start or not
444
# depends on the stop_rule if a stop is provided
446
iter([(rev_id, depth, revno, end_of_merge)]),
449
if stop_revision_id is None:
450
for rev_id, depth, revno, end_of_merge in rev_iter:
451
yield rev_id, depth, revno, end_of_merge
452
elif stop_rule == 'exclude':
453
for rev_id, depth, revno, end_of_merge in rev_iter:
454
if rev_id == stop_revision_id:
456
yield rev_id, depth, revno, end_of_merge
457
elif stop_rule == 'include':
458
for rev_id, depth, revno, end_of_merge in rev_iter:
459
yield rev_id, depth, revno, end_of_merge
460
if rev_id == stop_revision_id:
462
elif stop_rule == 'with-merges':
463
stop_rev = self.repository.get_revision(stop_revision_id)
464
if stop_rev.parent_ids:
465
left_parent = stop_rev.parent_ids[0]
467
left_parent = _mod_revision.NULL_REVISION
468
for rev_id, depth, revno, end_of_merge in rev_iter:
469
if rev_id == left_parent:
471
yield rev_id, depth, revno, end_of_merge
473
raise ValueError('invalid stop_rule %r' % stop_rule)
475
240
def leave_lock_in_place(self):
476
241
"""Tell this branch object not to release the physical lock when this
477
242
object is unlocked.
479
244
If lock_write doesn't return a token, then this method is not supported.
481
246
self.control_files.leave_in_place()
569
350
The delta is relative to its mainline predecessor, or the
570
351
empty tree for revision 1.
353
assert isinstance(revno, int)
572
354
rh = self.revision_history()
573
355
if not (1 <= revno <= len(rh)):
574
raise errors.InvalidRevisionNumber(revno)
356
raise InvalidRevisionNumber(revno)
575
357
return self.repository.get_revision_delta(rh[revno-1])
577
def get_stacked_on_url(self):
578
"""Get the URL this branch is stacked against.
359
@deprecated_method(zero_sixteen)
360
def get_root_id(self):
361
"""Return the id of this branches root
580
:raises NotStacked: If the branch is not stacked.
581
:raises UnstackableBranchFormat: If the branch does not support
363
Deprecated: branches don't have root ids-- trees do.
364
Use basis_tree().get_root_id() instead.
584
raise NotImplementedError(self.get_stacked_on_url)
366
raise NotImplementedError(self.get_root_id)
586
368
def print_file(self, file, revision_id):
587
369
"""Print `file` to stdout."""
588
370
raise NotImplementedError(self.print_file)
372
def append_revision(self, *revision_ids):
373
raise NotImplementedError(self.append_revision)
590
375
def set_revision_history(self, rev_history):
591
376
raise NotImplementedError(self.set_revision_history)
593
def set_stacked_on_url(self, url):
594
"""Set the URL this branch is stacked against.
596
:raises UnstackableBranchFormat: If the branch does not support
598
:raises UnstackableRepositoryFormat: If the repository does not support
601
if not self._format.supports_stacking():
602
raise errors.UnstackableBranchFormat(self._format, self.base)
603
self._check_stackable_repo()
606
old_url = self.get_stacked_on_url()
607
except (errors.NotStacked, errors.UnstackableBranchFormat,
608
errors.UnstackableRepositoryFormat):
611
# repositories don't offer an interface to remove fallback
612
# repositories today; take the conceptually simpler option and just
614
self.repository = self.bzrdir.find_repository()
615
# for every revision reference the branch has, ensure it is pulled
617
source_repository = self._get_fallback_repository(old_url)
618
for revision_id in chain([self.last_revision()],
619
self.tags.get_reverse_tag_dict()):
620
self.repository.fetch(source_repository, revision_id,
623
self._activate_fallback_location(url)
624
# write this out after the repository is stacked to avoid setting a
625
# stacked config that doesn't work.
626
self._set_config_location('stacked_on_location', url)
629
def _set_tags_bytes(self, bytes):
630
"""Mirror method for _get_tags_bytes.
632
:seealso: Branch._get_tags_bytes.
634
return _run_with_write_locked_target(self, self._transport.put_bytes,
637
378
def _cache_revision_history(self, rev_history):
638
379
"""Set the cached revision history to rev_history.
750
484
common_index = min(self_len, other_len) -1
751
485
if common_index >= 0 and \
752
486
self_history[common_index] != other_history[common_index]:
753
raise errors.DivergedBranches(self, other)
487
raise DivergedBranches(self, other)
755
489
if stop_revision is None:
756
490
stop_revision = other_len
492
assert isinstance(stop_revision, int)
758
493
if stop_revision > other_len:
759
494
raise errors.NoSuchRevision(self, stop_revision)
760
495
return other_history[self_len:stop_revision]
763
def update_revisions(self, other, stop_revision=None, overwrite=False,
497
def update_revisions(self, other, stop_revision=None):
765
498
"""Pull in new perfect-fit revisions.
767
500
:param other: Another Branch to pull from
768
501
:param stop_revision: Updated until the given revision
769
:param overwrite: Always set the branch pointer, rather than checking
770
to see if it is a proper descendant.
771
:param graph: A Graph object that can be used to query history
772
information. This can be None.
775
return InterBranch.get(other, self).update_revisions(stop_revision,
778
def import_last_revision_info(self, source_repo, revno, revid):
779
"""Set the last revision info, importing from another repo if necessary.
781
This is used by the bound branch code to upload a revision to
782
the master branch first before updating the tip of the local branch.
784
:param source_repo: Source repository to optionally fetch from
785
:param revno: Revision number of the new tip
786
:param revid: Revision id of the new tip
788
if not self.repository.has_same_location(source_repo):
789
self.repository.fetch(source_repo, revision_id=revid)
790
self.set_last_revision_info(revno, revid)
504
raise NotImplementedError(self.update_revisions)
792
506
def revision_id_to_revno(self, revision_id):
793
507
"""Given a revision id, return its revno"""
794
508
if _mod_revision.is_null(revision_id):
510
revision_id = osutils.safe_revision_id(revision_id)
796
511
history = self.revision_history()
798
513
return history.index(revision_id) + 1
830
544
"""Return `Tree` object for last revision."""
831
545
return self.repository.revision_tree(self.last_revision())
547
def rename_one(self, from_rel, to_rel):
550
This can change the directory or the filename or both.
552
raise NotImplementedError(self.rename_one)
554
def move(self, from_paths, to_name):
557
to_name must exist as a versioned directory.
559
If to_name exists and is a directory, the files are moved into
560
it, keeping their old names. If it is a directory,
562
Note that to_name is only the last component of the new name;
563
this doesn't change the directory.
565
This returns a list of (from_path, to_path) pairs for each
568
raise NotImplementedError(self.move)
833
570
def get_parent(self):
834
571
"""Return the parent location of the branch.
836
This is the default location for pull/missing. The usual
573
This is the default location for push/pull/missing. The usual
837
574
pattern is that the user can override it by specifying a
840
parent = self._get_parent_location()
843
# This is an old-format absolute path to a local branch
845
if parent.startswith('/'):
846
parent = urlutils.local_path_to_url(parent.decode('utf8'))
848
return urlutils.join(self.base[:-1], parent)
849
except errors.InvalidURLJoin, e:
850
raise errors.InaccessibleParent(parent, self.base)
852
def _get_parent_location(self):
853
raise NotImplementedError(self._get_parent_location)
577
raise NotImplementedError(self.get_parent)
855
579
def _set_config_location(self, name, url, config=None,
856
580
make_relative=False):
914
638
"""Set a new push location for this branch."""
915
639
raise NotImplementedError(self.set_push_location)
917
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
918
"""Run the post_change_branch_tip hooks."""
919
hooks = Branch.hooks['post_change_branch_tip']
922
new_revno, new_revid = self.last_revision_info()
923
params = ChangeBranchTipParams(
924
self, old_revno, new_revno, old_revid, new_revid)
928
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
929
"""Run the pre_change_branch_tip hooks."""
930
hooks = Branch.hooks['pre_change_branch_tip']
933
old_revno, old_revid = self.last_revision_info()
934
params = ChangeBranchTipParams(
935
self, old_revno, new_revno, old_revid, new_revid)
939
except errors.TipChangeRejected:
942
exc_info = sys.exc_info()
943
hook_name = Branch.hooks.get_hook_name(hook)
944
raise errors.HookFailed(
945
'pre_change_branch_tip', hook_name, exc_info)
947
641
def set_parent(self, url):
948
642
raise NotImplementedError(self.set_parent)
950
644
@needs_write_lock
951
645
def update(self):
952
"""Synchronise this branch with the master branch if any.
646
"""Synchronise this branch with the master branch if any.
954
648
:return: None or the last_revision pivoted out during the update.
964
658
self.check_real_revno(revno)
966
660
def check_real_revno(self, revno):
968
662
Check whether a revno corresponds to a real revision.
969
663
Zero (the NULL revision) is considered invalid
971
665
if revno < 1 or revno > self.revno():
972
raise errors.InvalidRevisionNumber(revno)
666
raise InvalidRevisionNumber(revno)
975
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
669
def clone(self, to_bzrdir, revision_id=None):
976
670
"""Clone this branch into to_bzrdir preserving all semantic values.
978
Most API users will want 'create_clone_on_transport', which creates a
979
new bzrdir and branch on the fly.
981
672
revision_id: if not None, the revision history in the new branch will
982
673
be truncated to end with revision_id.
984
result = to_bzrdir.create_branch()
985
if repository_policy is not None:
986
repository_policy.configure_branch(result)
675
result = self._format.initialize(to_bzrdir)
987
676
self.copy_content_into(result, revision_id=revision_id)
991
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
680
def sprout(self, to_bzrdir, revision_id=None):
992
681
"""Create a new line of development from the branch, into to_bzrdir.
994
to_bzrdir controls the branch format.
996
683
revision_id: if not None, the revision history in the new branch will
997
684
be truncated to end with revision_id.
999
result = to_bzrdir.create_branch()
1000
if repository_policy is not None:
1001
repository_policy.configure_branch(result)
686
result = self._format.initialize(to_bzrdir)
1002
687
self.copy_content_into(result, revision_id=revision_id)
1003
688
result.set_parent(self.bzrdir.root_transport.base)
1007
692
"""Synchronize last revision and revision history between branches.
1009
694
This version is most efficient when the destination is also a
1010
BzrBranch6, but works for BzrBranch5, as long as the destination's
1011
repository contains all the lefthand ancestors of the intended
1012
last_revision. If not, set_last_revision_info will fail.
695
BzrBranch5, but works for BzrBranch6 as long as the revision
696
history is the true lefthand parent history, and all of the revisions
697
are in the destination's repository. If not, set_revision_history
1014
700
:param destination: The branch to copy the history into
1015
701
:param revision_id: The revision-id to truncate history at. May
1016
702
be None to copy complete history.
1018
source_revno, source_revision_id = self.last_revision_info()
1019
if revision_id is None:
1020
revno, revision_id = source_revno, source_revision_id
1021
elif source_revision_id == revision_id:
1022
# we know the revno without needing to walk all of history
1023
revno = source_revno
1025
# To figure out the revno for a random revision, we need to build
1026
# the revision history, and count its length.
1027
# We don't care about the order, just how long it is.
1028
# Alternatively, we could start at the current location, and count
1029
# backwards. But there is no guarantee that we will find it since
1030
# it may be a merged revision.
1031
revno = len(list(self.repository.iter_reverse_revision_history(
1033
destination.set_last_revision_info(revno, revision_id)
704
if revision_id == _mod_revision.NULL_REVISION:
706
new_history = self.revision_history()
707
if revision_id is not None and new_history != []:
708
revision_id = osutils.safe_revision_id(revision_id)
710
new_history = new_history[:new_history.index(revision_id) + 1]
712
rev = self.repository.get_revision(revision_id)
713
new_history = rev.get_history(self.repository)[1:]
714
destination.set_revision_history(new_history)
1035
716
@needs_read_lock
1036
717
def copy_content_into(self, destination, revision_id=None):
1102
773
format.set_branch_format(self._format)
1105
def create_clone_on_transport(self, to_transport, revision_id=None,
1107
"""Create a clone of this branch and its bzrdir.
1109
:param to_transport: The transport to clone onto.
1110
:param revision_id: The revision id to use as tip in the new branch.
1111
If None the tip is obtained from this branch.
1112
:param stacked_on: An optional URL to stack the clone on.
1114
# XXX: Fix the bzrdir API to allow getting the branch back from the
1115
# clone call. Or something. 20090224 RBC/spiv.
1116
dir_to = self.bzrdir.clone_on_transport(to_transport,
1117
revision_id=revision_id, stacked_on=stacked_on)
1118
return dir_to.open_branch()
1120
776
def create_checkout(self, to_location, revision_id=None,
1121
lightweight=False, accelerator_tree=None,
1123
778
"""Create a checkout of a branch.
1125
780
:param to_location: The url to produce the checkout at
1126
781
:param revision_id: The revision to check out
1127
782
:param lightweight: If True, produce a lightweight checkout, otherwise,
1128
783
produce a bound branch (heavyweight checkout)
1129
:param accelerator_tree: A tree which can be used for retrieving file
1130
contents more quickly than the revision tree, i.e. a workingtree.
1131
The revision tree will be used for cases where accelerator_tree's
1132
content is different.
1133
:param hardlink: If true, hard-link files from accelerator_tree,
1135
784
:return: The tree of the created checkout
1137
786
t = transport.get_transport(to_location)
1186
823
def supports_tags(self):
1187
824
return self._format.supports_tags()
1189
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1191
"""Ensure that revision_b is a descendant of revision_a.
1193
This is a helper function for update_revisions.
1195
:raises: DivergedBranches if revision_b has diverged from revision_a.
1196
:returns: True if revision_b is a descendant of revision_a.
1198
relation = self._revision_relations(revision_a, revision_b, graph)
1199
if relation == 'b_descends_from_a':
1201
elif relation == 'diverged':
1202
raise errors.DivergedBranches(self, other_branch)
1203
elif relation == 'a_descends_from_b':
1206
raise AssertionError("invalid relation: %r" % (relation,))
1208
def _revision_relations(self, revision_a, revision_b, graph):
1209
"""Determine the relationship between two revisions.
1211
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1213
heads = graph.heads([revision_a, revision_b])
1214
if heads == set([revision_b]):
1215
return 'b_descends_from_a'
1216
elif heads == set([revision_a, revision_b]):
1217
# These branches have diverged
1219
elif heads == set([revision_a]):
1220
return 'a_descends_from_b'
1222
raise AssertionError("invalid heads: %r" % (heads,))
1225
827
class BranchFormat(object):
1226
828
"""An encapsulation of the initialization and open routines for a format.
1344
931
"""Is this format supported?
1346
933
Supported formats can be initialized and opened.
1347
Unsupported formats may not support initialization or committing or
934
Unsupported formats may not support initialization or committing or
1348
935
some other features depending on the reason for not being supported.
1352
def make_tags(self, branch):
1353
"""Create a tags object for branch.
1355
This method is on BranchFormat, because BranchFormats are reflected
1356
over the wire via network_name(), whereas full Branch instances require
1357
multiple VFS method calls to operate at all.
1359
The default implementation returns a disabled-tags instance.
1361
Note that it is normal for branch to be a RemoteBranch when using tags
1364
return DisabledTags(branch)
1366
def network_name(self):
1367
"""A simple byte string uniquely identifying this format for RPC calls.
1369
MetaDir branch formats use their disk format string to identify the
1370
repository over the wire. All in one formats such as bzr < 0.8, and
1371
foreign formats like svn/git and hg should use some marker which is
1372
unique and immutable.
1374
raise NotImplementedError(self.network_name)
1376
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
939
def open(self, a_bzrdir, _found=False):
1377
940
"""Return the branch object for a_bzrdir
1379
:param a_bzrdir: A BzrDir that contains a branch.
1380
:param _found: a private parameter, do not use it. It is used to
1381
indicate if format probing has already be done.
1382
:param ignore_fallbacks: when set, no fallback branches will be opened
1383
(if there are any). Default is to open fallbacks.
942
_found is a private parameter, do not use it. It is used to indicate
943
if format probing has already be done.
1385
945
raise NotImplementedError(self.open)
1388
948
def register_format(klass, format):
1389
"""Register a metadir format."""
1390
949
klass._formats[format.get_format_string()] = format
1391
# Metadir formats have a network name of their format string, and get
1392
# registered as class factories.
1393
network_format_registry.register(format.get_format_string(), format.__class__)
1396
952
def set_default_format(klass, format):
1397
953
klass._default_format = format
1399
def supports_stacking(self):
1400
"""True if this format records a stacked-on branch."""
1404
956
def unregister_format(klass, format):
957
assert klass._formats[format.get_format_string()] is format
1405
958
del klass._formats[format.get_format_string()]
1407
960
def __str__(self):
1408
return self.get_format_description().rstrip()
961
return self.get_format_string().rstrip()
1410
963
def supports_tags(self):
1411
964
"""True if this format supports tags stored in the branch"""
1412
965
return False # by default
967
# XXX: Probably doesn't really belong here -- mbp 20070212
968
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
970
branch_transport = a_bzrdir.get_branch_transport(self)
971
control_files = lockable_files.LockableFiles(branch_transport,
972
lock_filename, lock_class)
973
control_files.create_lock()
974
control_files.lock_write()
976
for filename, content in utf8_files:
977
control_files.put_utf8(filename, content)
979
control_files.unlock()
1415
982
class BranchHooks(Hooks):
1416
983
"""A dictionary mapping hook name to a list of callables for branch hooks.
1418
985
e.g. ['set_rh'] Is the list of items to be called when the
1419
986
set_revision_history function is invoked.
1428
995
Hooks.__init__(self)
1429
self.create_hook(HookPoint('set_rh',
1430
"Invoked whenever the revision history has been set via "
1431
"set_revision_history. The api signature is (branch, "
1432
"revision_history), and the branch will be write-locked. "
1433
"The set_rh hook can be expensive for bzr to trigger, a better "
1434
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1435
self.create_hook(HookPoint('open',
1436
"Called with the Branch object that has been opened after a "
1437
"branch is opened.", (1, 8), None))
1438
self.create_hook(HookPoint('post_push',
1439
"Called after a push operation completes. post_push is called "
1440
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1441
"bzr client.", (0, 15), None))
1442
self.create_hook(HookPoint('post_pull',
1443
"Called after a pull operation completes. post_pull is called "
1444
"with a bzrlib.branch.PullResult object and only runs in the "
1445
"bzr client.", (0, 15), None))
1446
self.create_hook(HookPoint('pre_commit',
1447
"Called after a commit is calculated but before it is is "
1448
"completed. pre_commit is called with (local, master, old_revno, "
1449
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1450
"). old_revid is NULL_REVISION for the first commit to a branch, "
1451
"tree_delta is a TreeDelta object describing changes from the "
1452
"basis revision. hooks MUST NOT modify this delta. "
1453
" future_tree is an in-memory tree obtained from "
1454
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1455
"tree.", (0,91), None))
1456
self.create_hook(HookPoint('post_commit',
1457
"Called in the bzr client after a commit has completed. "
1458
"post_commit is called with (local, master, old_revno, old_revid, "
1459
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1460
"commit to a branch.", (0, 15), None))
1461
self.create_hook(HookPoint('post_uncommit',
1462
"Called in the bzr client after an uncommit completes. "
1463
"post_uncommit is called with (local, master, old_revno, "
1464
"old_revid, new_revno, new_revid) where local is the local branch "
1465
"or None, master is the target branch, and an empty branch "
1466
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1467
self.create_hook(HookPoint('pre_change_branch_tip',
1468
"Called in bzr client and server before a change to the tip of a "
1469
"branch is made. pre_change_branch_tip is called with a "
1470
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1471
"commit, uncommit will all trigger this hook.", (1, 6), None))
1472
self.create_hook(HookPoint('post_change_branch_tip',
1473
"Called in bzr client and server after a change to the tip of a "
1474
"branch is made. post_change_branch_tip is called with a "
1475
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1476
"commit, uncommit will all trigger this hook.", (1, 4), None))
1477
self.create_hook(HookPoint('transform_fallback_location',
1478
"Called when a stacked branch is activating its fallback "
1479
"locations. transform_fallback_location is called with (branch, "
1480
"url), and should return a new url. Returning the same url "
1481
"allows it to be used as-is, returning a different one can be "
1482
"used to cause the branch to stack on a closer copy of that "
1483
"fallback_location. Note that the branch cannot have history "
1484
"accessing methods called on it during this hook because the "
1485
"fallback locations have not been activated. When there are "
1486
"multiple hooks installed for transform_fallback_location, "
1487
"all are called with the url returned from the previous hook."
1488
"The order is however undefined.", (1, 9), None))
996
# Introduced in 0.15:
997
# invoked whenever the revision history has been set
998
# with set_revision_history. The api signature is
999
# (branch, revision_history), and the branch will
1002
# invoked after a push operation completes.
1003
# the api signature is
1005
# containing the members
1006
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1007
# where local is the local target branch or None, master is the target
1008
# master branch, and the rest should be self explanatory. The source
1009
# is read locked and the target branches write locked. Source will
1010
# be the local low-latency branch.
1011
self['post_push'] = []
1012
# invoked after a pull operation completes.
1013
# the api signature is
1015
# containing the members
1016
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1017
# where local is the local branch or None, master is the target
1018
# master branch, and the rest should be self explanatory. The source
1019
# is read locked and the target branches write locked. The local
1020
# branch is the low-latency branch.
1021
self['post_pull'] = []
1022
# invoked after a commit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid)
1025
# old_revid is NULL_REVISION for the first commit to a branch.
1026
self['post_commit'] = []
1027
# invoked after a uncommit operation completes.
1028
# the api signature is
1029
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1030
# local is the local branch or None, master is the target branch,
1031
# and an empty branch recieves new_revno of 0, new_revid of None.
1032
self['post_uncommit'] = []
1491
1035
# install the default hooks into the Branch class.
1492
1036
Branch.hooks = BranchHooks()
1495
class ChangeBranchTipParams(object):
1496
"""Object holding parameters passed to *_change_branch_tip hooks.
1498
There are 5 fields that hooks may wish to access:
1500
:ivar branch: the branch being changed
1501
:ivar old_revno: revision number before the change
1502
:ivar new_revno: revision number after the change
1503
:ivar old_revid: revision id before the change
1504
:ivar new_revid: revision id after the change
1506
The revid fields are strings. The revno fields are integers.
1509
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1510
"""Create a group of ChangeBranchTip parameters.
1512
:param branch: The branch being changed.
1513
:param old_revno: Revision number before the change.
1514
:param new_revno: Revision number after the change.
1515
:param old_revid: Tip revision id before the change.
1516
:param new_revid: Tip revision id after the change.
1518
self.branch = branch
1519
self.old_revno = old_revno
1520
self.new_revno = new_revno
1521
self.old_revid = old_revid
1522
self.new_revid = new_revid
1524
def __eq__(self, other):
1525
return self.__dict__ == other.__dict__
1528
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1529
self.__class__.__name__, self.branch,
1530
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1533
1039
class BzrBranchFormat4(BranchFormat):
1534
1040
"""Bzr branch format 4.
1572
1078
return "Bazaar-NG branch format 4"
1575
class BranchFormatMetadir(BranchFormat):
1576
"""Common logic for meta-dir based branch formats."""
1578
def _branch_class(self):
1579
"""What class to instantiate on open calls."""
1580
raise NotImplementedError(self._branch_class)
1582
def network_name(self):
1583
"""A simple byte string uniquely identifying this format for RPC calls.
1585
Metadir branch formats use their format string.
1081
class BzrBranchFormat5(BranchFormat):
1082
"""Bzr branch format 5.
1085
- a revision-history file.
1087
- a lock dir guarding the branch itself
1088
- all of this stored in a branch/ subdirectory
1089
- works with shared repositories.
1091
This format is new in bzr 0.8.
1094
def get_format_string(self):
1095
"""See BranchFormat.get_format_string()."""
1096
return "Bazaar-NG branch format 5\n"
1098
def get_format_description(self):
1099
"""See BranchFormat.get_format_description()."""
1100
return "Branch format 5"
1102
def initialize(self, a_bzrdir):
1103
"""Create a branch of this format in a_bzrdir."""
1104
utf8_files = [('revision-history', ''),
1105
('branch-name', ''),
1107
return self._initialize_helper(a_bzrdir, utf8_files)
1110
super(BzrBranchFormat5, self).__init__()
1111
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1113
def open(self, a_bzrdir, _found=False):
1114
"""Return the branch object for a_bzrdir
1116
_found is a private parameter, do not use it. It is used to indicate
1117
if format probing has already be done.
1587
return self.get_format_string()
1589
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1590
"""See BranchFormat.open()."""
1592
1120
format = BranchFormat.find_format(a_bzrdir)
1593
if format.__class__ != self.__class__:
1594
raise AssertionError("wrong format %r found for %r" %
1121
assert format.__class__ == self.__class__
1597
1123
transport = a_bzrdir.get_branch_transport(None)
1598
1124
control_files = lockable_files.LockableFiles(transport, 'lock',
1599
1125
lockdir.LockDir)
1600
return self._branch_class()(_format=self,
1126
return BzrBranch5(_format=self,
1601
1127
_control_files=control_files,
1602
1128
a_bzrdir=a_bzrdir,
1603
_repository=a_bzrdir.find_repository(),
1604
ignore_fallbacks=ignore_fallbacks)
1605
except errors.NoSuchFile:
1606
raise errors.NotBranchError(path=transport.base)
1609
super(BranchFormatMetadir, self).__init__()
1610
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1611
self._matchingbzrdir.set_branch_format(self)
1613
def supports_tags(self):
1617
class BzrBranchFormat5(BranchFormatMetadir):
1618
"""Bzr branch format 5.
1621
- a revision-history file.
1623
- a lock dir guarding the branch itself
1624
- all of this stored in a branch/ subdirectory
1625
- works with shared repositories.
1627
This format is new in bzr 0.8.
1630
def _branch_class(self):
1633
def get_format_string(self):
1634
"""See BranchFormat.get_format_string()."""
1635
return "Bazaar-NG branch format 5\n"
1637
def get_format_description(self):
1638
"""See BranchFormat.get_format_description()."""
1639
return "Branch format 5"
1641
def initialize(self, a_bzrdir):
1642
"""Create a branch of this format in a_bzrdir."""
1643
utf8_files = [('revision-history', ''),
1644
('branch-name', ''),
1646
return self._initialize_helper(a_bzrdir, utf8_files)
1648
def supports_tags(self):
1652
class BzrBranchFormat6(BranchFormatMetadir):
1653
"""Branch format with last-revision and tags.
1129
_repository=a_bzrdir.find_repository())
1131
raise NotBranchError(path=transport.base)
1134
class BzrBranchFormat6(BzrBranchFormat5):
1135
"""Branch format with last-revision
1655
1137
Unlike previous formats, this has no explicit revision history. Instead,
1656
1138
this just stores the last-revision, and the left-hand history leading
1657
1139
up to there is the history.
1659
1141
This format was introduced in bzr 0.15
1660
and became the default in 0.91.
1663
def _branch_class(self):
1666
1144
def get_format_string(self):
1667
1145
"""See BranchFormat.get_format_string()."""
1668
1146
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1674
1152
def initialize(self, a_bzrdir):
1675
1153
"""Create a branch of this format in a_bzrdir."""
1676
1154
utf8_files = [('last-revision', '0 null:\n'),
1677
('branch.conf', ''),
1680
return self._initialize_helper(a_bzrdir, utf8_files)
1682
def make_tags(self, branch):
1683
"""See bzrlib.branch.BranchFormat.make_tags()."""
1684
return BasicTags(branch)
1688
class BzrBranchFormat7(BranchFormatMetadir):
1689
"""Branch format with last-revision, tags, and a stacked location pointer.
1691
The stacked location pointer is passed down to the repository and requires
1692
a repository format with supports_external_lookups = True.
1694
This format was introduced in bzr 1.6.
1697
def _branch_class(self):
1700
def get_format_string(self):
1701
"""See BranchFormat.get_format_string()."""
1702
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1704
def get_format_description(self):
1705
"""See BranchFormat.get_format_description()."""
1706
return "Branch format 7"
1708
def initialize(self, a_bzrdir):
1709
"""Create a branch of this format in a_bzrdir."""
1710
utf8_files = [('last-revision', '0 null:\n'),
1711
('branch.conf', ''),
1714
return self._initialize_helper(a_bzrdir, utf8_files)
1717
super(BzrBranchFormat7, self).__init__()
1718
self._matchingbzrdir.repository_format = \
1719
RepositoryFormatKnitPack5RichRoot()
1721
def make_tags(self, branch):
1722
"""See bzrlib.branch.BranchFormat.make_tags()."""
1723
return BasicTags(branch)
1725
def supports_stacking(self):
1155
('branch-name', ''),
1156
('branch.conf', ''),
1159
return self._initialize_helper(a_bzrdir, utf8_files)
1161
def open(self, a_bzrdir, _found=False):
1162
"""Return the branch object for a_bzrdir
1164
_found is a private parameter, do not use it. It is used to indicate
1165
if format probing has already be done.
1168
format = BranchFormat.find_format(a_bzrdir)
1169
assert format.__class__ == self.__class__
1170
transport = a_bzrdir.get_branch_transport(None)
1171
control_files = lockable_files.LockableFiles(transport, 'lock',
1173
return BzrBranch6(_format=self,
1174
_control_files=control_files,
1176
_repository=a_bzrdir.find_repository())
1178
def supports_tags(self):
1786
1230
# emit some sort of warning/error to the caller ?!
1789
def open(self, a_bzrdir, _found=False, location=None,
1790
possible_transports=None, ignore_fallbacks=False):
1233
def open(self, a_bzrdir, _found=False, location=None):
1791
1234
"""Return the branch that the branch reference in a_bzrdir points at.
1793
:param a_bzrdir: A BzrDir that contains a branch.
1794
:param _found: a private parameter, do not use it. It is used to
1795
indicate if format probing has already be done.
1796
:param ignore_fallbacks: when set, no fallback branches will be opened
1797
(if there are any). Default is to open fallbacks.
1798
:param location: The location of the referenced branch. If
1799
unspecified, this will be determined from the branch reference in
1801
:param possible_transports: An optional reusable transports list.
1236
_found is a private parameter, do not use it. It is used to indicate
1237
if format probing has already be done.
1804
1240
format = BranchFormat.find_format(a_bzrdir)
1805
if format.__class__ != self.__class__:
1806
raise AssertionError("wrong format %r found for %r" %
1241
assert format.__class__ == self.__class__
1808
1242
if location is None:
1809
1243
location = self.get_reference(a_bzrdir)
1810
real_bzrdir = bzrdir.BzrDir.open(
1811
location, possible_transports=possible_transports)
1812
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1244
real_bzrdir = bzrdir.BzrDir.open(location)
1245
result = real_bzrdir.open_branch()
1813
1246
# this changes the behaviour of result.clone to create a new reference
1814
1247
# rather than a copy of the content of the branch.
1815
1248
# I did not use a proxy object because that needs much more extensive
1853
1271
Note that it's "local" in the context of the filesystem; it doesn't
1854
1272
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1855
1273
it's writable, and can be accessed via the normal filesystem API.
1857
:ivar _transport: Transport for file operations on this branch's
1858
control files, typically pointing to the .bzr/branch directory.
1859
:ivar repository: Repository for this branch.
1860
:ivar base: The url of the base directory for this branch; the one
1861
containing the .bzr directory.
1864
1276
def __init__(self, _format=None,
1865
_control_files=None, a_bzrdir=None, _repository=None,
1866
ignore_fallbacks=False):
1277
_control_files=None, a_bzrdir=None, _repository=None):
1867
1278
"""Create new branch object at a particular location."""
1279
Branch.__init__(self)
1868
1280
if a_bzrdir is None:
1869
1281
raise ValueError('a_bzrdir must be supplied')
1871
1283
self.bzrdir = a_bzrdir
1284
# self._transport used to point to the directory containing the
1285
# control directory, but was not used - now it's just the transport
1286
# for the branch control files. mbp 20070212
1872
1287
self._base = self.bzrdir.transport.clone('..').base
1873
# XXX: We should be able to just do
1874
# self.base = self.bzrdir.root_transport.base
1875
# but this does not quite work yet -- mbp 20080522
1876
1288
self._format = _format
1877
1289
if _control_files is None:
1878
1290
raise ValueError('BzrBranch _control_files is None')
1879
1291
self.control_files = _control_files
1880
1292
self._transport = _control_files._transport
1881
1293
self.repository = _repository
1882
Branch.__init__(self)
1884
1295
def __str__(self):
1885
1296
return '%s(%r)' % (self.__class__.__name__, self.base)
1939
1359
"""See Branch.print_file."""
1940
1360
return self.repository.print_file(file, revision_id)
1363
def append_revision(self, *revision_ids):
1364
"""See Branch.append_revision."""
1365
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1366
for revision_id in revision_ids:
1367
_mod_revision.check_not_reserved_id(revision_id)
1368
mutter("add {%s} to revision-history" % revision_id)
1369
rev_history = self.revision_history()
1370
rev_history.extend(revision_ids)
1371
self.set_revision_history(rev_history)
1942
1373
def _write_revision_history(self, history):
1943
1374
"""Factored out of set_revision_history.
1945
1376
This performs the actual writing to disk.
1946
1377
It is intended to be called by BzrBranch5.set_revision_history."""
1947
self._transport.put_bytes(
1948
'revision-history', '\n'.join(history),
1949
mode=self.bzrdir._get_file_mode())
1378
self.control_files.put_bytes(
1379
'revision-history', '\n'.join(history))
1951
1381
@needs_write_lock
1952
1382
def set_revision_history(self, rev_history):
1953
1383
"""See Branch.set_revision_history."""
1954
if 'evil' in debug.debug_flags:
1955
mutter_callsite(3, "set_revision_history scales with history.")
1956
check_not_reserved_id = _mod_revision.check_not_reserved_id
1957
for rev_id in rev_history:
1958
check_not_reserved_id(rev_id)
1959
if Branch.hooks['post_change_branch_tip']:
1960
# Don't calculate the last_revision_info() if there are no hooks
1962
old_revno, old_revid = self.last_revision_info()
1963
if len(rev_history) == 0:
1964
revid = _mod_revision.NULL_REVISION
1966
revid = rev_history[-1]
1967
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1384
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1385
self._clear_cached_state()
1968
1386
self._write_revision_history(rev_history)
1969
self._clear_cached_state()
1970
1387
self._cache_revision_history(rev_history)
1971
1388
for hook in Branch.hooks['set_rh']:
1972
1389
hook(self, rev_history)
1973
if Branch.hooks['post_change_branch_tip']:
1974
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1976
def _synchronize_history(self, destination, revision_id):
1977
"""Synchronize last revision and revision history between branches.
1979
This version is most efficient when the destination is also a
1980
BzrBranch5, but works for BzrBranch6 as long as the revision
1981
history is the true lefthand parent history, and all of the revisions
1982
are in the destination's repository. If not, set_revision_history
1985
:param destination: The branch to copy the history into
1986
:param revision_id: The revision-id to truncate history at. May
1987
be None to copy complete history.
1989
if not isinstance(destination._format, BzrBranchFormat5):
1990
super(BzrBranch, self)._synchronize_history(
1991
destination, revision_id)
1993
if revision_id == _mod_revision.NULL_REVISION:
1996
new_history = self.revision_history()
1997
if revision_id is not None and new_history != []:
1999
new_history = new_history[:new_history.index(revision_id) + 1]
2001
rev = self.repository.get_revision(revision_id)
2002
new_history = rev.get_history(self.repository)[1:]
2003
destination.set_revision_history(new_history)
2005
1391
@needs_write_lock
2006
1392
def set_last_revision_info(self, revno, revision_id):
2007
"""Set the last revision of this branch.
2009
The caller is responsible for checking that the revno is correct
2010
for this revision id.
2012
It may be possible to set the branch last revision to an id not
2013
present in the repository. However, branches can also be
2014
configured to check constraints on history, in which case this may not
2017
revision_id = _mod_revision.ensure_null(revision_id)
2018
# this old format stores the full history, but this api doesn't
2019
# provide it, so we must generate, and might as well check it's
1393
revision_id = osutils.safe_revision_id(revision_id)
2021
1394
history = self._lefthand_history(revision_id)
2022
if len(history) != revno:
2023
raise AssertionError('%d != %d' % (len(history), revno))
1395
assert len(history) == revno, '%d != %d' % (len(history), revno)
2024
1396
self.set_revision_history(history)
2026
1398
def _gen_revision_history(self):
2027
history = self._transport.get_bytes('revision-history').split('\n')
1399
history = self.control_files.get('revision-history').read().split('\n')
2028
1400
if history[-1:] == ['']:
2029
1401
# There shouldn't be a trailing newline, but just in case.
1405
def _lefthand_history(self, revision_id, last_rev=None,
1407
# stop_revision must be a descendant of last_revision
1408
stop_graph = self.repository.get_revision_graph(revision_id)
1409
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1410
and last_rev not in stop_graph):
1411
# our previous tip is not merged into stop_revision
1412
raise errors.DivergedBranches(self, other_branch)
1413
# make a new revision history from the graph
1414
current_rev_id = revision_id
1416
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1417
new_history.append(current_rev_id)
1418
current_rev_id_parents = stop_graph[current_rev_id]
1420
current_rev_id = current_rev_id_parents[0]
1422
current_rev_id = None
1423
new_history.reverse()
2033
1426
@needs_write_lock
2034
1427
def generate_revision_history(self, revision_id, last_rev=None,
2035
1428
other_branch=None):
2041
1434
:param other_branch: The other branch that DivergedBranches should
2042
1435
raise with respect to.
1437
revision_id = osutils.safe_revision_id(revision_id)
2044
1438
self.set_revision_history(self._lefthand_history(revision_id,
2045
1439
last_rev, other_branch))
1442
def update_revisions(self, other, stop_revision=None):
1443
"""See Branch.update_revisions."""
1446
if stop_revision is None:
1447
stop_revision = other.last_revision()
1448
if stop_revision is None:
1449
# if there are no commits, we're done.
1452
stop_revision = osutils.safe_revision_id(stop_revision)
1453
# whats the current last revision, before we fetch [and change it
1455
last_rev = _mod_revision.ensure_null(self.last_revision())
1456
# we fetch here regardless of whether we need to so that we pickup
1458
self.fetch(other, stop_revision)
1459
my_ancestry = self.repository.get_ancestry(last_rev,
1461
if stop_revision in my_ancestry:
1462
# last_revision is a descendant of stop_revision
1464
self.generate_revision_history(stop_revision, last_rev=last_rev,
2047
1469
def basis_tree(self):
2048
1470
"""See Branch.basis_tree."""
2049
1471
return self.repository.revision_tree(self.last_revision())
1473
@deprecated_method(zero_eight)
1474
def working_tree(self):
1475
"""Create a Working tree object for this branch."""
1477
from bzrlib.transport.local import LocalTransport
1478
if (self.base.find('://') != -1 or
1479
not isinstance(self._transport, LocalTransport)):
1480
raise NoWorkingTree(self.base)
1481
return self.bzrdir.open_workingtree()
2051
1483
@needs_write_lock
2052
1484
def pull(self, source, overwrite=False, stop_revision=None,
2053
_hook_master=None, run_hooks=True, possible_transports=None,
2054
_override_hook_target=None):
1485
_hook_master=None, run_hooks=True):
2055
1486
"""See Branch.pull.
2057
:param _hook_master: Private parameter - set the branch to
2058
be supplied as the master to pull hooks.
1488
:param _hook_master: Private parameter - set the branch to
1489
be supplied as the master to push hooks.
2059
1490
:param run_hooks: Private parameter - if false, this branch
2060
1491
is being called because it's the master of the primary branch,
2061
1492
so it should not run its hooks.
2062
:param _override_hook_target: Private parameter - set the branch to be
2063
supplied as the target_branch to pull hooks.
2065
1494
result = PullResult()
2066
1495
result.source_branch = source
2067
if _override_hook_target is None:
2068
result.target_branch = self
2070
result.target_branch = _override_hook_target
1496
result.target_branch = self
2071
1497
source.lock_read()
2073
# We assume that during 'pull' the local repository is closer than
2075
graph = self.repository.get_graph(source.repository)
2076
1499
result.old_revno, result.old_revid = self.last_revision_info()
2077
self.update_revisions(source, stop_revision, overwrite=overwrite,
2079
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1501
self.update_revisions(source, stop_revision)
1502
except DivergedBranches:
1506
if stop_revision is None:
1507
stop_revision = source.last_revision()
1508
self.generate_revision_history(stop_revision)
1509
result.tag_conflicts = source.tags.merge_to(self.tags)
2080
1510
result.new_revno, result.new_revid = self.last_revision_info()
2081
1511
if _hook_master:
2082
1512
result.master_branch = _hook_master
2083
result.local_branch = result.target_branch
1513
result.local_branch = self
2085
result.master_branch = result.target_branch
1515
result.master_branch = self
2086
1516
result.local_branch = None
2088
1518
for hook in Branch.hooks['post_pull']:
2171
1605
Must be called with self read locked and target write locked.
2173
result = BranchPushResult()
1607
result = PushResult()
2174
1608
result.source_branch = self
2175
1609
result.target_branch = target
2176
1610
result.old_revno, result.old_revid = target.last_revision_info()
2177
if result.old_revid != self.last_revision():
2178
# We assume that during 'push' this repository is closer than
2180
graph = self.repository.get_graph(target.repository)
2181
target.update_revisions(self, stop_revision, overwrite=overwrite,
2183
if self._push_should_merge_tags():
2184
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1612
target.update_revisions(self, stop_revision)
1613
except DivergedBranches:
1617
target.set_revision_history(self.revision_history())
1618
result.tag_conflicts = self.tags.merge_to(target.tags)
2185
1619
result.new_revno, result.new_revid = target.last_revision_info()
2188
def get_stacked_on_url(self):
2189
raise errors.UnstackableBranchFormat(self._format, self.base)
1622
def get_parent(self):
1623
"""See Branch.get_parent."""
1625
assert self.base[-1] == '/'
1626
parent = self._get_parent_location()
1629
# This is an old-format absolute path to a local branch
1630
# turn it into a url
1631
if parent.startswith('/'):
1632
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1634
return urlutils.join(self.base[:-1], parent)
1635
except errors.InvalidURLJoin, e:
1636
raise errors.InaccessibleParent(parent, self.base)
2191
1638
def set_push_location(self, location):
2192
1639
"""See Branch.set_push_location."""
2215
1663
def _set_parent_location(self, url):
2216
1664
if url is None:
2217
self._transport.delete('parent')
1665
self.control_files._transport.delete('parent')
2219
self._transport.put_bytes('parent', url + '\n',
2220
mode=self.bzrdir._get_file_mode())
1667
assert isinstance(url, str)
1668
self.control_files.put_bytes('parent', url + '\n')
1670
@deprecated_function(zero_nine)
1671
def tree_config(self):
1672
"""DEPRECATED; call get_config instead.
1673
TreeConfig has become part of BranchConfig."""
1674
return TreeConfig(self)
2223
1677
class BzrBranch5(BzrBranch):
2224
"""A format 5 branch. This supports new features over plain branches.
1678
"""A format 5 branch. This supports new features over plan branches.
2226
1680
It has support for a master_branch which is the data for bound branches.
1688
super(BzrBranch5, self).__init__(_format=_format,
1689
_control_files=_control_files,
1691
_repository=_repository)
2229
1693
@needs_write_lock
2230
1694
def pull(self, source, overwrite=False, stop_revision=None,
2231
run_hooks=True, possible_transports=None,
2232
_override_hook_target=None):
2233
1696
"""Pull from source into self, updating my master if any.
2235
1698
:param run_hooks: Private parameter - if false, this branch
2236
1699
is being called because it's the master of the primary branch,
2237
1700
so it should not run its hooks.
2330
1806
return self.set_bound_location(None)
2332
1808
@needs_write_lock
2333
def update(self, possible_transports=None):
2334
"""Synchronise this branch with the master branch if any.
1810
"""Synchronise this branch with the master branch if any.
2336
1812
:return: None or the last_revision that was pivoted out during the
2339
master = self.get_master_branch(possible_transports)
1815
master = self.get_master_branch()
2340
1816
if master is not None:
2341
old_tip = _mod_revision.ensure_null(self.last_revision())
1817
old_tip = self.last_revision()
2342
1818
self.pull(master, overwrite=True)
2343
if self.repository.get_graph().is_ancestor(old_tip,
2344
_mod_revision.ensure_null(self.last_revision())):
1819
if old_tip in self.repository.get_ancestry(
1820
_mod_revision.ensure_null(self.last_revision()),
2350
class BzrBranch7(BzrBranch5):
2351
"""A branch with support for a fallback repository."""
2353
def _open_hook(self):
2354
if self._ignore_fallbacks:
1827
class BzrBranchExperimental(BzrBranch5):
1828
"""Bzr experimental branch format
1831
- a revision-history file.
1833
- a lock dir guarding the branch itself
1834
- all of this stored in a branch/ subdirectory
1835
- works with shared repositories.
1836
- a tag dictionary in the branch
1838
This format is new in bzr 0.15, but shouldn't be used for real data,
1841
This class acts as it's own BranchFormat.
1844
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1847
def get_format_string(cls):
1848
"""See BranchFormat.get_format_string()."""
1849
return "Bazaar-NG branch format experimental\n"
1852
def get_format_description(cls):
1853
"""See BranchFormat.get_format_description()."""
1854
return "Experimental branch format"
1857
def get_reference(cls, a_bzrdir):
1858
"""Get the target reference of the branch in a_bzrdir.
1860
format probing must have been completed before calling
1861
this method - it is assumed that the format of the branch
1862
in a_bzrdir is correct.
1864
:param a_bzrdir: The bzrdir to get the branch data from.
1865
:return: None if the branch is not a reference branch.
1870
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1872
branch_transport = a_bzrdir.get_branch_transport(cls)
1873
control_files = lockable_files.LockableFiles(branch_transport,
1874
lock_filename, lock_class)
1875
control_files.create_lock()
1876
control_files.lock_write()
2357
url = self.get_stacked_on_url()
2358
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2359
errors.UnstackableBranchFormat):
2362
for hook in Branch.hooks['transform_fallback_location']:
2363
url = hook(self, url)
2365
hook_name = Branch.hooks.get_hook_name(hook)
2366
raise AssertionError(
2367
"'transform_fallback_location' hook %s returned "
2368
"None, not a URL." % hook_name)
2369
self._activate_fallback_location(url)
2371
def __init__(self, *args, **kwargs):
2372
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2373
super(BzrBranch7, self).__init__(*args, **kwargs)
2374
self._last_revision_info_cache = None
2375
self._partial_revision_history_cache = []
2377
def _clear_cached_state(self):
2378
super(BzrBranch7, self)._clear_cached_state()
2379
self._last_revision_info_cache = None
2380
self._partial_revision_history_cache = []
2382
def _last_revision_info(self):
2383
revision_string = self._transport.get_bytes('last-revision')
1878
for filename, content in utf8_files:
1879
control_files.put_utf8(filename, content)
1881
control_files.unlock()
1884
def initialize(cls, a_bzrdir):
1885
"""Create a branch of this format in a_bzrdir."""
1886
utf8_files = [('format', cls.get_format_string()),
1887
('revision-history', ''),
1888
('branch-name', ''),
1891
cls._initialize_control_files(a_bzrdir, utf8_files,
1892
'lock', lockdir.LockDir)
1893
return cls.open(a_bzrdir, _found=True)
1896
def open(cls, a_bzrdir, _found=False):
1897
"""Return the branch object for a_bzrdir
1899
_found is a private parameter, do not use it. It is used to indicate
1900
if format probing has already be done.
1903
format = BranchFormat.find_format(a_bzrdir)
1904
assert format.__class__ == cls
1905
transport = a_bzrdir.get_branch_transport(None)
1906
control_files = lockable_files.LockableFiles(transport, 'lock',
1908
return cls(_format=cls,
1909
_control_files=control_files,
1911
_repository=a_bzrdir.find_repository())
1914
def is_supported(cls):
1917
def _make_tags(self):
1918
return BasicTags(self)
1921
def supports_tags(cls):
1925
BranchFormat.register_format(BzrBranchExperimental)
1928
class BzrBranch6(BzrBranch5):
1931
def last_revision_info(self):
1932
revision_string = self.control_files.get('last-revision').read()
2384
1933
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2385
1934
revision_id = cache_utf8.get_cached_utf8(revision_id)
2386
1935
revno = int(revno)
2387
1936
return revno, revision_id
1938
def last_revision(self):
1939
"""Return last revision id, or None"""
1940
revision_id = self.last_revision_info()[1]
1941
if revision_id == _mod_revision.NULL_REVISION:
2389
1945
def _write_last_revision_info(self, revno, revision_id):
2390
1946
"""Simply write out the revision id, with no checks.
2395
1951
Intended to be called by set_last_revision_info and
2396
1952
_write_revision_history.
2398
revision_id = _mod_revision.ensure_null(revision_id)
1954
if revision_id is None:
1955
revision_id = 'null:'
2399
1956
out_string = '%d %s\n' % (revno, revision_id)
2400
self._transport.put_bytes('last-revision', out_string,
2401
mode=self.bzrdir._get_file_mode())
1957
self.control_files.put_bytes('last-revision', out_string)
2403
1959
@needs_write_lock
2404
1960
def set_last_revision_info(self, revno, revision_id):
2405
revision_id = _mod_revision.ensure_null(revision_id)
2406
old_revno, old_revid = self.last_revision_info()
1961
revision_id = osutils.safe_revision_id(revision_id)
2407
1962
if self._get_append_revisions_only():
2408
1963
self._check_history_violation(revision_id)
2409
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2410
1964
self._write_last_revision_info(revno, revision_id)
2411
1965
self._clear_cached_state()
2412
self._last_revision_info_cache = revno, revision_id
2413
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2415
def _synchronize_history(self, destination, revision_id):
2416
"""Synchronize last revision and revision history between branches.
2418
:see: Branch._synchronize_history
2420
# XXX: The base Branch has a fast implementation of this method based
2421
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2422
# that uses set_revision_history. This class inherits from BzrBranch5,
2423
# but wants the fast implementation, so it calls
2424
# Branch._synchronize_history directly.
2425
Branch._synchronize_history(self, destination, revision_id)
2427
1967
def _check_history_violation(self, revision_id):
2428
1968
last_revision = _mod_revision.ensure_null(self.last_revision())
2434
1974
def _gen_revision_history(self):
2435
1975
"""Generate the revision history from last revision
2437
last_revno, last_revision = self.last_revision_info()
2438
self._extend_partial_history(stop_index=last_revno-1)
2439
return list(reversed(self._partial_revision_history_cache))
2441
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2442
"""Extend the partial history to include a given index
2444
If a stop_index is supplied, stop when that index has been reached.
2445
If a stop_revision is supplied, stop when that revision is
2446
encountered. Otherwise, stop when the beginning of history is
2449
:param stop_index: The index which should be present. When it is
2450
present, history extension will stop.
2451
:param revision_id: The revision id which should be present. When
2452
it is encountered, history extension will stop.
2454
repo = self.repository
2455
if len(self._partial_revision_history_cache) == 0:
2456
iterator = repo.iter_reverse_revision_history(self.last_revision())
2458
start_revision = self._partial_revision_history_cache[-1]
2459
iterator = repo.iter_reverse_revision_history(start_revision)
2460
#skip the last revision in the list
2461
next_revision = iterator.next()
2462
for revision_id in iterator:
2463
self._partial_revision_history_cache.append(revision_id)
2464
if (stop_index is not None and
2465
len(self._partial_revision_history_cache) > stop_index):
2467
if revision_id == stop_revision:
1977
history = list(self.repository.iter_reverse_revision_history(
1978
self.last_revision()))
2470
1982
def _write_revision_history(self, history):
2471
1983
"""Factored out of set_revision_history.
2552
2074
value = self.get_config().get_user_option('append_revisions_only')
2553
2075
return value == 'True'
2556
def generate_revision_history(self, revision_id, last_rev=None,
2558
"""See BzrBranch5.generate_revision_history"""
2559
history = self._lefthand_history(revision_id, last_rev, other_branch)
2560
revno = len(history)
2561
self.set_last_revision_info(revno, revision_id)
2564
def get_rev_id(self, revno, history=None):
2565
"""Find the revision id of the specified revno."""
2567
return _mod_revision.NULL_REVISION
2569
last_revno, last_revision_id = self.last_revision_info()
2570
if revno <= 0 or revno > last_revno:
2571
raise errors.NoSuchRevision(self, revno)
2573
if history is not None:
2574
return history[revno - 1]
2576
index = last_revno - revno
2577
if len(self._partial_revision_history_cache) <= index:
2578
self._extend_partial_history(stop_index=index)
2579
if len(self._partial_revision_history_cache) > index:
2580
return self._partial_revision_history_cache[index]
2077
def _synchronize_history(self, destination, revision_id):
2078
"""Synchronize last revision and revision history between branches.
2080
This version is most efficient when the destination is also a
2081
BzrBranch6, but works for BzrBranch5, as long as the destination's
2082
repository contains all the lefthand ancestors of the intended
2083
last_revision. If not, set_last_revision_info will fail.
2085
:param destination: The branch to copy the history into
2086
:param revision_id: The revision-id to truncate history at. May
2087
be None to copy complete history.
2089
if revision_id is None:
2090
revno, revision_id = self.last_revision_info()
2582
raise errors.NoSuchRevision(self, revno)
2585
def revision_id_to_revno(self, revision_id):
2586
"""Given a revision id, return its revno"""
2587
if _mod_revision.is_null(revision_id):
2590
index = self._partial_revision_history_cache.index(revision_id)
2592
self._extend_partial_history(stop_revision=revision_id)
2593
index = len(self._partial_revision_history_cache) - 1
2594
if self._partial_revision_history_cache[index] != revision_id:
2595
raise errors.NoSuchRevision(self, revision_id)
2596
return self.revno() - index
2599
class BzrBranch6(BzrBranch7):
2600
"""See BzrBranchFormat6 for the capabilities of this branch.
2602
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2606
def get_stacked_on_url(self):
2607
raise errors.UnstackableBranchFormat(self._format, self.base)
2092
# To figure out the revno for a random revision, we need to build
2093
# the revision history, and count its length.
2094
# We don't care about the order, just how long it is.
2095
# Alternatively, we could start at the current location, and count
2096
# backwards. But there is no guarantee that we will find it since
2097
# it may be a merged revision.
2098
revno = len(list(self.repository.iter_reverse_revision_history(
2100
destination.set_last_revision_info(revno, revision_id)
2102
def _make_tags(self):
2103
return BasicTags(self)
2610
2106
######################################################################
2641
2134
return self.new_revno - self.old_revno
2643
2136
def report(self, to_file):
2645
if self.old_revid == self.new_revid:
2646
to_file.write('No revisions to pull.\n')
2648
to_file.write('Now on revision %d.\n' % self.new_revno)
2137
if self.old_revid == self.new_revid:
2138
to_file.write('No revisions to pull.\n')
2140
to_file.write('Now on revision %d.\n' % self.new_revno)
2649
2141
self._show_tag_conficts(to_file)
2652
class BranchPushResult(_Result):
2144
class PushResult(_Result):
2653
2145
"""Result of a Branch.push operation.
2655
:ivar old_revno: Revision number (eg 10) of the target before push.
2656
:ivar new_revno: Revision number (eg 12) of the target after push.
2657
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2659
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2661
:ivar source_branch: Source branch object that the push was from. This is
2662
read locked, and generally is a local (and thus low latency) branch.
2663
:ivar master_branch: If target is a bound branch, the master branch of
2664
target, or target itself. Always write locked.
2665
:ivar target_branch: The direct Branch where data is being sent (write
2667
:ivar local_branch: If the target is a bound branch this will be the
2668
target, otherwise it will be None.
2147
:ivar old_revno: Revision number before push.
2148
:ivar new_revno: Revision number after push.
2149
:ivar old_revid: Tip revision id before push.
2150
:ivar new_revid: Tip revision id after push.
2151
:ivar source_branch: Source branch object.
2152
:ivar master_branch: Master branch of the target, or None.
2153
:ivar target_branch: Target/destination branch object.
2671
2156
def __int__(self):
2719
2204
new_branch.tags._set_tag_dict({})
2721
2206
# Copying done; now update target format
2722
new_branch._transport.put_bytes('format',
2723
format.get_format_string(),
2724
mode=new_branch.bzrdir._get_file_mode())
2207
new_branch.control_files.put_utf8('format',
2208
format.get_format_string())
2726
2210
# Clean up old files
2727
new_branch._transport.delete('revision-history')
2211
new_branch.control_files._transport.delete('revision-history')
2729
2213
branch.set_parent(None)
2730
except errors.NoSuchFile:
2732
2216
branch.set_bound_location(None)
2735
class Converter6to7(object):
2736
"""Perform an in-place upgrade of format 6 to format 7"""
2738
def convert(self, branch):
2739
format = BzrBranchFormat7()
2740
branch._set_config_location('stacked_on_location', '')
2741
# update target format
2742
branch._transport.put_bytes('format', format.get_format_string())
2746
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2747
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2750
_run_with_write_locked_target will attempt to release the lock it acquires.
2752
If an exception is raised by callable, then that exception *will* be
2753
propagated, even if the unlock attempt raises its own error. Thus
2754
_run_with_write_locked_target should be preferred to simply doing::
2758
return callable(*args, **kwargs)
2763
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2764
# should share code?
2767
result = callable(*args, **kwargs)
2769
exc_info = sys.exc_info()
2773
raise exc_info[0], exc_info[1], exc_info[2]
2779
class InterBranch(InterObject):
2780
"""This class represents operations taking place between two branches.
2782
Its instances have methods like pull() and push() and contain
2783
references to the source and target repositories these operations
2784
can be carried out on.
2788
"""The available optimised InterBranch types."""
2791
def _get_branch_formats_to_test():
2792
"""Return a tuple with the Branch formats to use when testing."""
2793
raise NotImplementedError(self._get_branch_formats_to_test)
2795
def update_revisions(self, stop_revision=None, overwrite=False,
2797
"""Pull in new perfect-fit revisions.
2799
:param stop_revision: Updated until the given revision
2800
:param overwrite: Always set the branch pointer, rather than checking
2801
to see if it is a proper descendant.
2802
:param graph: A Graph object that can be used to query history
2803
information. This can be None.
2806
raise NotImplementedError(self.update_revisions)
2809
class GenericInterBranch(InterBranch):
2810
"""InterBranch implementation that uses public Branch functions.
2814
def _get_branch_formats_to_test():
2815
return BranchFormat._default_format, BranchFormat._default_format
2817
def update_revisions(self, stop_revision=None, overwrite=False,
2819
"""See InterBranch.update_revisions()."""
2820
self.source.lock_read()
2822
other_revno, other_last_revision = self.source.last_revision_info()
2823
stop_revno = None # unknown
2824
if stop_revision is None:
2825
stop_revision = other_last_revision
2826
if _mod_revision.is_null(stop_revision):
2827
# if there are no commits, we're done.
2829
stop_revno = other_revno
2831
# what's the current last revision, before we fetch [and change it
2833
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2834
# we fetch here so that we don't process data twice in the common
2835
# case of having something to pull, and so that the check for
2836
# already merged can operate on the just fetched graph, which will
2837
# be cached in memory.
2838
self.target.fetch(self.source, stop_revision)
2839
# Check to see if one is an ancestor of the other
2842
graph = self.target.repository.get_graph()
2843
if self.target._check_if_descendant_or_diverged(
2844
stop_revision, last_rev, graph, self.source):
2845
# stop_revision is a descendant of last_rev, but we aren't
2846
# overwriting, so we're done.
2848
if stop_revno is None:
2850
graph = self.target.repository.get_graph()
2851
this_revno, this_last_revision = \
2852
self.target.last_revision_info()
2853
stop_revno = graph.find_distance_to_null(stop_revision,
2854
[(other_last_revision, other_revno),
2855
(this_last_revision, this_revno)])
2856
self.target.set_last_revision_info(stop_revno, stop_revision)
2858
self.source.unlock()
2861
def is_compatible(self, source, target):
2862
# GenericBranch uses the public API, so always compatible
2866
InterBranch.register_optimiser(GenericInterBranch)