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._partial_revision_history_cache = []
95
self._last_revision_info_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
106
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
108
self.repository.add_fallback_repository(repo)
110
def break_lock(self):
111
"""Break a lock if one is present from another instance.
113
Uses the ui factory to ask for confirmation if the lock may be from
116
This will probe the repository for its lock as well.
118
self.control_files.break_lock()
119
self.repository.break_lock()
120
master = self.get_master_branch()
121
if master is not None:
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
151
def open(base, _unsupported=False, possible_transports=None):
152
"""Open the branch rooted at base.
154
For instance, if the branch is at URL/.bzr/branch,
155
Branch.open(URL) -> a Branch instance.
157
control = bzrdir.BzrDir.open(base, _unsupported,
158
possible_transports=possible_transports)
159
return control.open_branch(_unsupported)
162
def open_from_transport(transport, _unsupported=False):
163
"""Open the branch rooted at transport"""
164
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
165
return control.open_branch(_unsupported)
168
def open_containing(url, possible_transports=None):
169
"""Open an existing branch which contains url.
171
This probes for a branch at url, and searches upwards from there.
173
Basically we keep looking up until we find the control directory or
174
run into the root. If there isn't one, raises NotBranchError.
175
If there is one and it is either an unrecognised format or an unsupported
176
format, UnknownFormatError or UnsupportedFormatError are raised.
177
If there is one, it is returned, along with the unused portion of url.
179
control, relpath = bzrdir.BzrDir.open_containing(url,
181
return control.open_branch(), relpath
183
def _push_should_merge_tags(self):
184
"""Should _basic_push merge this branch's tags into the target?
186
The default implementation returns False if this branch has no tags,
187
and True the rest of the time. Subclasses may override this.
189
return self.supports_tags() and self.tags.get_tag_dict()
191
def get_config(self):
192
return BranchConfig(self)
194
def _get_config(self):
195
"""Get the concrete config for just the config in this branch.
197
This is not intended for client use; see Branch.get_config for the
202
:return: An object supporting get_option and set_option.
204
raise NotImplementedError(self._get_config)
206
def _get_fallback_repository(self, url):
207
"""Get the repository we fallback to at url."""
208
url = urlutils.join(self.base, url)
209
a_bzrdir = bzrdir.BzrDir.open(url,
210
possible_transports=[self.bzrdir.root_transport])
211
return a_bzrdir.open_branch().repository
213
def _get_tags_bytes(self):
214
"""Get the bytes of a serialised tags dict.
216
Note that not all branches support tags, nor do all use the same tags
217
logic: this method is specific to BasicTags. Other tag implementations
218
may use the same method name and behave differently, safely, because
219
of the double-dispatch via
220
format.make_tags->tags_instance->get_tags_dict.
222
:return: The bytes of the tags file.
223
:seealso: Branch._set_tags_bytes.
225
return self._transport.get_bytes('tags')
227
def _get_nick(self, local=False, possible_transports=None):
228
config = self.get_config()
229
# explicit overrides master, but don't look for master if local is True
230
if not local and not config.has_explicit_nickname():
232
master = self.get_master_branch(possible_transports)
233
if master is not None:
234
# return the master branch value
236
except errors.BzrError, e:
237
# Silently fall back to local implicit nick if the master is
239
mutter("Could not connect to bound branch, "
240
"falling back to local nick.\n " + str(e))
241
return config.get_nickname()
243
def _set_nick(self, nick):
244
self.get_config().set_user_option('nickname', nick, warn_masked=True)
246
nick = property(_get_nick, _set_nick)
249
raise NotImplementedError(self.is_locked)
251
def _lefthand_history(self, revision_id, last_rev=None,
253
if 'evil' in debug.debug_flags:
254
mutter_callsite(4, "_lefthand_history scales with history.")
255
# stop_revision must be a descendant of last_revision
256
graph = self.repository.get_graph()
257
if last_rev is not None:
258
if not graph.is_ancestor(last_rev, revision_id):
259
# our previous tip is not merged into stop_revision
260
raise errors.DivergedBranches(self, other_branch)
261
# make a new revision history from the graph
262
parents_map = graph.get_parent_map([revision_id])
263
if revision_id not in parents_map:
264
raise errors.NoSuchRevision(self, revision_id)
265
current_rev_id = revision_id
267
check_not_reserved_id = _mod_revision.check_not_reserved_id
268
# Do not include ghosts or graph origin in revision_history
269
while (current_rev_id in parents_map and
270
len(parents_map[current_rev_id]) > 0):
271
check_not_reserved_id(current_rev_id)
272
new_history.append(current_rev_id)
273
current_rev_id = parents_map[current_rev_id][0]
274
parents_map = graph.get_parent_map([current_rev_id])
275
new_history.reverse()
278
def lock_write(self):
279
raise NotImplementedError(self.lock_write)
282
raise NotImplementedError(self.lock_read)
285
raise NotImplementedError(self.unlock)
287
def peek_lock_mode(self):
288
"""Return lock mode for the Branch: 'r', 'w' or None"""
289
raise NotImplementedError(self.peek_lock_mode)
291
def get_physical_lock_status(self):
292
raise NotImplementedError(self.get_physical_lock_status)
295
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
296
"""Return the revision_id for a dotted revno.
298
:param revno: a tuple like (1,) or (1,1,2)
299
:param _cache_reverse: a private parameter enabling storage
300
of the reverse mapping in a top level cache. (This should
301
only be done in selective circumstances as we want to
302
avoid having the mapping cached multiple times.)
303
:return: the revision_id
304
:raises errors.NoSuchRevision: if the revno doesn't exist
306
rev_id = self._do_dotted_revno_to_revision_id(revno)
308
self._partial_revision_id_to_revno_cache[rev_id] = revno
311
def _do_dotted_revno_to_revision_id(self, revno):
312
"""Worker function for dotted_revno_to_revision_id.
314
Subclasses should override this if they wish to
315
provide a more efficient implementation.
318
return self.get_rev_id(revno[0])
319
revision_id_to_revno = self.get_revision_id_to_revno_map()
320
revision_ids = [revision_id for revision_id, this_revno
321
in revision_id_to_revno.iteritems()
322
if revno == this_revno]
323
if len(revision_ids) == 1:
324
return revision_ids[0]
326
revno_str = '.'.join(map(str, revno))
327
raise errors.NoSuchRevision(self, revno_str)
330
def revision_id_to_dotted_revno(self, revision_id):
331
"""Given a revision id, return its dotted revno.
333
:return: a tuple like (1,) or (400,1,3).
335
return self._do_revision_id_to_dotted_revno(revision_id)
337
def _do_revision_id_to_dotted_revno(self, revision_id):
338
"""Worker function for revision_id_to_revno."""
339
# Try the caches if they are loaded
340
result = self._partial_revision_id_to_revno_cache.get(revision_id)
341
if result is not None:
343
if self._revision_id_to_revno_cache:
344
result = self._revision_id_to_revno_cache.get(revision_id)
346
raise errors.NoSuchRevision(self, revision_id)
347
# Try the mainline as it's optimised
349
revno = self.revision_id_to_revno(revision_id)
351
except errors.NoSuchRevision:
352
# We need to load and use the full revno map after all
353
result = self.get_revision_id_to_revno_map().get(revision_id)
355
raise errors.NoSuchRevision(self, revision_id)
359
def get_revision_id_to_revno_map(self):
360
"""Return the revision_id => dotted revno map.
362
This will be regenerated on demand, but will be cached.
364
:return: A dictionary mapping revision_id => dotted revno.
365
This dictionary should not be modified by the caller.
367
if self._revision_id_to_revno_cache is not None:
368
mapping = self._revision_id_to_revno_cache
370
mapping = self._gen_revno_map()
371
self._cache_revision_id_to_revno(mapping)
372
# TODO: jam 20070417 Since this is being cached, should we be returning
374
# I would rather not, and instead just declare that users should not
375
# modify the return value.
378
def _gen_revno_map(self):
379
"""Create a new mapping from revision ids to dotted revnos.
381
Dotted revnos are generated based on the current tip in the revision
383
This is the worker function for get_revision_id_to_revno_map, which
384
just caches the return value.
386
:return: A dictionary mapping revision_id => dotted revno.
388
revision_id_to_revno = dict((rev_id, revno)
389
for rev_id, depth, revno, end_of_merge
390
in self.iter_merge_sorted_revisions())
391
return revision_id_to_revno
394
def iter_merge_sorted_revisions(self, start_revision_id=None,
395
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
396
"""Walk the revisions for a branch in merge sorted order.
398
Merge sorted order is the output from a merge-aware,
399
topological sort, i.e. all parents come before their
400
children going forward; the opposite for reverse.
402
:param start_revision_id: the revision_id to begin walking from.
403
If None, the branch tip is used.
404
:param stop_revision_id: the revision_id to terminate the walk
405
after. If None, the rest of history is included.
406
:param stop_rule: if stop_revision_id is not None, the precise rule
407
to use for termination:
408
* 'exclude' - leave the stop revision out of the result (default)
409
* 'include' - the stop revision is the last item in the result
410
* 'with-merges' - include the stop revision and all of its
411
merged revisions in the result
412
:param direction: either 'reverse' or 'forward':
413
* reverse means return the start_revision_id first, i.e.
414
start at the most recent revision and go backwards in history
415
* forward returns tuples in the opposite order to reverse.
416
Note in particular that forward does *not* do any intelligent
417
ordering w.r.t. depth as some clients of this API may like.
418
(If required, that ought to be done at higher layers.)
420
:return: an iterator over (revision_id, depth, revno, end_of_merge)
423
* revision_id: the unique id of the revision
424
* depth: How many levels of merging deep this node has been
426
* revno_sequence: This field provides a sequence of
427
revision numbers for all revisions. The format is:
428
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
429
branch that the revno is on. From left to right the REVNO numbers
430
are the sequence numbers within that branch of the revision.
431
* end_of_merge: When True the next node (earlier in history) is
432
part of a different merge.
434
# Note: depth and revno values are in the context of the branch so
435
# we need the full graph to get stable numbers, regardless of the
437
if self._merge_sorted_revisions_cache is None:
438
last_revision = self.last_revision()
439
graph = self.repository.get_graph()
440
parent_map = dict(((key, value) for key, value in
441
graph.iter_ancestry([last_revision]) if value is not None))
442
revision_graph = repository._strip_NULL_ghosts(parent_map)
443
revs = tsort.merge_sort(revision_graph, last_revision, None,
445
# Drop the sequence # before caching
446
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
448
filtered = self._filter_merge_sorted_revisions(
449
self._merge_sorted_revisions_cache, start_revision_id,
450
stop_revision_id, stop_rule)
451
if direction == 'reverse':
453
if direction == 'forward':
454
return reversed(list(filtered))
456
raise ValueError('invalid direction %r' % direction)
458
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
459
start_revision_id, stop_revision_id, stop_rule):
460
"""Iterate over an inclusive range of sorted revisions."""
461
rev_iter = iter(merge_sorted_revisions)
462
if start_revision_id is not None:
463
for rev_id, depth, revno, end_of_merge in rev_iter:
464
if rev_id != start_revision_id:
467
# The decision to include the start or not
468
# depends on the stop_rule if a stop is provided
470
iter([(rev_id, depth, revno, end_of_merge)]),
473
if stop_revision_id is None:
474
for rev_id, depth, revno, end_of_merge in rev_iter:
475
yield rev_id, depth, revno, end_of_merge
476
elif stop_rule == 'exclude':
477
for rev_id, depth, revno, end_of_merge in rev_iter:
478
if rev_id == stop_revision_id:
480
yield rev_id, depth, revno, end_of_merge
481
elif stop_rule == 'include':
482
for rev_id, depth, revno, end_of_merge in rev_iter:
483
yield rev_id, depth, revno, end_of_merge
484
if rev_id == stop_revision_id:
486
elif stop_rule == 'with-merges':
487
stop_rev = self.repository.get_revision(stop_revision_id)
488
if stop_rev.parent_ids:
489
left_parent = stop_rev.parent_ids[0]
491
left_parent = _mod_revision.NULL_REVISION
492
for rev_id, depth, revno, end_of_merge in rev_iter:
493
if rev_id == left_parent:
495
yield rev_id, depth, revno, end_of_merge
497
raise ValueError('invalid stop_rule %r' % stop_rule)
499
def leave_lock_in_place(self):
500
"""Tell this branch object not to release the physical lock when this
503
If lock_write doesn't return a token, then this method is not supported.
505
self.control_files.leave_in_place()
507
def dont_leave_lock_in_place(self):
508
"""Tell this branch object to release the physical lock when this
509
object is unlocked, even if it didn't originally acquire it.
511
If lock_write doesn't return a token, then this method is not supported.
513
self.control_files.dont_leave_in_place()
515
def bind(self, other):
516
"""Bind the local branch the other branch.
518
:param other: The branch to bind to
521
raise errors.UpgradeRequired(self.base)
523
def set_reference_info(self, file_id, tree_path, branch_location):
524
"""Set the branch location to use for a tree reference."""
525
raise errors.UnsupportedOperation(self.set_reference_info, self)
527
def get_reference_info(self, file_id):
528
"""Get the tree_path and branch_location for a tree reference."""
529
raise errors.UnsupportedOperation(self.get_reference_info, self)
532
def fetch(self, from_branch, last_revision=None, pb=None):
533
"""Copy revisions from from_branch into this branch.
535
:param from_branch: Where to copy from.
536
:param last_revision: What revision to stop at (None for at the end
538
:param pb: An optional progress bar to use.
541
if self.base == from_branch.base:
544
symbol_versioning.warn(
545
symbol_versioning.deprecated_in((1, 14, 0))
546
% "pb parameter to fetch()")
547
from_branch.lock_read()
549
if last_revision is None:
550
last_revision = from_branch.last_revision()
551
last_revision = _mod_revision.ensure_null(last_revision)
552
return self.repository.fetch(from_branch.repository,
553
revision_id=last_revision,
558
def get_bound_location(self):
559
"""Return the URL of the branch we are bound to.
561
Older format branches cannot bind, please be sure to use a metadir
566
def get_old_bound_location(self):
567
"""Return the URL of the branch we used to be bound to
569
raise errors.UpgradeRequired(self.base)
571
def get_commit_builder(self, parents, config=None, timestamp=None,
572
timezone=None, committer=None, revprops=None,
574
"""Obtain a CommitBuilder for this branch.
576
:param parents: Revision ids of the parents of the new revision.
577
:param config: Optional configuration to use.
578
:param timestamp: Optional timestamp recorded for commit.
579
:param timezone: Optional timezone for timestamp.
580
:param committer: Optional committer to set for commit.
581
:param revprops: Optional dictionary of revision properties.
582
:param revision_id: Optional revision id.
586
config = self.get_config()
588
return self.repository.get_commit_builder(self, parents, config,
589
timestamp, timezone, committer, revprops, revision_id)
591
def get_master_branch(self, possible_transports=None):
592
"""Return the branch we are bound to.
594
:return: Either a Branch, or None
598
def get_revision_delta(self, revno):
599
"""Return the delta for one revision.
601
The delta is relative to its mainline predecessor, or the
602
empty tree for revision 1.
604
rh = self.revision_history()
605
if not (1 <= revno <= len(rh)):
606
raise errors.InvalidRevisionNumber(revno)
607
return self.repository.get_revision_delta(rh[revno-1])
609
def get_stacked_on_url(self):
610
"""Get the URL this branch is stacked against.
612
:raises NotStacked: If the branch is not stacked.
613
:raises UnstackableBranchFormat: If the branch does not support
616
raise NotImplementedError(self.get_stacked_on_url)
618
def print_file(self, file, revision_id):
619
"""Print `file` to stdout."""
620
raise NotImplementedError(self.print_file)
622
def set_revision_history(self, rev_history):
623
raise NotImplementedError(self.set_revision_history)
626
def set_parent(self, url):
627
"""See Branch.set_parent."""
628
# TODO: Maybe delete old location files?
629
# URLs should never be unicode, even on the local fs,
630
# FIXUP this and get_parent in a future branch format bump:
631
# read and rewrite the file. RBC 20060125
633
if isinstance(url, unicode):
635
url = url.encode('ascii')
636
except UnicodeEncodeError:
637
raise errors.InvalidURL(url,
638
"Urls must be 7-bit ascii, "
639
"use bzrlib.urlutils.escape")
640
url = urlutils.relative_url(self.base, url)
641
self._set_parent_location(url)
644
def set_stacked_on_url(self, url):
645
"""Set the URL this branch is stacked against.
647
:raises UnstackableBranchFormat: If the branch does not support
649
:raises UnstackableRepositoryFormat: If the repository does not support
652
if not self._format.supports_stacking():
653
raise errors.UnstackableBranchFormat(self._format, self.base)
654
self._check_stackable_repo()
657
old_url = self.get_stacked_on_url()
658
except (errors.NotStacked, errors.UnstackableBranchFormat,
659
errors.UnstackableRepositoryFormat):
662
# XXX: Lock correctness - should unlock our old repo if we were
664
# repositories don't offer an interface to remove fallback
665
# repositories today; take the conceptually simpler option and just
667
self.repository = self.bzrdir.find_repository()
668
self.repository.lock_write()
669
# for every revision reference the branch has, ensure it is pulled
671
source_repository = self._get_fallback_repository(old_url)
672
for revision_id in chain([self.last_revision()],
673
self.tags.get_reverse_tag_dict()):
674
self.repository.fetch(source_repository, revision_id,
677
self._activate_fallback_location(url)
678
# write this out after the repository is stacked to avoid setting a
679
# stacked config that doesn't work.
680
self._set_config_location('stacked_on_location', url)
683
def _set_tags_bytes(self, bytes):
684
"""Mirror method for _get_tags_bytes.
686
:seealso: Branch._get_tags_bytes.
688
return _run_with_write_locked_target(self, self._transport.put_bytes,
691
def _cache_revision_history(self, rev_history):
692
"""Set the cached revision history to rev_history.
694
The revision_history method will use this cache to avoid regenerating
695
the revision history.
697
This API is semi-public; it only for use by subclasses, all other code
698
should consider it to be private.
700
self._revision_history_cache = rev_history
702
def _cache_revision_id_to_revno(self, revision_id_to_revno):
703
"""Set the cached revision_id => revno map to revision_id_to_revno.
705
This API is semi-public; it only for use by subclasses, all other code
706
should consider it to be private.
708
self._revision_id_to_revno_cache = revision_id_to_revno
710
def _clear_cached_state(self):
711
"""Clear any cached data on this branch, e.g. cached revision history.
713
This means the next call to revision_history will need to call
714
_gen_revision_history.
716
This API is semi-public; it only for use by subclasses, all other code
717
should consider it to be private.
719
self._revision_history_cache = None
720
self._revision_id_to_revno_cache = None
721
self._last_revision_info_cache = None
722
self._merge_sorted_revisions_cache = None
723
self._partial_revision_history_cache = []
724
self._partial_revision_id_to_revno_cache = {}
726
def _gen_revision_history(self):
727
"""Return sequence of revision hashes on to this branch.
729
Unlike revision_history, this method always regenerates or rereads the
730
revision history, i.e. it does not cache the result, so repeated calls
733
Concrete subclasses should override this instead of revision_history so
734
that subclasses do not need to deal with caching logic.
736
This API is semi-public; it only for use by subclasses, all other code
737
should consider it to be private.
739
raise NotImplementedError(self._gen_revision_history)
742
def revision_history(self):
743
"""Return sequence of revision ids on this branch.
745
This method will cache the revision history for as long as it is safe to
748
if 'evil' in debug.debug_flags:
749
mutter_callsite(3, "revision_history scales with history.")
750
if self._revision_history_cache is not None:
751
history = self._revision_history_cache
753
history = self._gen_revision_history()
754
self._cache_revision_history(history)
758
"""Return current revision number for this branch.
760
That is equivalent to the number of revisions committed to
763
return self.last_revision_info()[0]
766
"""Older format branches cannot bind or unbind."""
767
raise errors.UpgradeRequired(self.base)
769
def set_append_revisions_only(self, enabled):
770
"""Older format branches are never restricted to append-only"""
771
raise errors.UpgradeRequired(self.base)
773
def last_revision(self):
774
"""Return last revision id, or NULL_REVISION."""
775
return self.last_revision_info()[1]
778
def last_revision_info(self):
779
"""Return information about the last revision.
781
:return: A tuple (revno, revision_id).
783
if self._last_revision_info_cache is None:
784
self._last_revision_info_cache = self._last_revision_info()
785
return self._last_revision_info_cache
787
def _last_revision_info(self):
788
rh = self.revision_history()
791
return (revno, rh[-1])
793
return (0, _mod_revision.NULL_REVISION)
795
@deprecated_method(deprecated_in((1, 6, 0)))
796
def missing_revisions(self, other, stop_revision=None):
797
"""Return a list of new revisions that would perfectly fit.
799
If self and other have not diverged, return a list of the revisions
800
present in other, but missing from self.
802
self_history = self.revision_history()
803
self_len = len(self_history)
804
other_history = other.revision_history()
805
other_len = len(other_history)
806
common_index = min(self_len, other_len) -1
807
if common_index >= 0 and \
808
self_history[common_index] != other_history[common_index]:
809
raise errors.DivergedBranches(self, other)
811
if stop_revision is None:
812
stop_revision = other_len
814
if stop_revision > other_len:
815
raise errors.NoSuchRevision(self, stop_revision)
816
return other_history[self_len:stop_revision]
819
def update_revisions(self, other, stop_revision=None, overwrite=False,
821
"""Pull in new perfect-fit revisions.
823
:param other: Another Branch to pull from
824
:param stop_revision: Updated until the given revision
825
:param overwrite: Always set the branch pointer, rather than checking
826
to see if it is a proper descendant.
827
:param graph: A Graph object that can be used to query history
828
information. This can be None.
831
return InterBranch.get(other, self).update_revisions(stop_revision,
834
def import_last_revision_info(self, source_repo, revno, revid):
835
"""Set the last revision info, importing from another repo if necessary.
837
This is used by the bound branch code to upload a revision to
838
the master branch first before updating the tip of the local branch.
840
:param source_repo: Source repository to optionally fetch from
841
:param revno: Revision number of the new tip
842
:param revid: Revision id of the new tip
844
if not self.repository.has_same_location(source_repo):
845
self.repository.fetch(source_repo, revision_id=revid)
846
self.set_last_revision_info(revno, revid)
848
def revision_id_to_revno(self, revision_id):
849
"""Given a revision id, return its revno"""
850
if _mod_revision.is_null(revision_id):
852
history = self.revision_history()
854
return history.index(revision_id) + 1
856
raise errors.NoSuchRevision(self, revision_id)
859
def get_rev_id(self, revno, history=None):
860
"""Find the revision id of the specified revno."""
862
return _mod_revision.NULL_REVISION
863
last_revno, last_revid = self.last_revision_info()
864
if revno == last_revno:
866
if revno <= 0 or revno > last_revno:
867
raise errors.NoSuchRevision(self, revno)
868
distance_from_last = last_revno - revno
869
if len(self._partial_revision_history_cache) <= distance_from_last:
870
self._extend_partial_history(distance_from_last)
871
return self._partial_revision_history_cache[distance_from_last]
874
def pull(self, source, overwrite=False, stop_revision=None,
875
possible_transports=None, *args, **kwargs):
876
"""Mirror source into this branch.
878
This branch is considered to be 'local', having low latency.
880
:returns: PullResult instance
882
return InterBranch.get(source, self).pull(overwrite=overwrite,
883
stop_revision=stop_revision,
884
possible_transports=possible_transports, *args, **kwargs)
886
def push(self, target, overwrite=False, stop_revision=None, *args,
888
"""Mirror this branch into target.
890
This branch is considered to be 'local', having low latency.
892
return InterBranch.get(self, target).push(overwrite, stop_revision,
895
def lossy_push(self, target, stop_revision=None):
896
"""Push deltas into another branch.
898
:note: This does not, like push, retain the revision ids from
899
the source branch and will, rather than adding bzr-specific
900
metadata, push only those semantics of the revision that can be
901
natively represented by this branch' VCS.
903
:param target: Target branch
904
:param stop_revision: Revision to push, defaults to last revision.
905
:return: BranchPushResult with an extra member revidmap:
906
A dictionary mapping revision ids from the target branch
907
to new revision ids in the target branch, for each
908
revision that was pushed.
910
inter = InterBranch.get(self, target)
911
lossy_push = getattr(inter, "lossy_push", None)
912
if lossy_push is None:
913
raise errors.LossyPushToSameVCS(self, target)
914
return lossy_push(stop_revision)
916
def basis_tree(self):
917
"""Return `Tree` object for last revision."""
918
return self.repository.revision_tree(self.last_revision())
920
def get_parent(self):
921
"""Return the parent location of the branch.
923
This is the default location for pull/missing. The usual
924
pattern is that the user can override it by specifying a
927
parent = self._get_parent_location()
930
# This is an old-format absolute path to a local branch
932
if parent.startswith('/'):
933
parent = urlutils.local_path_to_url(parent.decode('utf8'))
935
return urlutils.join(self.base[:-1], parent)
936
except errors.InvalidURLJoin, e:
937
raise errors.InaccessibleParent(parent, self.base)
939
def _get_parent_location(self):
940
raise NotImplementedError(self._get_parent_location)
942
def _set_config_location(self, name, url, config=None,
943
make_relative=False):
945
config = self.get_config()
949
url = urlutils.relative_url(self.base, url)
950
config.set_user_option(name, url, warn_masked=True)
952
def _get_config_location(self, name, config=None):
954
config = self.get_config()
955
location = config.get_user_option(name)
960
def get_child_submit_format(self):
961
"""Return the preferred format of submissions to this branch."""
962
return self.get_config().get_user_option("child_submit_format")
964
def get_submit_branch(self):
965
"""Return the submit location of the branch.
967
This is the default location for bundle. The usual
968
pattern is that the user can override it by specifying a
971
return self.get_config().get_user_option('submit_branch')
973
def set_submit_branch(self, location):
974
"""Return the submit location of the branch.
976
This is the default location for bundle. The usual
977
pattern is that the user can override it by specifying a
980
self.get_config().set_user_option('submit_branch', location,
983
def get_public_branch(self):
984
"""Return the public location of the branch.
986
This is used by merge directives.
988
return self._get_config_location('public_branch')
990
def set_public_branch(self, location):
991
"""Return the submit location of the branch.
993
This is the default location for bundle. The usual
994
pattern is that the user can override it by specifying a
997
self._set_config_location('public_branch', location)
999
def get_push_location(self):
1000
"""Return the None or the location to push this branch to."""
1001
push_loc = self.get_config().get_user_option('push_location')
1004
def set_push_location(self, location):
1005
"""Set a new push location for this branch."""
1006
raise NotImplementedError(self.set_push_location)
1008
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1009
"""Run the post_change_branch_tip hooks."""
1010
hooks = Branch.hooks['post_change_branch_tip']
1013
new_revno, new_revid = self.last_revision_info()
1014
params = ChangeBranchTipParams(
1015
self, old_revno, new_revno, old_revid, new_revid)
1019
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1020
"""Run the pre_change_branch_tip hooks."""
1021
hooks = Branch.hooks['pre_change_branch_tip']
1024
old_revno, old_revid = self.last_revision_info()
1025
params = ChangeBranchTipParams(
1026
self, old_revno, new_revno, old_revid, new_revid)
1030
except errors.TipChangeRejected:
1033
exc_info = sys.exc_info()
1034
hook_name = Branch.hooks.get_hook_name(hook)
1035
raise errors.HookFailed(
1036
'pre_change_branch_tip', hook_name, exc_info)
1040
"""Synchronise this branch with the master branch if any.
1042
:return: None or the last_revision pivoted out during the update.
1046
def check_revno(self, revno):
1048
Check whether a revno corresponds to any revision.
1049
Zero (the NULL revision) is considered valid.
1052
self.check_real_revno(revno)
1054
def check_real_revno(self, revno):
1056
Check whether a revno corresponds to a real revision.
1057
Zero (the NULL revision) is considered invalid
1059
if revno < 1 or revno > self.revno():
1060
raise errors.InvalidRevisionNumber(revno)
1063
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1064
"""Clone this branch into to_bzrdir preserving all semantic values.
1066
Most API users will want 'create_clone_on_transport', which creates a
1067
new bzrdir and branch on the fly.
1069
revision_id: if not None, the revision history in the new branch will
1070
be truncated to end with revision_id.
1072
result = to_bzrdir.create_branch()
1075
if repository_policy is not None:
1076
repository_policy.configure_branch(result)
1077
self.copy_content_into(result, revision_id=revision_id)
1083
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1084
"""Create a new line of development from the branch, into to_bzrdir.
1086
to_bzrdir controls the branch format.
1088
revision_id: if not None, the revision history in the new branch will
1089
be truncated to end with revision_id.
1091
result = to_bzrdir.create_branch()
1094
if repository_policy is not None:
1095
repository_policy.configure_branch(result)
1096
self.copy_content_into(result, revision_id=revision_id)
1097
result.set_parent(self.bzrdir.root_transport.base)
1102
def _synchronize_history(self, destination, revision_id):
1103
"""Synchronize last revision and revision history between branches.
1105
This version is most efficient when the destination is also a
1106
BzrBranch6, but works for BzrBranch5, as long as the destination's
1107
repository contains all the lefthand ancestors of the intended
1108
last_revision. If not, set_last_revision_info will fail.
1110
:param destination: The branch to copy the history into
1111
:param revision_id: The revision-id to truncate history at. May
1112
be None to copy complete history.
1114
source_revno, source_revision_id = self.last_revision_info()
1115
if revision_id is None:
1116
revno, revision_id = source_revno, source_revision_id
1118
graph = self.repository.get_graph()
1120
revno = graph.find_distance_to_null(revision_id,
1121
[(source_revision_id, source_revno)])
1122
except errors.GhostRevisionsHaveNoRevno:
1123
# Default to 1, if we can't find anything else
1125
destination.set_last_revision_info(revno, revision_id)
1128
def copy_content_into(self, destination, revision_id=None):
1129
"""Copy the content of self into destination.
1131
revision_id: if not None, the revision history in the new branch will
1132
be truncated to end with revision_id.
1134
self.update_references(destination)
1135
self._synchronize_history(destination, revision_id)
1137
parent = self.get_parent()
1138
except errors.InaccessibleParent, e:
1139
mutter('parent was not accessible to copy: %s', e)
1142
destination.set_parent(parent)
1143
if self._push_should_merge_tags():
1144
self.tags.merge_to(destination.tags)
1146
def update_references(self, target):
1147
if not getattr(self._format, 'supports_reference_locations', False):
1149
reference_dict = self._get_all_reference_info()
1150
if len(reference_dict) == 0:
1152
old_base = self.base
1153
new_base = target.base
1154
target_reference_dict = target._get_all_reference_info()
1155
for file_id, (tree_path, branch_location) in (
1156
reference_dict.items()):
1157
branch_location = urlutils.rebase_url(branch_location,
1159
target_reference_dict.setdefault(
1160
file_id, (tree_path, branch_location))
1161
target._set_all_reference_info(target_reference_dict)
1165
"""Check consistency of the branch.
1167
In particular this checks that revisions given in the revision-history
1168
do actually match up in the revision graph, and that they're all
1169
present in the repository.
1171
Callers will typically also want to check the repository.
1173
:return: A BranchCheckResult.
1175
ret = BranchCheckResult(self)
1176
mainline_parent_id = None
1177
last_revno, last_revision_id = self.last_revision_info()
1178
real_rev_history = []
1180
for revid in self.repository.iter_reverse_revision_history(
1182
real_rev_history.append(revid)
1183
except errors.RevisionNotPresent:
1184
ret.ghosts_in_mainline = True
1186
ret.ghosts_in_mainline = False
1187
real_rev_history.reverse()
1188
if len(real_rev_history) != last_revno:
1189
raise errors.BzrCheckError('revno does not match len(mainline)'
1190
' %s != %s' % (last_revno, len(real_rev_history)))
1191
# TODO: We should probably also check that real_rev_history actually
1192
# matches self.revision_history()
1193
for revision_id in real_rev_history:
1195
revision = self.repository.get_revision(revision_id)
1196
except errors.NoSuchRevision, e:
1197
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1199
# In general the first entry on the revision history has no parents.
1200
# But it's not illegal for it to have parents listed; this can happen
1201
# in imports from Arch when the parents weren't reachable.
1202
if mainline_parent_id is not None:
1203
if mainline_parent_id not in revision.parent_ids:
1204
raise errors.BzrCheckError("previous revision {%s} not listed among "
1206
% (mainline_parent_id, revision_id))
1207
mainline_parent_id = revision_id
1210
def _get_checkout_format(self):
1211
"""Return the most suitable metadir for a checkout of this branch.
1212
Weaves are used if this branch's repository uses weaves.
1214
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1215
from bzrlib.repofmt import weaverepo
1216
format = bzrdir.BzrDirMetaFormat1()
1217
format.repository_format = weaverepo.RepositoryFormat7()
1219
format = self.repository.bzrdir.checkout_metadir()
1220
format.set_branch_format(self._format)
1223
def create_clone_on_transport(self, to_transport, revision_id=None,
1224
stacked_on=None, create_prefix=False, use_existing_dir=False):
1225
"""Create a clone of this branch and its bzrdir.
1227
:param to_transport: The transport to clone onto.
1228
:param revision_id: The revision id to use as tip in the new branch.
1229
If None the tip is obtained from this branch.
1230
:param stacked_on: An optional URL to stack the clone on.
1231
:param create_prefix: Create any missing directories leading up to
1233
:param use_existing_dir: Use an existing directory if one exists.
1235
# XXX: Fix the bzrdir API to allow getting the branch back from the
1236
# clone call. Or something. 20090224 RBC/spiv.
1237
if revision_id is None:
1238
revision_id = self.last_revision()
1240
dir_to = self.bzrdir.clone_on_transport(to_transport,
1241
revision_id=revision_id, stacked_on=stacked_on,
1242
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1243
except errors.FileExists:
1244
if not use_existing_dir:
1246
except errors.NoSuchFile:
1247
if not create_prefix:
1249
return dir_to.open_branch()
1251
def create_checkout(self, to_location, revision_id=None,
1252
lightweight=False, accelerator_tree=None,
1254
"""Create a checkout of a branch.
1256
:param to_location: The url to produce the checkout at
1257
:param revision_id: The revision to check out
1258
:param lightweight: If True, produce a lightweight checkout, otherwise,
1259
produce a bound branch (heavyweight checkout)
1260
:param accelerator_tree: A tree which can be used for retrieving file
1261
contents more quickly than the revision tree, i.e. a workingtree.
1262
The revision tree will be used for cases where accelerator_tree's
1263
content is different.
1264
:param hardlink: If true, hard-link files from accelerator_tree,
1266
:return: The tree of the created checkout
1268
t = transport.get_transport(to_location)
1271
format = self._get_checkout_format()
1272
checkout = format.initialize_on_transport(t)
1273
from_branch = BranchReferenceFormat().initialize(checkout, self)
1275
format = self._get_checkout_format()
1276
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1277
to_location, force_new_tree=False, format=format)
1278
checkout = checkout_branch.bzrdir
1279
checkout_branch.bind(self)
1280
# pull up to the specified revision_id to set the initial
1281
# branch tip correctly, and seed it with history.
1282
checkout_branch.pull(self, stop_revision=revision_id)
1284
tree = checkout.create_workingtree(revision_id,
1285
from_branch=from_branch,
1286
accelerator_tree=accelerator_tree,
1288
basis_tree = tree.basis_tree()
1289
basis_tree.lock_read()
1291
for path, file_id in basis_tree.iter_references():
1292
reference_parent = self.reference_parent(file_id, path)
1293
reference_parent.create_checkout(tree.abspath(path),
1294
basis_tree.get_reference_revision(file_id, path),
1301
def reconcile(self, thorough=True):
1302
"""Make sure the data stored in this branch is consistent."""
1303
from bzrlib.reconcile import BranchReconciler
1304
reconciler = BranchReconciler(self, thorough=thorough)
1305
reconciler.reconcile()
1308
def reference_parent(self, file_id, path, possible_transports=None):
1309
"""Return the parent branch for a tree-reference file_id
1310
:param file_id: The file_id of the tree reference
1311
:param path: The path of the file_id in the tree
1312
:return: A branch associated with the file_id
1314
# FIXME should provide multiple branches, based on config
1315
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1316
possible_transports=possible_transports)
1318
def supports_tags(self):
1319
return self._format.supports_tags()
1321
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1323
"""Ensure that revision_b is a descendant of revision_a.
1325
This is a helper function for update_revisions.
1327
:raises: DivergedBranches if revision_b has diverged from revision_a.
1328
:returns: True if revision_b is a descendant of revision_a.
1330
relation = self._revision_relations(revision_a, revision_b, graph)
1331
if relation == 'b_descends_from_a':
1333
elif relation == 'diverged':
1334
raise errors.DivergedBranches(self, other_branch)
1335
elif relation == 'a_descends_from_b':
1338
raise AssertionError("invalid relation: %r" % (relation,))
1340
def _revision_relations(self, revision_a, revision_b, graph):
1341
"""Determine the relationship between two revisions.
1343
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1345
heads = graph.heads([revision_a, revision_b])
1346
if heads == set([revision_b]):
1347
return 'b_descends_from_a'
1348
elif heads == set([revision_a, revision_b]):
1349
# These branches have diverged
1351
elif heads == set([revision_a]):
1352
return 'a_descends_from_b'
1354
raise AssertionError("invalid heads: %r" % (heads,))
1357
class BranchFormat(object):
1358
"""An encapsulation of the initialization and open routines for a format.
1360
Formats provide three things:
1361
* An initialization routine,
1365
Formats are placed in an dict by their format string for reference
1366
during branch opening. Its not required that these be instances, they
1367
can be classes themselves with class methods - it simply depends on
1368
whether state is needed for a given format or not.
1370
Once a format is deprecated, just deprecate the initialize and open
1371
methods on the format class. Do not deprecate the object, as the
1372
object will be created every time regardless.
1375
_default_format = None
1376
"""The default format used for new branches."""
1379
"""The known formats."""
1381
def __eq__(self, other):
1382
return self.__class__ is other.__class__
1384
def __ne__(self, other):
1385
return not (self == other)
1388
def find_format(klass, a_bzrdir):
1389
"""Return the format for the branch object in a_bzrdir."""
1391
transport = a_bzrdir.get_branch_transport(None)
1392
format_string = transport.get("format").read()
1393
return klass._formats[format_string]
1394
except errors.NoSuchFile:
1395
raise errors.NotBranchError(path=transport.base)
1397
raise errors.UnknownFormatError(format=format_string, kind='branch')
1400
def get_default_format(klass):
1401
"""Return the current default format."""
1402
return klass._default_format
1404
def get_reference(self, a_bzrdir):
1405
"""Get the target reference of the branch in a_bzrdir.
1407
format probing must have been completed before calling
1408
this method - it is assumed that the format of the branch
1409
in a_bzrdir is correct.
1411
:param a_bzrdir: The bzrdir to get the branch data from.
1412
:return: None if the branch is not a reference branch.
1417
def set_reference(self, a_bzrdir, to_branch):
1418
"""Set the target reference of the branch in a_bzrdir.
1420
format probing must have been completed before calling
1421
this method - it is assumed that the format of the branch
1422
in a_bzrdir is correct.
1424
:param a_bzrdir: The bzrdir to set the branch reference for.
1425
:param to_branch: branch that the checkout is to reference
1427
raise NotImplementedError(self.set_reference)
1429
def get_format_string(self):
1430
"""Return the ASCII format string that identifies this format."""
1431
raise NotImplementedError(self.get_format_string)
1433
def get_format_description(self):
1434
"""Return the short format description for this format."""
1435
raise NotImplementedError(self.get_format_description)
1437
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1439
"""Initialize a branch in a bzrdir, with specified files
1441
:param a_bzrdir: The bzrdir to initialize the branch in
1442
:param utf8_files: The files to create as a list of
1443
(filename, content) tuples
1444
:param set_format: If True, set the format with
1445
self.get_format_string. (BzrBranch4 has its format set
1447
:return: a branch in this format
1449
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1450
branch_transport = a_bzrdir.get_branch_transport(self)
1452
'metadir': ('lock', lockdir.LockDir),
1453
'branch4': ('branch-lock', lockable_files.TransportLock),
1455
lock_name, lock_class = lock_map[lock_type]
1456
control_files = lockable_files.LockableFiles(branch_transport,
1457
lock_name, lock_class)
1458
control_files.create_lock()
1460
control_files.lock_write()
1461
except errors.LockContention:
1462
if lock_type != 'branch4':
1468
utf8_files += [('format', self.get_format_string())]
1470
for (filename, content) in utf8_files:
1471
branch_transport.put_bytes(
1473
mode=a_bzrdir._get_file_mode())
1476
control_files.unlock()
1477
return self.open(a_bzrdir, _found=True)
1479
def initialize(self, a_bzrdir):
1480
"""Create a branch of this format in a_bzrdir."""
1481
raise NotImplementedError(self.initialize)
1483
def is_supported(self):
1484
"""Is this format supported?
1486
Supported formats can be initialized and opened.
1487
Unsupported formats may not support initialization or committing or
1488
some other features depending on the reason for not being supported.
1492
def make_tags(self, branch):
1493
"""Create a tags object for branch.
1495
This method is on BranchFormat, because BranchFormats are reflected
1496
over the wire via network_name(), whereas full Branch instances require
1497
multiple VFS method calls to operate at all.
1499
The default implementation returns a disabled-tags instance.
1501
Note that it is normal for branch to be a RemoteBranch when using tags
1504
return DisabledTags(branch)
1506
def network_name(self):
1507
"""A simple byte string uniquely identifying this format for RPC calls.
1509
MetaDir branch formats use their disk format string to identify the
1510
repository over the wire. All in one formats such as bzr < 0.8, and
1511
foreign formats like svn/git and hg should use some marker which is
1512
unique and immutable.
1514
raise NotImplementedError(self.network_name)
1516
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1517
"""Return the branch object for a_bzrdir
1519
:param a_bzrdir: A BzrDir that contains a branch.
1520
:param _found: a private parameter, do not use it. It is used to
1521
indicate if format probing has already be done.
1522
:param ignore_fallbacks: when set, no fallback branches will be opened
1523
(if there are any). Default is to open fallbacks.
1525
raise NotImplementedError(self.open)
1528
def register_format(klass, format):
1529
"""Register a metadir format."""
1530
klass._formats[format.get_format_string()] = format
1531
# Metadir formats have a network name of their format string, and get
1532
# registered as class factories.
1533
network_format_registry.register(format.get_format_string(), format.__class__)
1536
def set_default_format(klass, format):
1537
klass._default_format = format
1539
def supports_stacking(self):
1540
"""True if this format records a stacked-on branch."""
1544
def unregister_format(klass, format):
1545
del klass._formats[format.get_format_string()]
1548
return self.get_format_description().rstrip()
1550
def supports_tags(self):
1551
"""True if this format supports tags stored in the branch"""
1552
return False # by default
1555
class BranchHooks(Hooks):
1556
"""A dictionary mapping hook name to a list of callables for branch hooks.
1558
e.g. ['set_rh'] Is the list of items to be called when the
1559
set_revision_history function is invoked.
1563
"""Create the default hooks.
1565
These are all empty initially, because by default nothing should get
1568
Hooks.__init__(self)
1569
self.create_hook(HookPoint('set_rh',
1570
"Invoked whenever the revision history has been set via "
1571
"set_revision_history. The api signature is (branch, "
1572
"revision_history), and the branch will be write-locked. "
1573
"The set_rh hook can be expensive for bzr to trigger, a better "
1574
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1575
self.create_hook(HookPoint('open',
1576
"Called with the Branch object that has been opened after a "
1577
"branch is opened.", (1, 8), None))
1578
self.create_hook(HookPoint('post_push',
1579
"Called after a push operation completes. post_push is called "
1580
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1581
"bzr client.", (0, 15), None))
1582
self.create_hook(HookPoint('post_pull',
1583
"Called after a pull operation completes. post_pull is called "
1584
"with a bzrlib.branch.PullResult object and only runs in the "
1585
"bzr client.", (0, 15), None))
1586
self.create_hook(HookPoint('pre_commit',
1587
"Called after a commit is calculated but before it is is "
1588
"completed. pre_commit is called with (local, master, old_revno, "
1589
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1590
"). old_revid is NULL_REVISION for the first commit to a branch, "
1591
"tree_delta is a TreeDelta object describing changes from the "
1592
"basis revision. hooks MUST NOT modify this delta. "
1593
" future_tree is an in-memory tree obtained from "
1594
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1595
"tree.", (0,91), None))
1596
self.create_hook(HookPoint('post_commit',
1597
"Called in the bzr client after a commit has completed. "
1598
"post_commit is called with (local, master, old_revno, old_revid, "
1599
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1600
"commit to a branch.", (0, 15), None))
1601
self.create_hook(HookPoint('post_uncommit',
1602
"Called in the bzr client after an uncommit completes. "
1603
"post_uncommit is called with (local, master, old_revno, "
1604
"old_revid, new_revno, new_revid) where local is the local branch "
1605
"or None, master is the target branch, and an empty branch "
1606
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1607
self.create_hook(HookPoint('pre_change_branch_tip',
1608
"Called in bzr client and server before a change to the tip of a "
1609
"branch is made. pre_change_branch_tip is called with a "
1610
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1611
"commit, uncommit will all trigger this hook.", (1, 6), None))
1612
self.create_hook(HookPoint('post_change_branch_tip',
1613
"Called in bzr client and server after a change to the tip of a "
1614
"branch is made. post_change_branch_tip is called with a "
1615
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1616
"commit, uncommit will all trigger this hook.", (1, 4), None))
1617
self.create_hook(HookPoint('transform_fallback_location',
1618
"Called when a stacked branch is activating its fallback "
1619
"locations. transform_fallback_location is called with (branch, "
1620
"url), and should return a new url. Returning the same url "
1621
"allows it to be used as-is, returning a different one can be "
1622
"used to cause the branch to stack on a closer copy of that "
1623
"fallback_location. Note that the branch cannot have history "
1624
"accessing methods called on it during this hook because the "
1625
"fallback locations have not been activated. When there are "
1626
"multiple hooks installed for transform_fallback_location, "
1627
"all are called with the url returned from the previous hook."
1628
"The order is however undefined.", (1, 9), None))
1631
# install the default hooks into the Branch class.
1632
Branch.hooks = BranchHooks()
1635
class ChangeBranchTipParams(object):
1636
"""Object holding parameters passed to *_change_branch_tip hooks.
1638
There are 5 fields that hooks may wish to access:
1640
:ivar branch: the branch being changed
1641
:ivar old_revno: revision number before the change
1642
:ivar new_revno: revision number after the change
1643
:ivar old_revid: revision id before the change
1644
:ivar new_revid: revision id after the change
1646
The revid fields are strings. The revno fields are integers.
1649
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1650
"""Create a group of ChangeBranchTip parameters.
1652
:param branch: The branch being changed.
1653
:param old_revno: Revision number before the change.
1654
:param new_revno: Revision number after the change.
1655
:param old_revid: Tip revision id before the change.
1656
:param new_revid: Tip revision id after the change.
1658
self.branch = branch
1659
self.old_revno = old_revno
1660
self.new_revno = new_revno
1661
self.old_revid = old_revid
1662
self.new_revid = new_revid
1664
def __eq__(self, other):
1665
return self.__dict__ == other.__dict__
1668
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1669
self.__class__.__name__, self.branch,
1670
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1673
class BzrBranchFormat4(BranchFormat):
1674
"""Bzr branch format 4.
1677
- a revision-history file.
1678
- a branch-lock lock file [ to be shared with the bzrdir ]
1681
def get_format_description(self):
1682
"""See BranchFormat.get_format_description()."""
1683
return "Branch format 4"
1685
def initialize(self, a_bzrdir):
1686
"""Create a branch of this format in a_bzrdir."""
1687
utf8_files = [('revision-history', ''),
1688
('branch-name', ''),
1690
return self._initialize_helper(a_bzrdir, utf8_files,
1691
lock_type='branch4', set_format=False)
1694
super(BzrBranchFormat4, self).__init__()
1695
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1697
def network_name(self):
1698
"""The network name for this format is the control dirs disk label."""
1699
return self._matchingbzrdir.get_format_string()
1701
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1702
"""See BranchFormat.open()."""
1704
# we are being called directly and must probe.
1705
raise NotImplementedError
1706
return BzrBranch(_format=self,
1707
_control_files=a_bzrdir._control_files,
1709
_repository=a_bzrdir.open_repository())
1712
return "Bazaar-NG branch format 4"
1715
class BranchFormatMetadir(BranchFormat):
1716
"""Common logic for meta-dir based branch formats."""
1718
def _branch_class(self):
1719
"""What class to instantiate on open calls."""
1720
raise NotImplementedError(self._branch_class)
1722
def network_name(self):
1723
"""A simple byte string uniquely identifying this format for RPC calls.
1725
Metadir branch formats use their format string.
1727
return self.get_format_string()
1729
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1730
"""See BranchFormat.open()."""
1732
format = BranchFormat.find_format(a_bzrdir)
1733
if format.__class__ != self.__class__:
1734
raise AssertionError("wrong format %r found for %r" %
1737
transport = a_bzrdir.get_branch_transport(None)
1738
control_files = lockable_files.LockableFiles(transport, 'lock',
1740
return self._branch_class()(_format=self,
1741
_control_files=control_files,
1743
_repository=a_bzrdir.find_repository(),
1744
ignore_fallbacks=ignore_fallbacks)
1745
except errors.NoSuchFile:
1746
raise errors.NotBranchError(path=transport.base)
1749
super(BranchFormatMetadir, self).__init__()
1750
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1751
self._matchingbzrdir.set_branch_format(self)
1753
def supports_tags(self):
1757
class BzrBranchFormat5(BranchFormatMetadir):
1758
"""Bzr branch format 5.
1761
- a revision-history file.
1763
- a lock dir guarding the branch itself
1764
- all of this stored in a branch/ subdirectory
1765
- works with shared repositories.
1767
This format is new in bzr 0.8.
1770
def _branch_class(self):
1773
def get_format_string(self):
1774
"""See BranchFormat.get_format_string()."""
1775
return "Bazaar-NG branch format 5\n"
1777
def get_format_description(self):
1778
"""See BranchFormat.get_format_description()."""
1779
return "Branch format 5"
1781
def initialize(self, a_bzrdir):
1782
"""Create a branch of this format in a_bzrdir."""
1783
utf8_files = [('revision-history', ''),
1784
('branch-name', ''),
1786
return self._initialize_helper(a_bzrdir, utf8_files)
1788
def supports_tags(self):
1792
class BzrBranchFormat6(BranchFormatMetadir):
1793
"""Branch format with last-revision and tags.
1795
Unlike previous formats, this has no explicit revision history. Instead,
1796
this just stores the last-revision, and the left-hand history leading
1797
up to there is the history.
1799
This format was introduced in bzr 0.15
1800
and became the default in 0.91.
1803
def _branch_class(self):
1806
def get_format_string(self):
1807
"""See BranchFormat.get_format_string()."""
1808
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1810
def get_format_description(self):
1811
"""See BranchFormat.get_format_description()."""
1812
return "Branch format 6"
1814
def initialize(self, a_bzrdir):
1815
"""Create a branch of this format in a_bzrdir."""
1816
utf8_files = [('last-revision', '0 null:\n'),
1817
('branch.conf', ''),
1820
return self._initialize_helper(a_bzrdir, utf8_files)
1822
def make_tags(self, branch):
1823
"""See bzrlib.branch.BranchFormat.make_tags()."""
1824
return BasicTags(branch)
1828
class BzrBranchFormat8(BranchFormatMetadir):
1829
"""Metadir format supporting storing locations of subtree branches."""
1831
def _branch_class(self):
1834
def get_format_string(self):
1835
"""See BranchFormat.get_format_string()."""
1836
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1838
def get_format_description(self):
1839
"""See BranchFormat.get_format_description()."""
1840
return "Branch format 8"
1842
def initialize(self, a_bzrdir):
1843
"""Create a branch of this format in a_bzrdir."""
1844
utf8_files = [('last-revision', '0 null:\n'),
1845
('branch.conf', ''),
1849
return self._initialize_helper(a_bzrdir, utf8_files)
1852
super(BzrBranchFormat8, self).__init__()
1853
self._matchingbzrdir.repository_format = \
1854
RepositoryFormatKnitPack5RichRoot()
1856
def make_tags(self, branch):
1857
"""See bzrlib.branch.BranchFormat.make_tags()."""
1858
return BasicTags(branch)
1860
def supports_stacking(self):
1863
supports_reference_locations = True
1866
class BzrBranchFormat7(BzrBranchFormat8):
1867
"""Branch format with last-revision, tags, and a stacked location pointer.
1869
The stacked location pointer is passed down to the repository and requires
1870
a repository format with supports_external_lookups = True.
1872
This format was introduced in bzr 1.6.
1875
def initialize(self, a_bzrdir):
1876
"""Create a branch of this format in a_bzrdir."""
1877
utf8_files = [('last-revision', '0 null:\n'),
1878
('branch.conf', ''),
1881
return self._initialize_helper(a_bzrdir, utf8_files)
1883
def _branch_class(self):
1886
def get_format_string(self):
1887
"""See BranchFormat.get_format_string()."""
1888
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1890
def get_format_description(self):
1891
"""See BranchFormat.get_format_description()."""
1892
return "Branch format 7"
1894
supports_reference_locations = False
1897
class BranchReferenceFormat(BranchFormat):
1898
"""Bzr branch reference format.
1900
Branch references are used in implementing checkouts, they
1901
act as an alias to the real branch which is at some other url.
1908
def get_format_string(self):
1909
"""See BranchFormat.get_format_string()."""
1910
return "Bazaar-NG Branch Reference Format 1\n"
1912
def get_format_description(self):
1913
"""See BranchFormat.get_format_description()."""
1914
return "Checkout reference format 1"
1916
def get_reference(self, a_bzrdir):
1917
"""See BranchFormat.get_reference()."""
1918
transport = a_bzrdir.get_branch_transport(None)
1919
return transport.get('location').read()
1921
def set_reference(self, a_bzrdir, to_branch):
1922
"""See BranchFormat.set_reference()."""
1923
transport = a_bzrdir.get_branch_transport(None)
1924
location = transport.put_bytes('location', to_branch.base)
1926
def initialize(self, a_bzrdir, target_branch=None):
1927
"""Create a branch of this format in a_bzrdir."""
1928
if target_branch is None:
1929
# this format does not implement branch itself, thus the implicit
1930
# creation contract must see it as uninitializable
1931
raise errors.UninitializableFormat(self)
1932
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1933
branch_transport = a_bzrdir.get_branch_transport(self)
1934
branch_transport.put_bytes('location',
1935
target_branch.bzrdir.root_transport.base)
1936
branch_transport.put_bytes('format', self.get_format_string())
1938
a_bzrdir, _found=True,
1939
possible_transports=[target_branch.bzrdir.root_transport])
1942
super(BranchReferenceFormat, self).__init__()
1943
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1944
self._matchingbzrdir.set_branch_format(self)
1946
def _make_reference_clone_function(format, a_branch):
1947
"""Create a clone() routine for a branch dynamically."""
1948
def clone(to_bzrdir, revision_id=None,
1949
repository_policy=None):
1950
"""See Branch.clone()."""
1951
return format.initialize(to_bzrdir, a_branch)
1952
# cannot obey revision_id limits when cloning a reference ...
1953
# FIXME RBC 20060210 either nuke revision_id for clone, or
1954
# emit some sort of warning/error to the caller ?!
1957
def open(self, a_bzrdir, _found=False, location=None,
1958
possible_transports=None, ignore_fallbacks=False):
1959
"""Return the branch that the branch reference in a_bzrdir points at.
1961
:param a_bzrdir: A BzrDir that contains a branch.
1962
:param _found: a private parameter, do not use it. It is used to
1963
indicate if format probing has already be done.
1964
:param ignore_fallbacks: when set, no fallback branches will be opened
1965
(if there are any). Default is to open fallbacks.
1966
:param location: The location of the referenced branch. If
1967
unspecified, this will be determined from the branch reference in
1969
:param possible_transports: An optional reusable transports list.
1972
format = BranchFormat.find_format(a_bzrdir)
1973
if format.__class__ != self.__class__:
1974
raise AssertionError("wrong format %r found for %r" %
1976
if location is None:
1977
location = self.get_reference(a_bzrdir)
1978
real_bzrdir = bzrdir.BzrDir.open(
1979
location, possible_transports=possible_transports)
1980
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1981
# this changes the behaviour of result.clone to create a new reference
1982
# rather than a copy of the content of the branch.
1983
# I did not use a proxy object because that needs much more extensive
1984
# testing, and we are only changing one behaviour at the moment.
1985
# If we decide to alter more behaviours - i.e. the implicit nickname
1986
# then this should be refactored to introduce a tested proxy branch
1987
# and a subclass of that for use in overriding clone() and ....
1989
result.clone = self._make_reference_clone_function(result)
1993
network_format_registry = registry.FormatRegistry()
1994
"""Registry of formats indexed by their network name.
1996
The network name for a branch format is an identifier that can be used when
1997
referring to formats with smart server operations. See
1998
BranchFormat.network_name() for more detail.
2002
# formats which have no format string are not discoverable
2003
# and not independently creatable, so are not registered.
2004
__format5 = BzrBranchFormat5()
2005
__format6 = BzrBranchFormat6()
2006
__format7 = BzrBranchFormat7()
2007
__format8 = BzrBranchFormat8()
2008
BranchFormat.register_format(__format5)
2009
BranchFormat.register_format(BranchReferenceFormat())
2010
BranchFormat.register_format(__format6)
2011
BranchFormat.register_format(__format7)
2012
BranchFormat.register_format(__format8)
2013
BranchFormat.set_default_format(__format6)
2014
_legacy_formats = [BzrBranchFormat4(),
2016
network_format_registry.register(
2017
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2020
class BzrBranch(Branch):
2021
"""A branch stored in the actual filesystem.
2023
Note that it's "local" in the context of the filesystem; it doesn't
2024
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2025
it's writable, and can be accessed via the normal filesystem API.
2027
:ivar _transport: Transport for file operations on this branch's
2028
control files, typically pointing to the .bzr/branch directory.
2029
:ivar repository: Repository for this branch.
2030
:ivar base: The url of the base directory for this branch; the one
2031
containing the .bzr directory.
2034
def __init__(self, _format=None,
2035
_control_files=None, a_bzrdir=None, _repository=None,
2036
ignore_fallbacks=False):
2037
"""Create new branch object at a particular location."""
2038
if a_bzrdir is None:
2039
raise ValueError('a_bzrdir must be supplied')
2041
self.bzrdir = a_bzrdir
2042
self._base = self.bzrdir.transport.clone('..').base
2043
# XXX: We should be able to just do
2044
# self.base = self.bzrdir.root_transport.base
2045
# but this does not quite work yet -- mbp 20080522
2046
self._format = _format
2047
if _control_files is None:
2048
raise ValueError('BzrBranch _control_files is None')
2049
self.control_files = _control_files
2050
self._transport = _control_files._transport
2051
self.repository = _repository
2052
Branch.__init__(self)
2055
return '%s(%r)' % (self.__class__.__name__, self.base)
2059
def _get_base(self):
2060
"""Returns the directory containing the control directory."""
2063
base = property(_get_base, doc="The URL for the root of this branch.")
2065
def _get_config(self):
2066
return TransportConfig(self._transport, 'branch.conf')
2068
def is_locked(self):
2069
return self.control_files.is_locked()
2071
def lock_write(self, token=None):
2072
# All-in-one needs to always unlock/lock.
2073
repo_control = getattr(self.repository, 'control_files', None)
2074
if self.control_files == repo_control or not self.is_locked():
2075
self.repository.lock_write()
2080
return self.control_files.lock_write(token=token)
2083
self.repository.unlock()
2086
def lock_read(self):
2087
# All-in-one needs to always unlock/lock.
2088
repo_control = getattr(self.repository, 'control_files', None)
2089
if self.control_files == repo_control or not self.is_locked():
2090
self.repository.lock_read()
2095
self.control_files.lock_read()
2098
self.repository.unlock()
2103
self.control_files.unlock()
2105
# All-in-one needs to always unlock/lock.
2106
repo_control = getattr(self.repository, 'control_files', None)
2107
if (self.control_files == repo_control or
2108
not self.control_files.is_locked()):
2109
self.repository.unlock()
2110
if not self.control_files.is_locked():
2111
# we just released the lock
2112
self._clear_cached_state()
2114
def peek_lock_mode(self):
2115
if self.control_files._lock_count == 0:
2118
return self.control_files._lock_mode
2120
def get_physical_lock_status(self):
2121
return self.control_files.get_physical_lock_status()
2124
def print_file(self, file, revision_id):
2125
"""See Branch.print_file."""
2126
return self.repository.print_file(file, revision_id)
2128
def _write_revision_history(self, history):
2129
"""Factored out of set_revision_history.
2131
This performs the actual writing to disk.
2132
It is intended to be called by BzrBranch5.set_revision_history."""
2133
self._transport.put_bytes(
2134
'revision-history', '\n'.join(history),
2135
mode=self.bzrdir._get_file_mode())
2138
def set_revision_history(self, rev_history):
2139
"""See Branch.set_revision_history."""
2140
if 'evil' in debug.debug_flags:
2141
mutter_callsite(3, "set_revision_history scales with history.")
2142
check_not_reserved_id = _mod_revision.check_not_reserved_id
2143
for rev_id in rev_history:
2144
check_not_reserved_id(rev_id)
2145
if Branch.hooks['post_change_branch_tip']:
2146
# Don't calculate the last_revision_info() if there are no hooks
2148
old_revno, old_revid = self.last_revision_info()
2149
if len(rev_history) == 0:
2150
revid = _mod_revision.NULL_REVISION
2152
revid = rev_history[-1]
2153
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2154
self._write_revision_history(rev_history)
2155
self._clear_cached_state()
2156
self._cache_revision_history(rev_history)
2157
for hook in Branch.hooks['set_rh']:
2158
hook(self, rev_history)
2159
if Branch.hooks['post_change_branch_tip']:
2160
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2162
def _synchronize_history(self, destination, revision_id):
2163
"""Synchronize last revision and revision history between branches.
2165
This version is most efficient when the destination is also a
2166
BzrBranch5, but works for BzrBranch6 as long as the revision
2167
history is the true lefthand parent history, and all of the revisions
2168
are in the destination's repository. If not, set_revision_history
2171
:param destination: The branch to copy the history into
2172
:param revision_id: The revision-id to truncate history at. May
2173
be None to copy complete history.
2175
if not isinstance(destination._format, BzrBranchFormat5):
2176
super(BzrBranch, self)._synchronize_history(
2177
destination, revision_id)
2179
if revision_id == _mod_revision.NULL_REVISION:
2182
new_history = self.revision_history()
2183
if revision_id is not None and new_history != []:
2185
new_history = new_history[:new_history.index(revision_id) + 1]
2187
rev = self.repository.get_revision(revision_id)
2188
new_history = rev.get_history(self.repository)[1:]
2189
destination.set_revision_history(new_history)
2192
def set_last_revision_info(self, revno, revision_id):
2193
"""Set the last revision of this branch.
2195
The caller is responsible for checking that the revno is correct
2196
for this revision id.
2198
It may be possible to set the branch last revision to an id not
2199
present in the repository. However, branches can also be
2200
configured to check constraints on history, in which case this may not
2203
revision_id = _mod_revision.ensure_null(revision_id)
2204
# this old format stores the full history, but this api doesn't
2205
# provide it, so we must generate, and might as well check it's
2207
history = self._lefthand_history(revision_id)
2208
if len(history) != revno:
2209
raise AssertionError('%d != %d' % (len(history), revno))
2210
self.set_revision_history(history)
2212
def _gen_revision_history(self):
2213
history = self._transport.get_bytes('revision-history').split('\n')
2214
if history[-1:] == ['']:
2215
# There shouldn't be a trailing newline, but just in case.
2220
def generate_revision_history(self, revision_id, last_rev=None,
2222
"""Create a new revision history that will finish with revision_id.
2224
:param revision_id: the new tip to use.
2225
:param last_rev: The previous last_revision. If not None, then this
2226
must be a ancestory of revision_id, or DivergedBranches is raised.
2227
:param other_branch: The other branch that DivergedBranches should
2228
raise with respect to.
2230
self.set_revision_history(self._lefthand_history(revision_id,
2231
last_rev, other_branch))
2233
def basis_tree(self):
2234
"""See Branch.basis_tree."""
2235
return self.repository.revision_tree(self.last_revision())
2237
def _get_parent_location(self):
2238
_locs = ['parent', 'pull', 'x-pull']
2241
return self._transport.get_bytes(l).strip('\n')
2242
except errors.NoSuchFile:
2246
def _basic_push(self, target, overwrite, stop_revision):
2247
"""Basic implementation of push without bound branches or hooks.
2249
Must be called with source read locked and target write locked.
2251
result = BranchPushResult()
2252
result.source_branch = self
2253
result.target_branch = target
2254
result.old_revno, result.old_revid = target.last_revision_info()
2255
self.update_references(target)
2256
if result.old_revid != self.last_revision():
2257
# We assume that during 'push' this repository is closer than
2259
graph = self.repository.get_graph(target.repository)
2260
target.update_revisions(self, stop_revision,
2261
overwrite=overwrite, graph=graph)
2262
if self._push_should_merge_tags():
2263
result.tag_conflicts = self.tags.merge_to(target.tags,
2265
result.new_revno, result.new_revid = target.last_revision_info()
2268
def get_stacked_on_url(self):
2269
raise errors.UnstackableBranchFormat(self._format, self.base)
2271
def set_push_location(self, location):
2272
"""See Branch.set_push_location."""
2273
self.get_config().set_user_option(
2274
'push_location', location,
2275
store=_mod_config.STORE_LOCATION_NORECURSE)
2277
def _set_parent_location(self, url):
2279
self._transport.delete('parent')
2281
self._transport.put_bytes('parent', url + '\n',
2282
mode=self.bzrdir._get_file_mode())
2285
class BzrBranch5(BzrBranch):
2286
"""A format 5 branch. This supports new features over plain branches.
2288
It has support for a master_branch which is the data for bound branches.
2291
def get_bound_location(self):
2293
return self._transport.get_bytes('bound')[:-1]
2294
except errors.NoSuchFile:
2298
def get_master_branch(self, possible_transports=None):
2299
"""Return the branch we are bound to.
2301
:return: Either a Branch, or None
2303
This could memoise the branch, but if thats done
2304
it must be revalidated on each new lock.
2305
So for now we just don't memoise it.
2306
# RBC 20060304 review this decision.
2308
bound_loc = self.get_bound_location()
2312
return Branch.open(bound_loc,
2313
possible_transports=possible_transports)
2314
except (errors.NotBranchError, errors.ConnectionError), e:
2315
raise errors.BoundBranchConnectionFailure(
2319
def set_bound_location(self, location):
2320
"""Set the target where this branch is bound to.
2322
:param location: URL to the target branch
2325
self._transport.put_bytes('bound', location+'\n',
2326
mode=self.bzrdir._get_file_mode())
2329
self._transport.delete('bound')
2330
except errors.NoSuchFile:
2335
def bind(self, other):
2336
"""Bind this branch to the branch other.
2338
This does not push or pull data between the branches, though it does
2339
check for divergence to raise an error when the branches are not
2340
either the same, or one a prefix of the other. That behaviour may not
2341
be useful, so that check may be removed in future.
2343
:param other: The branch to bind to
2346
# TODO: jam 20051230 Consider checking if the target is bound
2347
# It is debatable whether you should be able to bind to
2348
# a branch which is itself bound.
2349
# Committing is obviously forbidden,
2350
# but binding itself may not be.
2351
# Since we *have* to check at commit time, we don't
2352
# *need* to check here
2354
# we want to raise diverged if:
2355
# last_rev is not in the other_last_rev history, AND
2356
# other_last_rev is not in our history, and do it without pulling
2358
self.set_bound_location(other.base)
2362
"""If bound, unbind"""
2363
return self.set_bound_location(None)
2366
def update(self, possible_transports=None):
2367
"""Synchronise this branch with the master branch if any.
2369
:return: None or the last_revision that was pivoted out during the
2372
master = self.get_master_branch(possible_transports)
2373
if master is not None:
2374
old_tip = _mod_revision.ensure_null(self.last_revision())
2375
self.pull(master, overwrite=True)
2376
if self.repository.get_graph().is_ancestor(old_tip,
2377
_mod_revision.ensure_null(self.last_revision())):
2383
class BzrBranch8(BzrBranch5):
2384
"""A branch that stores tree-reference locations."""
2386
def _open_hook(self):
2387
if self._ignore_fallbacks:
2390
url = self.get_stacked_on_url()
2391
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2392
errors.UnstackableBranchFormat):
2395
for hook in Branch.hooks['transform_fallback_location']:
2396
url = hook(self, url)
2398
hook_name = Branch.hooks.get_hook_name(hook)
2399
raise AssertionError(
2400
"'transform_fallback_location' hook %s returned "
2401
"None, not a URL." % hook_name)
2402
self._activate_fallback_location(url)
2404
def __init__(self, *args, **kwargs):
2405
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2406
super(BzrBranch8, self).__init__(*args, **kwargs)
2407
self._last_revision_info_cache = None
2408
self._reference_info = None
2410
def _clear_cached_state(self):
2411
super(BzrBranch8, self)._clear_cached_state()
2412
self._last_revision_info_cache = None
2413
self._reference_info = None
2415
def _last_revision_info(self):
2416
revision_string = self._transport.get_bytes('last-revision')
2417
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2418
revision_id = cache_utf8.get_cached_utf8(revision_id)
2420
return revno, revision_id
2422
def _write_last_revision_info(self, revno, revision_id):
2423
"""Simply write out the revision id, with no checks.
2425
Use set_last_revision_info to perform this safely.
2427
Does not update the revision_history cache.
2428
Intended to be called by set_last_revision_info and
2429
_write_revision_history.
2431
revision_id = _mod_revision.ensure_null(revision_id)
2432
out_string = '%d %s\n' % (revno, revision_id)
2433
self._transport.put_bytes('last-revision', out_string,
2434
mode=self.bzrdir._get_file_mode())
2437
def set_last_revision_info(self, revno, revision_id):
2438
revision_id = _mod_revision.ensure_null(revision_id)
2439
old_revno, old_revid = self.last_revision_info()
2440
if self._get_append_revisions_only():
2441
self._check_history_violation(revision_id)
2442
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2443
self._write_last_revision_info(revno, revision_id)
2444
self._clear_cached_state()
2445
self._last_revision_info_cache = revno, revision_id
2446
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2448
def _synchronize_history(self, destination, revision_id):
2449
"""Synchronize last revision and revision history between branches.
2451
:see: Branch._synchronize_history
2453
# XXX: The base Branch has a fast implementation of this method based
2454
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2455
# that uses set_revision_history. This class inherits from BzrBranch5,
2456
# but wants the fast implementation, so it calls
2457
# Branch._synchronize_history directly.
2458
Branch._synchronize_history(self, destination, revision_id)
2460
def _check_history_violation(self, revision_id):
2461
last_revision = _mod_revision.ensure_null(self.last_revision())
2462
if _mod_revision.is_null(last_revision):
2464
if last_revision not in self._lefthand_history(revision_id):
2465
raise errors.AppendRevisionsOnlyViolation(self.base)
2467
def _gen_revision_history(self):
2468
"""Generate the revision history from last revision
2470
last_revno, last_revision = self.last_revision_info()
2471
self._extend_partial_history(stop_index=last_revno-1)
2472
return list(reversed(self._partial_revision_history_cache))
2474
def _write_revision_history(self, history):
2475
"""Factored out of set_revision_history.
2477
This performs the actual writing to disk, with format-specific checks.
2478
It is intended to be called by BzrBranch5.set_revision_history.
2480
if len(history) == 0:
2481
last_revision = 'null:'
2483
if history != self._lefthand_history(history[-1]):
2484
raise errors.NotLefthandHistory(history)
2485
last_revision = history[-1]
2486
if self._get_append_revisions_only():
2487
self._check_history_violation(last_revision)
2488
self._write_last_revision_info(len(history), last_revision)
2491
def _set_parent_location(self, url):
2492
"""Set the parent branch"""
2493
self._set_config_location('parent_location', url, make_relative=True)
2496
def _get_parent_location(self):
2497
"""Set the parent branch"""
2498
return self._get_config_location('parent_location')
2501
def _set_all_reference_info(self, info_dict):
2502
"""Replace all reference info stored in a branch.
2504
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2507
writer = rio.RioWriter(s)
2508
for key, (tree_path, branch_location) in info_dict.iteritems():
2509
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2510
branch_location=branch_location)
2511
writer.write_stanza(stanza)
2512
self._transport.put_bytes('references', s.getvalue())
2513
self._reference_info = info_dict
2516
def _get_all_reference_info(self):
2517
"""Return all the reference info stored in a branch.
2519
:return: A dict of {file_id: (tree_path, branch_location)}
2521
if self._reference_info is not None:
2522
return self._reference_info
2523
rio_file = self._transport.get('references')
2525
stanzas = rio.read_stanzas(rio_file)
2526
info_dict = dict((s['file_id'], (s['tree_path'],
2527
s['branch_location'])) for s in stanzas)
2530
self._reference_info = info_dict
2533
def set_reference_info(self, file_id, tree_path, branch_location):
2534
"""Set the branch location to use for a tree reference.
2536
:param file_id: The file-id of the tree reference.
2537
:param tree_path: The path of the tree reference in the tree.
2538
:param branch_location: The location of the branch to retrieve tree
2541
info_dict = self._get_all_reference_info()
2542
info_dict[file_id] = (tree_path, branch_location)
2543
if None in (tree_path, branch_location):
2544
if tree_path is not None:
2545
raise ValueError('tree_path must be None when branch_location'
2547
if branch_location is not None:
2548
raise ValueError('branch_location must be None when tree_path'
2550
del info_dict[file_id]
2551
self._set_all_reference_info(info_dict)
2553
def get_reference_info(self, file_id):
2554
"""Get the tree_path and branch_location for a tree reference.
2556
:return: a tuple of (tree_path, branch_location)
2558
return self._get_all_reference_info().get(file_id, (None, None))
2560
def reference_parent(self, file_id, path, possible_transports=None):
2561
"""Return the parent branch for a tree-reference file_id.
2563
:param file_id: The file_id of the tree reference
2564
:param path: The path of the file_id in the tree
2565
:return: A branch associated with the file_id
2567
branch_location = self.get_reference_info(file_id)[1]
2568
if branch_location is None:
2569
return Branch.reference_parent(self, file_id, path,
2570
possible_transports)
2571
branch_location = urlutils.join(self.base, branch_location)
2572
return Branch.open(branch_location,
2573
possible_transports=possible_transports)
2575
def set_push_location(self, location):
2576
"""See Branch.set_push_location."""
2577
self._set_config_location('push_location', location)
2579
def set_bound_location(self, location):
2580
"""See Branch.set_push_location."""
2582
config = self.get_config()
2583
if location is None:
2584
if config.get_user_option('bound') != 'True':
2587
config.set_user_option('bound', 'False', warn_masked=True)
2590
self._set_config_location('bound_location', location,
2592
config.set_user_option('bound', 'True', warn_masked=True)
2595
def _get_bound_location(self, bound):
2596
"""Return the bound location in the config file.
2598
Return None if the bound parameter does not match"""
2599
config = self.get_config()
2600
config_bound = (config.get_user_option('bound') == 'True')
2601
if config_bound != bound:
2603
return self._get_config_location('bound_location', config=config)
2605
def get_bound_location(self):
2606
"""See Branch.set_push_location."""
2607
return self._get_bound_location(True)
2609
def get_old_bound_location(self):
2610
"""See Branch.get_old_bound_location"""
2611
return self._get_bound_location(False)
2613
def get_stacked_on_url(self):
2614
# you can always ask for the URL; but you might not be able to use it
2615
# if the repo can't support stacking.
2616
## self._check_stackable_repo()
2617
stacked_url = self._get_config_location('stacked_on_location')
2618
if stacked_url is None:
2619
raise errors.NotStacked(self)
2622
def set_append_revisions_only(self, enabled):
2627
self.get_config().set_user_option('append_revisions_only', value,
2630
def _get_append_revisions_only(self):
2631
value = self.get_config().get_user_option('append_revisions_only')
2632
return value == 'True'
2635
def generate_revision_history(self, revision_id, last_rev=None,
2637
"""See BzrBranch5.generate_revision_history"""
2638
history = self._lefthand_history(revision_id, last_rev, other_branch)
2639
revno = len(history)
2640
self.set_last_revision_info(revno, revision_id)
2643
def get_rev_id(self, revno, history=None):
2644
"""Find the revision id of the specified revno."""
2646
return _mod_revision.NULL_REVISION
2648
last_revno, last_revision_id = self.last_revision_info()
2649
if revno <= 0 or revno > last_revno:
2650
raise errors.NoSuchRevision(self, revno)
2652
if history is not None:
2653
return history[revno - 1]
2655
index = last_revno - revno
2656
if len(self._partial_revision_history_cache) <= index:
2657
self._extend_partial_history(stop_index=index)
2658
if len(self._partial_revision_history_cache) > index:
2659
return self._partial_revision_history_cache[index]
2661
raise errors.NoSuchRevision(self, revno)
2664
def revision_id_to_revno(self, revision_id):
2665
"""Given a revision id, return its revno"""
2666
if _mod_revision.is_null(revision_id):
2669
index = self._partial_revision_history_cache.index(revision_id)
2671
self._extend_partial_history(stop_revision=revision_id)
2672
index = len(self._partial_revision_history_cache) - 1
2673
if self._partial_revision_history_cache[index] != revision_id:
2674
raise errors.NoSuchRevision(self, revision_id)
2675
return self.revno() - index
2678
class BzrBranch7(BzrBranch8):
2679
"""A branch with support for a fallback repository."""
2681
def set_reference_info(self, file_id, tree_path, branch_location):
2682
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2684
def get_reference_info(self, file_id):
2685
Branch.get_reference_info(self, file_id)
2687
def reference_parent(self, file_id, path, possible_transports=None):
2688
return Branch.reference_parent(self, file_id, path,
2689
possible_transports)
2692
class BzrBranch6(BzrBranch7):
2693
"""See BzrBranchFormat6 for the capabilities of this branch.
2695
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2699
def get_stacked_on_url(self):
2700
raise errors.UnstackableBranchFormat(self._format, self.base)
2703
######################################################################
2704
# results of operations
2707
class _Result(object):
2709
def _show_tag_conficts(self, to_file):
2710
if not getattr(self, 'tag_conflicts', None):
2712
to_file.write('Conflicting tags:\n')
2713
for name, value1, value2 in self.tag_conflicts:
2714
to_file.write(' %s\n' % (name, ))
2717
class PullResult(_Result):
2718
"""Result of a Branch.pull operation.
2720
:ivar old_revno: Revision number before pull.
2721
:ivar new_revno: Revision number after pull.
2722
:ivar old_revid: Tip revision id before pull.
2723
:ivar new_revid: Tip revision id after pull.
2724
:ivar source_branch: Source (local) branch object. (read locked)
2725
:ivar master_branch: Master branch of the target, or the target if no
2727
:ivar local_branch: target branch if there is a Master, else None
2728
:ivar target_branch: Target/destination branch object. (write locked)
2729
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2733
# DEPRECATED: pull used to return the change in revno
2734
return self.new_revno - self.old_revno
2736
def report(self, to_file):
2738
if self.old_revid == self.new_revid:
2739
to_file.write('No revisions to pull.\n')
2741
to_file.write('Now on revision %d.\n' % self.new_revno)
2742
self._show_tag_conficts(to_file)
2745
class BranchPushResult(_Result):
2746
"""Result of a Branch.push operation.
2748
:ivar old_revno: Revision number (eg 10) of the target before push.
2749
:ivar new_revno: Revision number (eg 12) of the target after push.
2750
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2752
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2754
:ivar source_branch: Source branch object that the push was from. This is
2755
read locked, and generally is a local (and thus low latency) branch.
2756
:ivar master_branch: If target is a bound branch, the master branch of
2757
target, or target itself. Always write locked.
2758
:ivar target_branch: The direct Branch where data is being sent (write
2760
:ivar local_branch: If the target is a bound branch this will be the
2761
target, otherwise it will be None.
2765
# DEPRECATED: push used to return the change in revno
2766
return self.new_revno - self.old_revno
2768
def report(self, to_file):
2769
"""Write a human-readable description of the result."""
2770
if self.old_revid == self.new_revid:
2771
note('No new revisions to push.')
2773
note('Pushed up to revision %d.' % self.new_revno)
2774
self._show_tag_conficts(to_file)
2777
class BranchCheckResult(object):
2778
"""Results of checking branch consistency.
2783
def __init__(self, branch):
2784
self.branch = branch
2785
self.ghosts_in_mainline = False
2787
def report_results(self, verbose):
2788
"""Report the check results via trace.note.
2790
:param verbose: Requests more detailed display of what was checked,
2793
note('checked branch %s format %s',
2795
self.branch._format)
2796
if self.ghosts_in_mainline:
2797
note('branch contains ghosts in mainline')
2800
class Converter5to6(object):
2801
"""Perform an in-place upgrade of format 5 to format 6"""
2803
def convert(self, branch):
2804
# Data for 5 and 6 can peacefully coexist.
2805
format = BzrBranchFormat6()
2806
new_branch = format.open(branch.bzrdir, _found=True)
2808
# Copy source data into target
2809
new_branch._write_last_revision_info(*branch.last_revision_info())
2810
new_branch.set_parent(branch.get_parent())
2811
new_branch.set_bound_location(branch.get_bound_location())
2812
new_branch.set_push_location(branch.get_push_location())
2814
# New branch has no tags by default
2815
new_branch.tags._set_tag_dict({})
2817
# Copying done; now update target format
2818
new_branch._transport.put_bytes('format',
2819
format.get_format_string(),
2820
mode=new_branch.bzrdir._get_file_mode())
2822
# Clean up old files
2823
new_branch._transport.delete('revision-history')
2825
branch.set_parent(None)
2826
except errors.NoSuchFile:
2828
branch.set_bound_location(None)
2831
class Converter6to7(object):
2832
"""Perform an in-place upgrade of format 6 to format 7"""
2834
def convert(self, branch):
2835
format = BzrBranchFormat7()
2836
branch._set_config_location('stacked_on_location', '')
2837
# update target format
2838
branch._transport.put_bytes('format', format.get_format_string())
2841
class Converter7to8(object):
2842
"""Perform an in-place upgrade of format 6 to format 7"""
2844
def convert(self, branch):
2845
format = BzrBranchFormat8()
2846
branch._transport.put_bytes('references', '')
2847
# update target format
2848
branch._transport.put_bytes('format', format.get_format_string())
2851
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2852
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2855
_run_with_write_locked_target will attempt to release the lock it acquires.
2857
If an exception is raised by callable, then that exception *will* be
2858
propagated, even if the unlock attempt raises its own error. Thus
2859
_run_with_write_locked_target should be preferred to simply doing::
2863
return callable(*args, **kwargs)
2868
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2869
# should share code?
2872
result = callable(*args, **kwargs)
2874
exc_info = sys.exc_info()
2878
raise exc_info[0], exc_info[1], exc_info[2]
2884
class InterBranch(InterObject):
2885
"""This class represents operations taking place between two branches.
2887
Its instances have methods like pull() and push() and contain
2888
references to the source and target repositories these operations
2889
can be carried out on.
2893
"""The available optimised InterBranch types."""
2896
def _get_branch_formats_to_test():
2897
"""Return a tuple with the Branch formats to use when testing."""
2898
raise NotImplementedError(self._get_branch_formats_to_test)
2900
def pull(self, overwrite=False, stop_revision=None,
2901
possible_transports=None, local=False):
2902
"""Mirror source into target branch.
2904
The target branch is considered to be 'local', having low latency.
2906
:returns: PullResult instance
2908
raise NotImplementedError(self.pull)
2910
def update_revisions(self, stop_revision=None, overwrite=False,
2912
"""Pull in new perfect-fit revisions.
2914
:param stop_revision: Updated until the given revision
2915
:param overwrite: Always set the branch pointer, rather than checking
2916
to see if it is a proper descendant.
2917
:param graph: A Graph object that can be used to query history
2918
information. This can be None.
2921
raise NotImplementedError(self.update_revisions)
2923
def push(self, overwrite=False, stop_revision=None,
2924
_override_hook_source_branch=None):
2925
"""Mirror the source branch into the target branch.
2927
The source branch is considered to be 'local', having low latency.
2929
raise NotImplementedError(self.push)
2932
class GenericInterBranch(InterBranch):
2933
"""InterBranch implementation that uses public Branch functions.
2937
def _get_branch_formats_to_test():
2938
return BranchFormat._default_format, BranchFormat._default_format
2940
def update_revisions(self, stop_revision=None, overwrite=False,
2942
"""See InterBranch.update_revisions()."""
2943
self.source.lock_read()
2945
other_revno, other_last_revision = self.source.last_revision_info()
2946
stop_revno = None # unknown
2947
if stop_revision is None:
2948
stop_revision = other_last_revision
2949
if _mod_revision.is_null(stop_revision):
2950
# if there are no commits, we're done.
2952
stop_revno = other_revno
2954
# what's the current last revision, before we fetch [and change it
2956
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2957
# we fetch here so that we don't process data twice in the common
2958
# case of having something to pull, and so that the check for
2959
# already merged can operate on the just fetched graph, which will
2960
# be cached in memory.
2961
self.target.fetch(self.source, stop_revision)
2962
# Check to see if one is an ancestor of the other
2965
graph = self.target.repository.get_graph()
2966
if self.target._check_if_descendant_or_diverged(
2967
stop_revision, last_rev, graph, self.source):
2968
# stop_revision is a descendant of last_rev, but we aren't
2969
# overwriting, so we're done.
2971
if stop_revno is None:
2973
graph = self.target.repository.get_graph()
2974
this_revno, this_last_revision = \
2975
self.target.last_revision_info()
2976
stop_revno = graph.find_distance_to_null(stop_revision,
2977
[(other_last_revision, other_revno),
2978
(this_last_revision, this_revno)])
2979
self.target.set_last_revision_info(stop_revno, stop_revision)
2981
self.source.unlock()
2983
def pull(self, overwrite=False, stop_revision=None,
2984
possible_transports=None, _hook_master=None, run_hooks=True,
2985
_override_hook_target=None, local=False):
2988
:param _hook_master: Private parameter - set the branch to
2989
be supplied as the master to pull hooks.
2990
:param run_hooks: Private parameter - if false, this branch
2991
is being called because it's the master of the primary branch,
2992
so it should not run its hooks.
2993
:param _override_hook_target: Private parameter - set the branch to be
2994
supplied as the target_branch to pull hooks.
2995
:param local: Only update the local branch, and not the bound branch.
2997
# This type of branch can't be bound.
2999
raise errors.LocalRequiresBoundBranch()
3000
result = PullResult()
3001
result.source_branch = self.source
3002
if _override_hook_target is None:
3003
result.target_branch = self.target
3005
result.target_branch = _override_hook_target
3006
self.source.lock_read()
3008
# We assume that during 'pull' the target repository is closer than
3010
self.source.update_references(self.target)
3011
graph = self.target.repository.get_graph(self.source.repository)
3012
# TODO: Branch formats should have a flag that indicates
3013
# that revno's are expensive, and pull() should honor that flag.
3015
result.old_revno, result.old_revid = \
3016
self.target.last_revision_info()
3017
self.target.update_revisions(self.source, stop_revision,
3018
overwrite=overwrite, graph=graph)
3019
# TODO: The old revid should be specified when merging tags,
3020
# so a tags implementation that versions tags can only
3021
# pull in the most recent changes. -- JRV20090506
3022
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3024
result.new_revno, result.new_revid = self.target.last_revision_info()
3026
result.master_branch = _hook_master
3027
result.local_branch = result.target_branch
3029
result.master_branch = result.target_branch
3030
result.local_branch = None
3032
for hook in Branch.hooks['post_pull']:
3035
self.source.unlock()
3038
def push(self, overwrite=False, stop_revision=None,
3039
_override_hook_source_branch=None):
3040
"""See InterBranch.push.
3042
This is the basic concrete implementation of push()
3044
:param _override_hook_source_branch: If specified, run
3045
the hooks passing this Branch as the source, rather than self.
3046
This is for use of RemoteBranch, where push is delegated to the
3047
underlying vfs-based Branch.
3049
# TODO: Public option to disable running hooks - should be trivial but
3051
self.source.lock_read()
3053
return _run_with_write_locked_target(
3054
self.target, self._push_with_bound_branches, overwrite,
3056
_override_hook_source_branch=_override_hook_source_branch)
3058
self.source.unlock()
3061
def _push_with_bound_branches(self, overwrite, stop_revision,
3062
_override_hook_source_branch=None):
3063
"""Push from source into target, and into target's master if any.
3066
if _override_hook_source_branch:
3067
result.source_branch = _override_hook_source_branch
3068
for hook in Branch.hooks['post_push']:
3071
bound_location = self.target.get_bound_location()
3072
if bound_location and self.target.base != bound_location:
3073
# there is a master branch.
3075
# XXX: Why the second check? Is it even supported for a branch to
3076
# be bound to itself? -- mbp 20070507
3077
master_branch = self.target.get_master_branch()
3078
master_branch.lock_write()
3080
# push into the master from the source branch.
3081
self.source._basic_push(master_branch, overwrite, stop_revision)
3082
# and push into the target branch from the source. Note that we
3083
# push from the source branch again, because its considered the
3084
# highest bandwidth repository.
3085
result = self.source._basic_push(self.target, overwrite,
3087
result.master_branch = master_branch
3088
result.local_branch = self.target
3092
master_branch.unlock()
3095
result = self.source._basic_push(self.target, overwrite,
3097
# TODO: Why set master_branch and local_branch if there's no
3098
# binding? Maybe cleaner to just leave them unset? -- mbp
3100
result.master_branch = self.target
3101
result.local_branch = None
3106
def is_compatible(self, source, target):
3107
# GenericBranch uses the public API, so always compatible
3111
class InterToBranch5(GenericInterBranch):
3114
def _get_branch_formats_to_test():
3115
return BranchFormat._default_format, BzrBranchFormat5()
3117
def pull(self, overwrite=False, stop_revision=None,
3118
possible_transports=None, run_hooks=True,
3119
_override_hook_target=None, local=False):
3120
"""Pull from source into self, updating my master if any.
3122
:param run_hooks: Private parameter - if false, this branch
3123
is being called because it's the master of the primary branch,
3124
so it should not run its hooks.
3126
bound_location = self.target.get_bound_location()
3127
if local and not bound_location:
3128
raise errors.LocalRequiresBoundBranch()
3129
master_branch = None
3130
if not local and bound_location and self.source.base != bound_location:
3131
# not pulling from master, so we need to update master.
3132
master_branch = self.target.get_master_branch(possible_transports)
3133
master_branch.lock_write()
3136
# pull from source into master.
3137
master_branch.pull(self.source, overwrite, stop_revision,
3139
return super(InterToBranch5, self).pull(overwrite,
3140
stop_revision, _hook_master=master_branch,
3141
run_hooks=run_hooks,
3142
_override_hook_target=_override_hook_target)
3145
master_branch.unlock()
3148
InterBranch.register_optimiser(GenericInterBranch)
3149
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
