1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib import registry
53
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
# TODO: Maybe include checks for common corruption of newlines, etc?
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas. We could perhaps have a weakref
69
# cache in memory to make this faster. In general anything can be
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
74
######################################################################
78
"""Branch holding a history of revisions.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._last_revision_info_cache = None
95
self._merge_sorted_revisions_cache = None
97
hooks = Branch.hooks['open']
101
def _open_hook(self):
102
"""Called by init to allow simpler extension of the base class."""
104
def _activate_fallback_location(self, url, lock_style):
105
"""Activate the branch/repository from url as a fallback repository."""
106
repo = self._get_fallback_repository(url)
107
if lock_style == 'write':
109
elif lock_style == 'read':
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
133
def open(base, _unsupported=False, possible_transports=None):
134
"""Open the branch rooted at base.
136
For instance, if the branch is at URL/.bzr/branch,
137
Branch.open(URL) -> a Branch instance.
139
control = bzrdir.BzrDir.open(base, _unsupported,
140
possible_transports=possible_transports)
141
return control.open_branch(_unsupported)
144
def open_from_transport(transport, _unsupported=False):
145
"""Open the branch rooted at transport"""
146
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
147
return control.open_branch(_unsupported)
150
def open_containing(url, possible_transports=None):
151
"""Open an existing branch which contains url.
153
This probes for a branch at url, and searches upwards from there.
155
Basically we keep looking up until we find the control directory or
156
run into the root. If there isn't one, raises NotBranchError.
157
If there is one and it is either an unrecognised format or an unsupported
158
format, UnknownFormatError or UnsupportedFormatError are raised.
159
If there is one, it is returned, along with the unused portion of url.
161
control, relpath = bzrdir.BzrDir.open_containing(url,
163
return control.open_branch(), relpath
165
def _push_should_merge_tags(self):
166
"""Should _basic_push merge this branch's tags into the target?
168
The default implementation returns False if this branch has no tags,
169
and True the rest of the time. Subclasses may override this.
171
return self.supports_tags() and self.tags.get_tag_dict()
173
def get_config(self):
174
return BranchConfig(self)
176
def _get_config(self):
177
"""Get the concrete config for just the config in this branch.
179
This is not intended for client use; see Branch.get_config for the
184
:return: An object supporting get_option and set_option.
186
raise NotImplementedError(self._get_config)
188
def _get_fallback_repository(self, url):
189
"""Get the repository we fallback to at url."""
190
url = urlutils.join(self.base, url)
191
a_bzrdir = bzrdir.BzrDir.open(url,
192
possible_transports=[self.bzrdir.root_transport])
193
return a_bzrdir.open_branch().repository
195
def _get_tags_bytes(self):
196
"""Get the bytes of a serialised tags dict.
198
Note that not all branches support tags, nor do all use the same tags
199
logic: this method is specific to BasicTags. Other tag implementations
200
may use the same method name and behave differently, safely, because
201
of the double-dispatch via
202
format.make_tags->tags_instance->get_tags_dict.
204
:return: The bytes of the tags file.
205
:seealso: Branch._set_tags_bytes.
207
return self._transport.get_bytes('tags')
209
def _get_nick(self, local=False, possible_transports=None):
210
config = self.get_config()
211
# explicit overrides master, but don't look for master if local is True
212
if not local and not config.has_explicit_nickname():
214
master = self.get_master_branch(possible_transports)
215
if master is not None:
216
# return the master branch value
218
except errors.BzrError, e:
219
# Silently fall back to local implicit nick if the master is
221
mutter("Could not connect to bound branch, "
222
"falling back to local nick.\n " + str(e))
223
return config.get_nickname()
225
def _set_nick(self, nick):
226
self.get_config().set_user_option('nickname', nick, warn_masked=True)
228
nick = property(_get_nick, _set_nick)
231
raise NotImplementedError(self.is_locked)
233
def _lefthand_history(self, revision_id, last_rev=None,
235
if 'evil' in debug.debug_flags:
236
mutter_callsite(4, "_lefthand_history scales with history.")
237
# stop_revision must be a descendant of last_revision
238
graph = self.repository.get_graph()
239
if last_rev is not None:
240
if not graph.is_ancestor(last_rev, revision_id):
241
# our previous tip is not merged into stop_revision
242
raise errors.DivergedBranches(self, other_branch)
243
# make a new revision history from the graph
244
parents_map = graph.get_parent_map([revision_id])
245
if revision_id not in parents_map:
246
raise errors.NoSuchRevision(self, revision_id)
247
current_rev_id = revision_id
249
check_not_reserved_id = _mod_revision.check_not_reserved_id
250
# Do not include ghosts or graph origin in revision_history
251
while (current_rev_id in parents_map and
252
len(parents_map[current_rev_id]) > 0):
253
check_not_reserved_id(current_rev_id)
254
new_history.append(current_rev_id)
255
current_rev_id = parents_map[current_rev_id][0]
256
parents_map = graph.get_parent_map([current_rev_id])
257
new_history.reverse()
260
def lock_write(self):
261
raise NotImplementedError(self.lock_write)
264
raise NotImplementedError(self.lock_read)
267
raise NotImplementedError(self.unlock)
269
def peek_lock_mode(self):
270
"""Return lock mode for the Branch: 'r', 'w' or None"""
271
raise NotImplementedError(self.peek_lock_mode)
273
def get_physical_lock_status(self):
274
raise NotImplementedError(self.get_physical_lock_status)
277
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
278
"""Return the revision_id for a dotted revno.
280
:param revno: a tuple like (1,) or (1,1,2)
281
:param _cache_reverse: a private parameter enabling storage
282
of the reverse mapping in a top level cache. (This should
283
only be done in selective circumstances as we want to
284
avoid having the mapping cached multiple times.)
285
:return: the revision_id
286
:raises errors.NoSuchRevision: if the revno doesn't exist
288
rev_id = self._do_dotted_revno_to_revision_id(revno)
290
self._partial_revision_id_to_revno_cache[rev_id] = revno
293
def _do_dotted_revno_to_revision_id(self, revno):
294
"""Worker function for dotted_revno_to_revision_id.
296
Subclasses should override this if they wish to
297
provide a more efficient implementation.
300
return self.get_rev_id(revno[0])
301
revision_id_to_revno = self.get_revision_id_to_revno_map()
302
revision_ids = [revision_id for revision_id, this_revno
303
in revision_id_to_revno.iteritems()
304
if revno == this_revno]
305
if len(revision_ids) == 1:
306
return revision_ids[0]
308
revno_str = '.'.join(map(str, revno))
309
raise errors.NoSuchRevision(self, revno_str)
312
def revision_id_to_dotted_revno(self, revision_id):
313
"""Given a revision id, return its dotted revno.
315
:return: a tuple like (1,) or (400,1,3).
317
return self._do_revision_id_to_dotted_revno(revision_id)
319
def _do_revision_id_to_dotted_revno(self, revision_id):
320
"""Worker function for revision_id_to_revno."""
321
# Try the caches if they are loaded
322
result = self._partial_revision_id_to_revno_cache.get(revision_id)
323
if result is not None:
325
if self._revision_id_to_revno_cache:
326
result = self._revision_id_to_revno_cache.get(revision_id)
328
raise errors.NoSuchRevision(self, revision_id)
329
# Try the mainline as it's optimised
331
revno = self.revision_id_to_revno(revision_id)
333
except errors.NoSuchRevision:
334
# We need to load and use the full revno map after all
335
result = self.get_revision_id_to_revno_map().get(revision_id)
337
raise errors.NoSuchRevision(self, revision_id)
341
def get_revision_id_to_revno_map(self):
342
"""Return the revision_id => dotted revno map.
344
This will be regenerated on demand, but will be cached.
346
:return: A dictionary mapping revision_id => dotted revno.
347
This dictionary should not be modified by the caller.
349
if self._revision_id_to_revno_cache is not None:
350
mapping = self._revision_id_to_revno_cache
352
mapping = self._gen_revno_map()
353
self._cache_revision_id_to_revno(mapping)
354
# TODO: jam 20070417 Since this is being cached, should we be returning
356
# I would rather not, and instead just declare that users should not
357
# modify the return value.
360
def _gen_revno_map(self):
361
"""Create a new mapping from revision ids to dotted revnos.
363
Dotted revnos are generated based on the current tip in the revision
365
This is the worker function for get_revision_id_to_revno_map, which
366
just caches the return value.
368
:return: A dictionary mapping revision_id => dotted revno.
370
revision_id_to_revno = dict((rev_id, revno)
371
for rev_id, depth, revno, end_of_merge
372
in self.iter_merge_sorted_revisions())
373
return revision_id_to_revno
376
def iter_merge_sorted_revisions(self, start_revision_id=None,
377
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
378
"""Walk the revisions for a branch in merge sorted order.
380
Merge sorted order is the output from a merge-aware,
381
topological sort, i.e. all parents come before their
382
children going forward; the opposite for reverse.
384
:param start_revision_id: the revision_id to begin walking from.
385
If None, the branch tip is used.
386
:param stop_revision_id: the revision_id to terminate the walk
387
after. If None, the rest of history is included.
388
:param stop_rule: if stop_revision_id is not None, the precise rule
389
to use for termination:
390
* 'exclude' - leave the stop revision out of the result (default)
391
* 'include' - the stop revision is the last item in the result
392
* 'with-merges' - include the stop revision and all of its
393
merged revisions in the result
394
:param direction: either 'reverse' or 'forward':
395
* reverse means return the start_revision_id first, i.e.
396
start at the most recent revision and go backwards in history
397
* forward returns tuples in the opposite order to reverse.
398
Note in particular that forward does *not* do any intelligent
399
ordering w.r.t. depth as some clients of this API may like.
400
(If required, that ought to be done at higher layers.)
402
:return: an iterator over (revision_id, depth, revno, end_of_merge)
405
* revision_id: the unique id of the revision
406
* depth: How many levels of merging deep this node has been
408
* revno_sequence: This field provides a sequence of
409
revision numbers for all revisions. The format is:
410
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
411
branch that the revno is on. From left to right the REVNO numbers
412
are the sequence numbers within that branch of the revision.
413
* end_of_merge: When True the next node (earlier in history) is
414
part of a different merge.
416
# Note: depth and revno values are in the context of the branch so
417
# we need the full graph to get stable numbers, regardless of the
419
if self._merge_sorted_revisions_cache is None:
420
last_revision = self.last_revision()
421
graph = self.repository.get_graph()
422
parent_map = dict(((key, value) for key, value in
423
graph.iter_ancestry([last_revision]) if value is not None))
424
revision_graph = repository._strip_NULL_ghosts(parent_map)
425
revs = tsort.merge_sort(revision_graph, last_revision, None,
427
# Drop the sequence # before caching
428
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
430
filtered = self._filter_merge_sorted_revisions(
431
self._merge_sorted_revisions_cache, start_revision_id,
432
stop_revision_id, stop_rule)
433
if direction == 'reverse':
435
if direction == 'forward':
436
return reversed(list(filtered))
438
raise ValueError('invalid direction %r' % direction)
440
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
441
start_revision_id, stop_revision_id, stop_rule):
442
"""Iterate over an inclusive range of sorted revisions."""
443
rev_iter = iter(merge_sorted_revisions)
444
if start_revision_id is not None:
445
for rev_id, depth, revno, end_of_merge in rev_iter:
446
if rev_id != start_revision_id:
449
# The decision to include the start or not
450
# depends on the stop_rule if a stop is provided
452
iter([(rev_id, depth, revno, end_of_merge)]),
455
if stop_revision_id is None:
456
for rev_id, depth, revno, end_of_merge in rev_iter:
457
yield rev_id, depth, revno, end_of_merge
458
elif stop_rule == 'exclude':
459
for rev_id, depth, revno, end_of_merge in rev_iter:
460
if rev_id == stop_revision_id:
462
yield rev_id, depth, revno, end_of_merge
463
elif stop_rule == 'include':
464
for rev_id, depth, revno, end_of_merge in rev_iter:
465
yield rev_id, depth, revno, end_of_merge
466
if rev_id == stop_revision_id:
468
elif stop_rule == 'with-merges':
469
stop_rev = self.repository.get_revision(stop_revision_id)
470
if stop_rev.parent_ids:
471
left_parent = stop_rev.parent_ids[0]
473
left_parent = _mod_revision.NULL_REVISION
474
for rev_id, depth, revno, end_of_merge in rev_iter:
475
if rev_id == left_parent:
477
yield rev_id, depth, revno, end_of_merge
479
raise ValueError('invalid stop_rule %r' % stop_rule)
481
def leave_lock_in_place(self):
482
"""Tell this branch object not to release the physical lock when this
485
If lock_write doesn't return a token, then this method is not supported.
487
self.control_files.leave_in_place()
489
def dont_leave_lock_in_place(self):
490
"""Tell this branch object to release the physical lock when this
491
object is unlocked, even if it didn't originally acquire it.
493
If lock_write doesn't return a token, then this method is not supported.
495
self.control_files.dont_leave_in_place()
497
def bind(self, other):
498
"""Bind the local branch the other branch.
500
:param other: The branch to bind to
503
raise errors.UpgradeRequired(self.base)
505
def set_reference_info(self, file_id, tree_path, branch_location):
506
"""Set the branch location to use for a tree reference."""
507
raise errors.UnsupportedOperation(self.set_reference_info, self)
509
def get_reference_info(self, file_id):
510
"""Get the tree_path and branch_location for a tree reference."""
511
raise errors.UnsupportedOperation(self.get_reference_info, self)
514
def fetch(self, from_branch, last_revision=None, pb=None):
515
"""Copy revisions from from_branch into this branch.
517
:param from_branch: Where to copy from.
518
:param last_revision: What revision to stop at (None for at the end
520
:param pb: An optional progress bar to use.
523
if self.base == from_branch.base:
526
symbol_versioning.warn(
527
symbol_versioning.deprecated_in((1, 14, 0))
528
% "pb parameter to fetch()")
529
from_branch.lock_read()
531
if last_revision is None:
532
last_revision = from_branch.last_revision()
533
last_revision = _mod_revision.ensure_null(last_revision)
534
return self.repository.fetch(from_branch.repository,
535
revision_id=last_revision,
540
def get_bound_location(self):
541
"""Return the URL of the branch we are bound to.
543
Older format branches cannot bind, please be sure to use a metadir
548
def get_old_bound_location(self):
549
"""Return the URL of the branch we used to be bound to
551
raise errors.UpgradeRequired(self.base)
553
def get_commit_builder(self, parents, config=None, timestamp=None,
554
timezone=None, committer=None, revprops=None,
556
"""Obtain a CommitBuilder for this branch.
558
:param parents: Revision ids of the parents of the new revision.
559
:param config: Optional configuration to use.
560
:param timestamp: Optional timestamp recorded for commit.
561
:param timezone: Optional timezone for timestamp.
562
:param committer: Optional committer to set for commit.
563
:param revprops: Optional dictionary of revision properties.
564
:param revision_id: Optional revision id.
568
config = self.get_config()
570
return self.repository.get_commit_builder(self, parents, config,
571
timestamp, timezone, committer, revprops, revision_id)
573
def get_master_branch(self, possible_transports=None):
574
"""Return the branch we are bound to.
576
:return: Either a Branch, or None
580
def get_revision_delta(self, revno):
581
"""Return the delta for one revision.
583
The delta is relative to its mainline predecessor, or the
584
empty tree for revision 1.
586
rh = self.revision_history()
587
if not (1 <= revno <= len(rh)):
588
raise errors.InvalidRevisionNumber(revno)
589
return self.repository.get_revision_delta(rh[revno-1])
591
def get_stacked_on_url(self):
592
"""Get the URL this branch is stacked against.
594
:raises NotStacked: If the branch is not stacked.
595
:raises UnstackableBranchFormat: If the branch does not support
598
raise NotImplementedError(self.get_stacked_on_url)
600
def print_file(self, file, revision_id):
601
"""Print `file` to stdout."""
602
raise NotImplementedError(self.print_file)
604
def set_revision_history(self, rev_history):
605
raise NotImplementedError(self.set_revision_history)
608
def set_parent(self, url):
609
"""See Branch.set_parent."""
610
# TODO: Maybe delete old location files?
611
# URLs should never be unicode, even on the local fs,
612
# FIXUP this and get_parent in a future branch format bump:
613
# read and rewrite the file. RBC 20060125
615
if isinstance(url, unicode):
617
url = url.encode('ascii')
618
except UnicodeEncodeError:
619
raise errors.InvalidURL(url,
620
"Urls must be 7-bit ascii, "
621
"use bzrlib.urlutils.escape")
622
url = urlutils.relative_url(self.base, url)
623
self._set_parent_location(url)
626
def set_stacked_on_url(self, url):
627
"""Set the URL this branch is stacked against.
629
:raises UnstackableBranchFormat: If the branch does not support
631
:raises UnstackableRepositoryFormat: If the repository does not support
634
if not self._format.supports_stacking():
635
raise errors.UnstackableBranchFormat(self._format, self.base)
636
self._check_stackable_repo()
639
old_url = self.get_stacked_on_url()
640
except (errors.NotStacked, errors.UnstackableBranchFormat,
641
errors.UnstackableRepositoryFormat):
644
# XXX: Lock correctness - should unlock our old repo if we were
646
# repositories don't offer an interface to remove fallback
647
# repositories today; take the conceptually simpler option and just
649
self.repository = self.bzrdir.find_repository()
650
self.repository.lock_write()
651
# for every revision reference the branch has, ensure it is pulled
653
source_repository = self._get_fallback_repository(old_url)
654
for revision_id in chain([self.last_revision()],
655
self.tags.get_reverse_tag_dict()):
656
self.repository.fetch(source_repository, revision_id,
659
self._activate_fallback_location(url, 'write')
660
# write this out after the repository is stacked to avoid setting a
661
# stacked config that doesn't work.
662
self._set_config_location('stacked_on_location', url)
665
def _set_tags_bytes(self, bytes):
666
"""Mirror method for _get_tags_bytes.
668
:seealso: Branch._get_tags_bytes.
670
return _run_with_write_locked_target(self, self._transport.put_bytes,
673
def _cache_revision_history(self, rev_history):
674
"""Set the cached revision history to rev_history.
676
The revision_history method will use this cache to avoid regenerating
677
the revision history.
679
This API is semi-public; it only for use by subclasses, all other code
680
should consider it to be private.
682
self._revision_history_cache = rev_history
684
def _cache_revision_id_to_revno(self, revision_id_to_revno):
685
"""Set the cached revision_id => revno map to revision_id_to_revno.
687
This API is semi-public; it only for use by subclasses, all other code
688
should consider it to be private.
690
self._revision_id_to_revno_cache = revision_id_to_revno
692
def _clear_cached_state(self):
693
"""Clear any cached data on this branch, e.g. cached revision history.
695
This means the next call to revision_history will need to call
696
_gen_revision_history.
698
This API is semi-public; it only for use by subclasses, all other code
699
should consider it to be private.
701
self._revision_history_cache = None
702
self._revision_id_to_revno_cache = None
703
self._last_revision_info_cache = None
704
self._merge_sorted_revisions_cache = None
706
def _gen_revision_history(self):
707
"""Return sequence of revision hashes on to this branch.
709
Unlike revision_history, this method always regenerates or rereads the
710
revision history, i.e. it does not cache the result, so repeated calls
713
Concrete subclasses should override this instead of revision_history so
714
that subclasses do not need to deal with caching logic.
716
This API is semi-public; it only for use by subclasses, all other code
717
should consider it to be private.
719
raise NotImplementedError(self._gen_revision_history)
722
def revision_history(self):
723
"""Return sequence of revision ids on this branch.
725
This method will cache the revision history for as long as it is safe to
728
if 'evil' in debug.debug_flags:
729
mutter_callsite(3, "revision_history scales with history.")
730
if self._revision_history_cache is not None:
731
history = self._revision_history_cache
733
history = self._gen_revision_history()
734
self._cache_revision_history(history)
738
"""Return current revision number for this branch.
740
That is equivalent to the number of revisions committed to
743
return self.last_revision_info()[0]
746
"""Older format branches cannot bind or unbind."""
747
raise errors.UpgradeRequired(self.base)
749
def set_append_revisions_only(self, enabled):
750
"""Older format branches are never restricted to append-only"""
751
raise errors.UpgradeRequired(self.base)
753
def last_revision(self):
754
"""Return last revision id, or NULL_REVISION."""
755
return self.last_revision_info()[1]
758
def last_revision_info(self):
759
"""Return information about the last revision.
761
:return: A tuple (revno, revision_id).
763
if self._last_revision_info_cache is None:
764
self._last_revision_info_cache = self._last_revision_info()
765
return self._last_revision_info_cache
767
def _last_revision_info(self):
768
rh = self.revision_history()
771
return (revno, rh[-1])
773
return (0, _mod_revision.NULL_REVISION)
775
@deprecated_method(deprecated_in((1, 6, 0)))
776
def missing_revisions(self, other, stop_revision=None):
777
"""Return a list of new revisions that would perfectly fit.
779
If self and other have not diverged, return a list of the revisions
780
present in other, but missing from self.
782
self_history = self.revision_history()
783
self_len = len(self_history)
784
other_history = other.revision_history()
785
other_len = len(other_history)
786
common_index = min(self_len, other_len) -1
787
if common_index >= 0 and \
788
self_history[common_index] != other_history[common_index]:
789
raise errors.DivergedBranches(self, other)
791
if stop_revision is None:
792
stop_revision = other_len
794
if stop_revision > other_len:
795
raise errors.NoSuchRevision(self, stop_revision)
796
return other_history[self_len:stop_revision]
799
def update_revisions(self, other, stop_revision=None, overwrite=False,
801
"""Pull in new perfect-fit revisions.
803
:param other: Another Branch to pull from
804
:param stop_revision: Updated until the given revision
805
:param overwrite: Always set the branch pointer, rather than checking
806
to see if it is a proper descendant.
807
:param graph: A Graph object that can be used to query history
808
information. This can be None.
811
return InterBranch.get(other, self).update_revisions(stop_revision,
814
def import_last_revision_info(self, source_repo, revno, revid):
815
"""Set the last revision info, importing from another repo if necessary.
817
This is used by the bound branch code to upload a revision to
818
the master branch first before updating the tip of the local branch.
820
:param source_repo: Source repository to optionally fetch from
821
:param revno: Revision number of the new tip
822
:param revid: Revision id of the new tip
824
if not self.repository.has_same_location(source_repo):
825
self.repository.fetch(source_repo, revision_id=revid)
826
self.set_last_revision_info(revno, revid)
828
def revision_id_to_revno(self, revision_id):
829
"""Given a revision id, return its revno"""
830
if _mod_revision.is_null(revision_id):
832
history = self.revision_history()
834
return history.index(revision_id) + 1
836
raise errors.NoSuchRevision(self, revision_id)
838
def get_rev_id(self, revno, history=None):
839
"""Find the revision id of the specified revno."""
841
return _mod_revision.NULL_REVISION
843
history = self.revision_history()
844
if revno <= 0 or revno > len(history):
845
raise errors.NoSuchRevision(self, revno)
846
return history[revno - 1]
849
def pull(self, source, overwrite=False, stop_revision=None,
850
possible_transports=None, *args, **kwargs):
851
"""Mirror source into this branch.
853
This branch is considered to be 'local', having low latency.
855
:returns: PullResult instance
857
return InterBranch.get(source, self).pull(overwrite=overwrite,
858
stop_revision=stop_revision,
859
possible_transports=possible_transports, *args, **kwargs)
861
def push(self, target, overwrite=False, stop_revision=None, *args,
863
"""Mirror this branch into target.
865
This branch is considered to be 'local', having low latency.
867
return InterBranch.get(self, target).push(overwrite, stop_revision,
870
def lossy_push(self, target, stop_revision=None):
871
"""Push deltas into another branch.
873
:note: This does not, like push, retain the revision ids from
874
the source branch and will, rather than adding bzr-specific
875
metadata, push only those semantics of the revision that can be
876
natively represented by this branch' VCS.
878
:param target: Target branch
879
:param stop_revision: Revision to push, defaults to last revision.
880
:return: BranchPushResult with an extra member revidmap:
881
A dictionary mapping revision ids from the target branch
882
to new revision ids in the target branch, for each
883
revision that was pushed.
885
inter = InterBranch.get(self, target)
886
lossy_push = getattr(inter, "lossy_push", None)
887
if lossy_push is None:
888
raise errors.LossyPushToSameVCS(self, target)
889
return lossy_push(stop_revision)
891
def basis_tree(self):
892
"""Return `Tree` object for last revision."""
893
return self.repository.revision_tree(self.last_revision())
895
def get_parent(self):
896
"""Return the parent location of the branch.
898
This is the default location for pull/missing. The usual
899
pattern is that the user can override it by specifying a
902
parent = self._get_parent_location()
905
# This is an old-format absolute path to a local branch
907
if parent.startswith('/'):
908
parent = urlutils.local_path_to_url(parent.decode('utf8'))
910
return urlutils.join(self.base[:-1], parent)
911
except errors.InvalidURLJoin, e:
912
raise errors.InaccessibleParent(parent, self.base)
914
def _get_parent_location(self):
915
raise NotImplementedError(self._get_parent_location)
917
def _set_config_location(self, name, url, config=None,
918
make_relative=False):
920
config = self.get_config()
924
url = urlutils.relative_url(self.base, url)
925
config.set_user_option(name, url, warn_masked=True)
927
def _get_config_location(self, name, config=None):
929
config = self.get_config()
930
location = config.get_user_option(name)
935
def get_child_submit_format(self):
936
"""Return the preferred format of submissions to this branch."""
937
return self.get_config().get_user_option("child_submit_format")
939
def get_submit_branch(self):
940
"""Return the submit location of the branch.
942
This is the default location for bundle. The usual
943
pattern is that the user can override it by specifying a
946
return self.get_config().get_user_option('submit_branch')
948
def set_submit_branch(self, location):
949
"""Return the submit location of the branch.
951
This is the default location for bundle. The usual
952
pattern is that the user can override it by specifying a
955
self.get_config().set_user_option('submit_branch', location,
958
def get_public_branch(self):
959
"""Return the public location of the branch.
961
This is used by merge directives.
963
return self._get_config_location('public_branch')
965
def set_public_branch(self, location):
966
"""Return the submit location of the branch.
968
This is the default location for bundle. The usual
969
pattern is that the user can override it by specifying a
972
self._set_config_location('public_branch', location)
974
def get_push_location(self):
975
"""Return the None or the location to push this branch to."""
976
push_loc = self.get_config().get_user_option('push_location')
979
def set_push_location(self, location):
980
"""Set a new push location for this branch."""
981
raise NotImplementedError(self.set_push_location)
983
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
984
"""Run the post_change_branch_tip hooks."""
985
hooks = Branch.hooks['post_change_branch_tip']
988
new_revno, new_revid = self.last_revision_info()
989
params = ChangeBranchTipParams(
990
self, old_revno, new_revno, old_revid, new_revid)
994
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
995
"""Run the pre_change_branch_tip hooks."""
996
hooks = Branch.hooks['pre_change_branch_tip']
999
old_revno, old_revid = self.last_revision_info()
1000
params = ChangeBranchTipParams(
1001
self, old_revno, new_revno, old_revid, new_revid)
1005
except errors.TipChangeRejected:
1008
exc_info = sys.exc_info()
1009
hook_name = Branch.hooks.get_hook_name(hook)
1010
raise errors.HookFailed(
1011
'pre_change_branch_tip', hook_name, exc_info)
1015
"""Synchronise this branch with the master branch if any.
1017
:return: None or the last_revision pivoted out during the update.
1021
def check_revno(self, revno):
1023
Check whether a revno corresponds to any revision.
1024
Zero (the NULL revision) is considered valid.
1027
self.check_real_revno(revno)
1029
def check_real_revno(self, revno):
1031
Check whether a revno corresponds to a real revision.
1032
Zero (the NULL revision) is considered invalid
1034
if revno < 1 or revno > self.revno():
1035
raise errors.InvalidRevisionNumber(revno)
1038
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1039
"""Clone this branch into to_bzrdir preserving all semantic values.
1041
Most API users will want 'create_clone_on_transport', which creates a
1042
new bzrdir and branch on the fly.
1044
revision_id: if not None, the revision history in the new branch will
1045
be truncated to end with revision_id.
1047
result = to_bzrdir.create_branch()
1050
if repository_policy is not None:
1051
repository_policy.configure_branch(result)
1052
self.copy_content_into(result, revision_id=revision_id)
1058
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1059
"""Create a new line of development from the branch, into to_bzrdir.
1061
to_bzrdir controls the branch format.
1063
revision_id: if not None, the revision history in the new branch will
1064
be truncated to end with revision_id.
1066
result = to_bzrdir.create_branch()
1069
if repository_policy is not None:
1070
repository_policy.configure_branch(result)
1071
self.copy_content_into(result, revision_id=revision_id)
1072
result.set_parent(self.bzrdir.root_transport.base)
1077
def _synchronize_history(self, destination, revision_id):
1078
"""Synchronize last revision and revision history between branches.
1080
This version is most efficient when the destination is also a
1081
BzrBranch6, but works for BzrBranch5, as long as the destination's
1082
repository contains all the lefthand ancestors of the intended
1083
last_revision. If not, set_last_revision_info will fail.
1085
:param destination: The branch to copy the history into
1086
:param revision_id: The revision-id to truncate history at. May
1087
be None to copy complete history.
1089
source_revno, source_revision_id = self.last_revision_info()
1090
if revision_id is None:
1091
revno, revision_id = source_revno, source_revision_id
1092
elif source_revision_id == revision_id:
1093
# we know the revno without needing to walk all of history
1094
revno = source_revno
1096
# To figure out the revno for a random revision, we need to build
1097
# the revision history, and count its length.
1098
# We don't care about the order, just how long it is.
1100
revno = len(list(self.repository.iter_reverse_revision_history(
1102
except errors.RevisionNotPresent:
1103
# One of the left hand side ancestors is a ghost
1104
graph = self.repository.get_graph()
1106
revno = graph.find_distance_to_null(revision_id, [])
1107
except errors.GhostRevisionsHaveNoRevno:
1108
# Default to 1, if we can't find anything else
1110
destination.set_last_revision_info(revno, revision_id)
1113
def copy_content_into(self, destination, revision_id=None):
1114
"""Copy the content of self into destination.
1116
revision_id: if not None, the revision history in the new branch will
1117
be truncated to end with revision_id.
1119
self.update_references(destination)
1120
self._synchronize_history(destination, revision_id)
1122
parent = self.get_parent()
1123
except errors.InaccessibleParent, e:
1124
mutter('parent was not accessible to copy: %s', e)
1127
destination.set_parent(parent)
1128
if self._push_should_merge_tags():
1129
self.tags.merge_to(destination.tags)
1131
def update_references(self, target):
1132
if not getattr(self._format, 'supports_reference_locations', False):
1134
reference_dict = self._get_all_reference_info()
1135
if len(reference_dict) == 0:
1137
old_base = self.base
1138
new_base = target.base
1139
target_reference_dict = target._get_all_reference_info()
1140
for file_id, (tree_path, branch_location) in (
1141
reference_dict.items()):
1142
branch_location = urlutils.rebase_url(branch_location,
1144
target_reference_dict.setdefault(
1145
file_id, (tree_path, branch_location))
1146
target._set_all_reference_info(target_reference_dict)
1150
"""Check consistency of the branch.
1152
In particular this checks that revisions given in the revision-history
1153
do actually match up in the revision graph, and that they're all
1154
present in the repository.
1156
Callers will typically also want to check the repository.
1158
:return: A BranchCheckResult.
1160
mainline_parent_id = None
1161
last_revno, last_revision_id = self.last_revision_info()
1163
real_rev_history = list(
1164
self.repository.iter_reverse_revision_history(last_revision_id))
1165
except errors.RevisionNotPresent:
1166
ret = BranchCheckResult(self)
1167
ret.ghosts_in_mainline = True
1169
real_rev_history.reverse()
1170
if len(real_rev_history) != last_revno:
1171
raise errors.BzrCheckError('revno does not match len(mainline)'
1172
' %s != %s' % (last_revno, len(real_rev_history)))
1173
# TODO: We should probably also check that real_rev_history actually
1174
# matches self.revision_history()
1175
for revision_id in real_rev_history:
1177
revision = self.repository.get_revision(revision_id)
1178
except errors.NoSuchRevision, e:
1179
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1181
# In general the first entry on the revision history has no parents.
1182
# But it's not illegal for it to have parents listed; this can happen
1183
# in imports from Arch when the parents weren't reachable.
1184
if mainline_parent_id is not None:
1185
if mainline_parent_id not in revision.parent_ids:
1186
raise errors.BzrCheckError("previous revision {%s} not listed among "
1188
% (mainline_parent_id, revision_id))
1189
mainline_parent_id = revision_id
1190
return BranchCheckResult(self)
1192
def _get_checkout_format(self):
1193
"""Return the most suitable metadir for a checkout of this branch.
1194
Weaves are used if this branch's repository uses weaves.
1196
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1197
from bzrlib.repofmt import weaverepo
1198
format = bzrdir.BzrDirMetaFormat1()
1199
format.repository_format = weaverepo.RepositoryFormat7()
1201
format = self.repository.bzrdir.checkout_metadir()
1202
format.set_branch_format(self._format)
1205
def create_clone_on_transport(self, to_transport, revision_id=None,
1206
stacked_on=None, create_prefix=False, use_existing_dir=False):
1207
"""Create a clone of this branch and its bzrdir.
1209
:param to_transport: The transport to clone onto.
1210
:param revision_id: The revision id to use as tip in the new branch.
1211
If None the tip is obtained from this branch.
1212
:param stacked_on: An optional URL to stack the clone on.
1213
:param create_prefix: Create any missing directories leading up to
1215
:param use_existing_dir: Use an existing directory if one exists.
1217
# XXX: Fix the bzrdir API to allow getting the branch back from the
1218
# clone call. Or something. 20090224 RBC/spiv.
1219
if revision_id is None:
1220
revision_id = self.last_revision()
1222
dir_to = self.bzrdir.clone_on_transport(to_transport,
1223
revision_id=revision_id, stacked_on=stacked_on,
1224
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1225
except errors.FileExists:
1226
if not use_existing_dir:
1228
except errors.NoSuchFile:
1229
if not create_prefix:
1231
return dir_to.open_branch()
1233
def create_checkout(self, to_location, revision_id=None,
1234
lightweight=False, accelerator_tree=None,
1236
"""Create a checkout of a branch.
1238
:param to_location: The url to produce the checkout at
1239
:param revision_id: The revision to check out
1240
:param lightweight: If True, produce a lightweight checkout, otherwise,
1241
produce a bound branch (heavyweight checkout)
1242
:param accelerator_tree: A tree which can be used for retrieving file
1243
contents more quickly than the revision tree, i.e. a workingtree.
1244
The revision tree will be used for cases where accelerator_tree's
1245
content is different.
1246
:param hardlink: If true, hard-link files from accelerator_tree,
1248
:return: The tree of the created checkout
1250
t = transport.get_transport(to_location)
1253
format = self._get_checkout_format()
1254
checkout = format.initialize_on_transport(t)
1255
from_branch = BranchReferenceFormat().initialize(checkout, self)
1257
format = self._get_checkout_format()
1258
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1259
to_location, force_new_tree=False, format=format)
1260
checkout = checkout_branch.bzrdir
1261
checkout_branch.bind(self)
1262
# pull up to the specified revision_id to set the initial
1263
# branch tip correctly, and seed it with history.
1264
checkout_branch.pull(self, stop_revision=revision_id)
1266
tree = checkout.create_workingtree(revision_id,
1267
from_branch=from_branch,
1268
accelerator_tree=accelerator_tree,
1270
basis_tree = tree.basis_tree()
1271
basis_tree.lock_read()
1273
for path, file_id in basis_tree.iter_references():
1274
reference_parent = self.reference_parent(file_id, path)
1275
reference_parent.create_checkout(tree.abspath(path),
1276
basis_tree.get_reference_revision(file_id, path),
1283
def reconcile(self, thorough=True):
1284
"""Make sure the data stored in this branch is consistent."""
1285
from bzrlib.reconcile import BranchReconciler
1286
reconciler = BranchReconciler(self, thorough=thorough)
1287
reconciler.reconcile()
1290
def reference_parent(self, file_id, path, possible_transports=None):
1291
"""Return the parent branch for a tree-reference file_id
1292
:param file_id: The file_id of the tree reference
1293
:param path: The path of the file_id in the tree
1294
:return: A branch associated with the file_id
1296
# FIXME should provide multiple branches, based on config
1297
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1298
possible_transports=possible_transports)
1300
def supports_tags(self):
1301
return self._format.supports_tags()
1303
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1305
"""Ensure that revision_b is a descendant of revision_a.
1307
This is a helper function for update_revisions.
1309
:raises: DivergedBranches if revision_b has diverged from revision_a.
1310
:returns: True if revision_b is a descendant of revision_a.
1312
relation = self._revision_relations(revision_a, revision_b, graph)
1313
if relation == 'b_descends_from_a':
1315
elif relation == 'diverged':
1316
raise errors.DivergedBranches(self, other_branch)
1317
elif relation == 'a_descends_from_b':
1320
raise AssertionError("invalid relation: %r" % (relation,))
1322
def _revision_relations(self, revision_a, revision_b, graph):
1323
"""Determine the relationship between two revisions.
1325
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1327
heads = graph.heads([revision_a, revision_b])
1328
if heads == set([revision_b]):
1329
return 'b_descends_from_a'
1330
elif heads == set([revision_a, revision_b]):
1331
# These branches have diverged
1333
elif heads == set([revision_a]):
1334
return 'a_descends_from_b'
1336
raise AssertionError("invalid heads: %r" % (heads,))
1339
class BranchFormat(object):
1340
"""An encapsulation of the initialization and open routines for a format.
1342
Formats provide three things:
1343
* An initialization routine,
1347
Formats are placed in an dict by their format string for reference
1348
during branch opening. Its not required that these be instances, they
1349
can be classes themselves with class methods - it simply depends on
1350
whether state is needed for a given format or not.
1352
Once a format is deprecated, just deprecate the initialize and open
1353
methods on the format class. Do not deprecate the object, as the
1354
object will be created every time regardless.
1357
_default_format = None
1358
"""The default format used for new branches."""
1361
"""The known formats."""
1363
def __eq__(self, other):
1364
return self.__class__ is other.__class__
1366
def __ne__(self, other):
1367
return not (self == other)
1370
def find_format(klass, a_bzrdir):
1371
"""Return the format for the branch object in a_bzrdir."""
1373
transport = a_bzrdir.get_branch_transport(None)
1374
format_string = transport.get("format").read()
1375
return klass._formats[format_string]
1376
except errors.NoSuchFile:
1377
raise errors.NotBranchError(path=transport.base)
1379
raise errors.UnknownFormatError(format=format_string, kind='branch')
1382
def get_default_format(klass):
1383
"""Return the current default format."""
1384
return klass._default_format
1386
def get_reference(self, a_bzrdir):
1387
"""Get the target reference of the branch in a_bzrdir.
1389
format probing must have been completed before calling
1390
this method - it is assumed that the format of the branch
1391
in a_bzrdir is correct.
1393
:param a_bzrdir: The bzrdir to get the branch data from.
1394
:return: None if the branch is not a reference branch.
1399
def set_reference(self, a_bzrdir, to_branch):
1400
"""Set the target reference of the branch in a_bzrdir.
1402
format probing must have been completed before calling
1403
this method - it is assumed that the format of the branch
1404
in a_bzrdir is correct.
1406
:param a_bzrdir: The bzrdir to set the branch reference for.
1407
:param to_branch: branch that the checkout is to reference
1409
raise NotImplementedError(self.set_reference)
1411
def get_format_string(self):
1412
"""Return the ASCII format string that identifies this format."""
1413
raise NotImplementedError(self.get_format_string)
1415
def get_format_description(self):
1416
"""Return the short format description for this format."""
1417
raise NotImplementedError(self.get_format_description)
1419
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1421
"""Initialize a branch in a bzrdir, with specified files
1423
:param a_bzrdir: The bzrdir to initialize the branch in
1424
:param utf8_files: The files to create as a list of
1425
(filename, content) tuples
1426
:param set_format: If True, set the format with
1427
self.get_format_string. (BzrBranch4 has its format set
1429
:return: a branch in this format
1431
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1432
branch_transport = a_bzrdir.get_branch_transport(self)
1434
'metadir': ('lock', lockdir.LockDir),
1435
'branch4': ('branch-lock', lockable_files.TransportLock),
1437
lock_name, lock_class = lock_map[lock_type]
1438
control_files = lockable_files.LockableFiles(branch_transport,
1439
lock_name, lock_class)
1440
control_files.create_lock()
1442
control_files.lock_write()
1443
except errors.LockContention:
1444
if lock_type != 'branch4':
1450
utf8_files += [('format', self.get_format_string())]
1452
for (filename, content) in utf8_files:
1453
branch_transport.put_bytes(
1455
mode=a_bzrdir._get_file_mode())
1458
control_files.unlock()
1459
return self.open(a_bzrdir, _found=True)
1461
def initialize(self, a_bzrdir):
1462
"""Create a branch of this format in a_bzrdir."""
1463
raise NotImplementedError(self.initialize)
1465
def is_supported(self):
1466
"""Is this format supported?
1468
Supported formats can be initialized and opened.
1469
Unsupported formats may not support initialization or committing or
1470
some other features depending on the reason for not being supported.
1474
def make_tags(self, branch):
1475
"""Create a tags object for branch.
1477
This method is on BranchFormat, because BranchFormats are reflected
1478
over the wire via network_name(), whereas full Branch instances require
1479
multiple VFS method calls to operate at all.
1481
The default implementation returns a disabled-tags instance.
1483
Note that it is normal for branch to be a RemoteBranch when using tags
1486
return DisabledTags(branch)
1488
def network_name(self):
1489
"""A simple byte string uniquely identifying this format for RPC calls.
1491
MetaDir branch formats use their disk format string to identify the
1492
repository over the wire. All in one formats such as bzr < 0.8, and
1493
foreign formats like svn/git and hg should use some marker which is
1494
unique and immutable.
1496
raise NotImplementedError(self.network_name)
1498
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1499
"""Return the branch object for a_bzrdir
1501
:param a_bzrdir: A BzrDir that contains a branch.
1502
:param _found: a private parameter, do not use it. It is used to
1503
indicate if format probing has already be done.
1504
:param ignore_fallbacks: when set, no fallback branches will be opened
1505
(if there are any). Default is to open fallbacks.
1507
raise NotImplementedError(self.open)
1510
def register_format(klass, format):
1511
"""Register a metadir format."""
1512
klass._formats[format.get_format_string()] = format
1513
# Metadir formats have a network name of their format string, and get
1514
# registered as class factories.
1515
network_format_registry.register(format.get_format_string(), format.__class__)
1518
def set_default_format(klass, format):
1519
klass._default_format = format
1521
def supports_stacking(self):
1522
"""True if this format records a stacked-on branch."""
1526
def unregister_format(klass, format):
1527
del klass._formats[format.get_format_string()]
1530
return self.get_format_description().rstrip()
1532
def supports_tags(self):
1533
"""True if this format supports tags stored in the branch"""
1534
return False # by default
1537
class BranchHooks(Hooks):
1538
"""A dictionary mapping hook name to a list of callables for branch hooks.
1540
e.g. ['set_rh'] Is the list of items to be called when the
1541
set_revision_history function is invoked.
1545
"""Create the default hooks.
1547
These are all empty initially, because by default nothing should get
1550
Hooks.__init__(self)
1551
self.create_hook(HookPoint('set_rh',
1552
"Invoked whenever the revision history has been set via "
1553
"set_revision_history. The api signature is (branch, "
1554
"revision_history), and the branch will be write-locked. "
1555
"The set_rh hook can be expensive for bzr to trigger, a better "
1556
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1557
self.create_hook(HookPoint('open',
1558
"Called with the Branch object that has been opened after a "
1559
"branch is opened.", (1, 8), None))
1560
self.create_hook(HookPoint('post_push',
1561
"Called after a push operation completes. post_push is called "
1562
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1563
"bzr client.", (0, 15), None))
1564
self.create_hook(HookPoint('post_pull',
1565
"Called after a pull operation completes. post_pull is called "
1566
"with a bzrlib.branch.PullResult object and only runs in the "
1567
"bzr client.", (0, 15), None))
1568
self.create_hook(HookPoint('pre_commit',
1569
"Called after a commit is calculated but before it is is "
1570
"completed. pre_commit is called with (local, master, old_revno, "
1571
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1572
"). old_revid is NULL_REVISION for the first commit to a branch, "
1573
"tree_delta is a TreeDelta object describing changes from the "
1574
"basis revision. hooks MUST NOT modify this delta. "
1575
" future_tree is an in-memory tree obtained from "
1576
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1577
"tree.", (0,91), None))
1578
self.create_hook(HookPoint('post_commit',
1579
"Called in the bzr client after a commit has completed. "
1580
"post_commit is called with (local, master, old_revno, old_revid, "
1581
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1582
"commit to a branch.", (0, 15), None))
1583
self.create_hook(HookPoint('post_uncommit',
1584
"Called in the bzr client after an uncommit completes. "
1585
"post_uncommit is called with (local, master, old_revno, "
1586
"old_revid, new_revno, new_revid) where local is the local branch "
1587
"or None, master is the target branch, and an empty branch "
1588
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1589
self.create_hook(HookPoint('pre_change_branch_tip',
1590
"Called in bzr client and server before a change to the tip of a "
1591
"branch is made. pre_change_branch_tip is called with a "
1592
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1593
"commit, uncommit will all trigger this hook.", (1, 6), None))
1594
self.create_hook(HookPoint('post_change_branch_tip',
1595
"Called in bzr client and server after a change to the tip of a "
1596
"branch is made. post_change_branch_tip is called with a "
1597
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1598
"commit, uncommit will all trigger this hook.", (1, 4), None))
1599
self.create_hook(HookPoint('transform_fallback_location',
1600
"Called when a stacked branch is activating its fallback "
1601
"locations. transform_fallback_location is called with (branch, "
1602
"url), and should return a new url. Returning the same url "
1603
"allows it to be used as-is, returning a different one can be "
1604
"used to cause the branch to stack on a closer copy of that "
1605
"fallback_location. Note that the branch cannot have history "
1606
"accessing methods called on it during this hook because the "
1607
"fallback locations have not been activated. When there are "
1608
"multiple hooks installed for transform_fallback_location, "
1609
"all are called with the url returned from the previous hook."
1610
"The order is however undefined.", (1, 9), None))
1613
# install the default hooks into the Branch class.
1614
Branch.hooks = BranchHooks()
1617
class ChangeBranchTipParams(object):
1618
"""Object holding parameters passed to *_change_branch_tip hooks.
1620
There are 5 fields that hooks may wish to access:
1622
:ivar branch: the branch being changed
1623
:ivar old_revno: revision number before the change
1624
:ivar new_revno: revision number after the change
1625
:ivar old_revid: revision id before the change
1626
:ivar new_revid: revision id after the change
1628
The revid fields are strings. The revno fields are integers.
1631
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1632
"""Create a group of ChangeBranchTip parameters.
1634
:param branch: The branch being changed.
1635
:param old_revno: Revision number before the change.
1636
:param new_revno: Revision number after the change.
1637
:param old_revid: Tip revision id before the change.
1638
:param new_revid: Tip revision id after the change.
1640
self.branch = branch
1641
self.old_revno = old_revno
1642
self.new_revno = new_revno
1643
self.old_revid = old_revid
1644
self.new_revid = new_revid
1646
def __eq__(self, other):
1647
return self.__dict__ == other.__dict__
1650
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1651
self.__class__.__name__, self.branch,
1652
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1655
class BzrBranchFormat4(BranchFormat):
1656
"""Bzr branch format 4.
1659
- a revision-history file.
1660
- a branch-lock lock file [ to be shared with the bzrdir ]
1663
def get_format_description(self):
1664
"""See BranchFormat.get_format_description()."""
1665
return "Branch format 4"
1667
def initialize(self, a_bzrdir):
1668
"""Create a branch of this format in a_bzrdir."""
1669
utf8_files = [('revision-history', ''),
1670
('branch-name', ''),
1672
return self._initialize_helper(a_bzrdir, utf8_files,
1673
lock_type='branch4', set_format=False)
1676
super(BzrBranchFormat4, self).__init__()
1677
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1679
def network_name(self):
1680
"""The network name for this format is the control dirs disk label."""
1681
return self._matchingbzrdir.get_format_string()
1683
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1684
"""See BranchFormat.open()."""
1686
# we are being called directly and must probe.
1687
raise NotImplementedError
1688
return BzrBranch(_format=self,
1689
_control_files=a_bzrdir._control_files,
1691
_repository=a_bzrdir.open_repository())
1694
return "Bazaar-NG branch format 4"
1697
class BranchFormatMetadir(BranchFormat):
1698
"""Common logic for meta-dir based branch formats."""
1700
def _branch_class(self):
1701
"""What class to instantiate on open calls."""
1702
raise NotImplementedError(self._branch_class)
1704
def network_name(self):
1705
"""A simple byte string uniquely identifying this format for RPC calls.
1707
Metadir branch formats use their format string.
1709
return self.get_format_string()
1711
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1712
"""See BranchFormat.open()."""
1714
format = BranchFormat.find_format(a_bzrdir)
1715
if format.__class__ != self.__class__:
1716
raise AssertionError("wrong format %r found for %r" %
1719
transport = a_bzrdir.get_branch_transport(None)
1720
control_files = lockable_files.LockableFiles(transport, 'lock',
1722
return self._branch_class()(_format=self,
1723
_control_files=control_files,
1725
_repository=a_bzrdir.find_repository(),
1726
ignore_fallbacks=ignore_fallbacks)
1727
except errors.NoSuchFile:
1728
raise errors.NotBranchError(path=transport.base)
1731
super(BranchFormatMetadir, self).__init__()
1732
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1733
self._matchingbzrdir.set_branch_format(self)
1735
def supports_tags(self):
1739
class BzrBranchFormat5(BranchFormatMetadir):
1740
"""Bzr branch format 5.
1743
- a revision-history file.
1745
- a lock dir guarding the branch itself
1746
- all of this stored in a branch/ subdirectory
1747
- works with shared repositories.
1749
This format is new in bzr 0.8.
1752
def _branch_class(self):
1755
def get_format_string(self):
1756
"""See BranchFormat.get_format_string()."""
1757
return "Bazaar-NG branch format 5\n"
1759
def get_format_description(self):
1760
"""See BranchFormat.get_format_description()."""
1761
return "Branch format 5"
1763
def initialize(self, a_bzrdir):
1764
"""Create a branch of this format in a_bzrdir."""
1765
utf8_files = [('revision-history', ''),
1766
('branch-name', ''),
1768
return self._initialize_helper(a_bzrdir, utf8_files)
1770
def supports_tags(self):
1774
class BzrBranchFormat6(BranchFormatMetadir):
1775
"""Branch format with last-revision and tags.
1777
Unlike previous formats, this has no explicit revision history. Instead,
1778
this just stores the last-revision, and the left-hand history leading
1779
up to there is the history.
1781
This format was introduced in bzr 0.15
1782
and became the default in 0.91.
1785
def _branch_class(self):
1788
def get_format_string(self):
1789
"""See BranchFormat.get_format_string()."""
1790
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1792
def get_format_description(self):
1793
"""See BranchFormat.get_format_description()."""
1794
return "Branch format 6"
1796
def initialize(self, a_bzrdir):
1797
"""Create a branch of this format in a_bzrdir."""
1798
utf8_files = [('last-revision', '0 null:\n'),
1799
('branch.conf', ''),
1802
return self._initialize_helper(a_bzrdir, utf8_files)
1804
def make_tags(self, branch):
1805
"""See bzrlib.branch.BranchFormat.make_tags()."""
1806
return BasicTags(branch)
1810
class BzrBranchFormat8(BranchFormatMetadir):
1811
"""Metadir format supporting storing locations of subtree branches."""
1813
def _branch_class(self):
1816
def get_format_string(self):
1817
"""See BranchFormat.get_format_string()."""
1818
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1820
def get_format_description(self):
1821
"""See BranchFormat.get_format_description()."""
1822
return "Branch format 8"
1824
def initialize(self, a_bzrdir):
1825
"""Create a branch of this format in a_bzrdir."""
1826
utf8_files = [('last-revision', '0 null:\n'),
1827
('branch.conf', ''),
1831
return self._initialize_helper(a_bzrdir, utf8_files)
1834
super(BzrBranchFormat8, self).__init__()
1835
self._matchingbzrdir.repository_format = \
1836
RepositoryFormatKnitPack5RichRoot()
1838
def make_tags(self, branch):
1839
"""See bzrlib.branch.BranchFormat.make_tags()."""
1840
return BasicTags(branch)
1842
def supports_stacking(self):
1845
supports_reference_locations = True
1848
class BzrBranchFormat7(BzrBranchFormat8):
1849
"""Branch format with last-revision, tags, and a stacked location pointer.
1851
The stacked location pointer is passed down to the repository and requires
1852
a repository format with supports_external_lookups = True.
1854
This format was introduced in bzr 1.6.
1857
def initialize(self, a_bzrdir):
1858
"""Create a branch of this format in a_bzrdir."""
1859
utf8_files = [('last-revision', '0 null:\n'),
1860
('branch.conf', ''),
1863
return self._initialize_helper(a_bzrdir, utf8_files)
1865
def _branch_class(self):
1868
def get_format_string(self):
1869
"""See BranchFormat.get_format_string()."""
1870
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1872
def get_format_description(self):
1873
"""See BranchFormat.get_format_description()."""
1874
return "Branch format 7"
1876
supports_reference_locations = False
1879
class BranchReferenceFormat(BranchFormat):
1880
"""Bzr branch reference format.
1882
Branch references are used in implementing checkouts, they
1883
act as an alias to the real branch which is at some other url.
1890
def get_format_string(self):
1891
"""See BranchFormat.get_format_string()."""
1892
return "Bazaar-NG Branch Reference Format 1\n"
1894
def get_format_description(self):
1895
"""See BranchFormat.get_format_description()."""
1896
return "Checkout reference format 1"
1898
def get_reference(self, a_bzrdir):
1899
"""See BranchFormat.get_reference()."""
1900
transport = a_bzrdir.get_branch_transport(None)
1901
return transport.get('location').read()
1903
def set_reference(self, a_bzrdir, to_branch):
1904
"""See BranchFormat.set_reference()."""
1905
transport = a_bzrdir.get_branch_transport(None)
1906
location = transport.put_bytes('location', to_branch.base)
1908
def initialize(self, a_bzrdir, target_branch=None):
1909
"""Create a branch of this format in a_bzrdir."""
1910
if target_branch is None:
1911
# this format does not implement branch itself, thus the implicit
1912
# creation contract must see it as uninitializable
1913
raise errors.UninitializableFormat(self)
1914
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1915
branch_transport = a_bzrdir.get_branch_transport(self)
1916
branch_transport.put_bytes('location',
1917
target_branch.bzrdir.root_transport.base)
1918
branch_transport.put_bytes('format', self.get_format_string())
1920
a_bzrdir, _found=True,
1921
possible_transports=[target_branch.bzrdir.root_transport])
1924
super(BranchReferenceFormat, self).__init__()
1925
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1926
self._matchingbzrdir.set_branch_format(self)
1928
def _make_reference_clone_function(format, a_branch):
1929
"""Create a clone() routine for a branch dynamically."""
1930
def clone(to_bzrdir, revision_id=None,
1931
repository_policy=None):
1932
"""See Branch.clone()."""
1933
return format.initialize(to_bzrdir, a_branch)
1934
# cannot obey revision_id limits when cloning a reference ...
1935
# FIXME RBC 20060210 either nuke revision_id for clone, or
1936
# emit some sort of warning/error to the caller ?!
1939
def open(self, a_bzrdir, _found=False, location=None,
1940
possible_transports=None, ignore_fallbacks=False):
1941
"""Return the branch that the branch reference in a_bzrdir points at.
1943
:param a_bzrdir: A BzrDir that contains a branch.
1944
:param _found: a private parameter, do not use it. It is used to
1945
indicate if format probing has already be done.
1946
:param ignore_fallbacks: when set, no fallback branches will be opened
1947
(if there are any). Default is to open fallbacks.
1948
:param location: The location of the referenced branch. If
1949
unspecified, this will be determined from the branch reference in
1951
:param possible_transports: An optional reusable transports list.
1954
format = BranchFormat.find_format(a_bzrdir)
1955
if format.__class__ != self.__class__:
1956
raise AssertionError("wrong format %r found for %r" %
1958
if location is None:
1959
location = self.get_reference(a_bzrdir)
1960
real_bzrdir = bzrdir.BzrDir.open(
1961
location, possible_transports=possible_transports)
1962
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1963
# this changes the behaviour of result.clone to create a new reference
1964
# rather than a copy of the content of the branch.
1965
# I did not use a proxy object because that needs much more extensive
1966
# testing, and we are only changing one behaviour at the moment.
1967
# If we decide to alter more behaviours - i.e. the implicit nickname
1968
# then this should be refactored to introduce a tested proxy branch
1969
# and a subclass of that for use in overriding clone() and ....
1971
result.clone = self._make_reference_clone_function(result)
1975
network_format_registry = registry.FormatRegistry()
1976
"""Registry of formats indexed by their network name.
1978
The network name for a branch format is an identifier that can be used when
1979
referring to formats with smart server operations. See
1980
BranchFormat.network_name() for more detail.
1984
# formats which have no format string are not discoverable
1985
# and not independently creatable, so are not registered.
1986
__format5 = BzrBranchFormat5()
1987
__format6 = BzrBranchFormat6()
1988
__format7 = BzrBranchFormat7()
1989
__format8 = BzrBranchFormat8()
1990
BranchFormat.register_format(__format5)
1991
BranchFormat.register_format(BranchReferenceFormat())
1992
BranchFormat.register_format(__format6)
1993
BranchFormat.register_format(__format7)
1994
BranchFormat.register_format(__format8)
1995
BranchFormat.set_default_format(__format6)
1996
_legacy_formats = [BzrBranchFormat4(),
1998
network_format_registry.register(
1999
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2002
class BzrBranch(Branch):
2003
"""A branch stored in the actual filesystem.
2005
Note that it's "local" in the context of the filesystem; it doesn't
2006
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2007
it's writable, and can be accessed via the normal filesystem API.
2009
:ivar _transport: Transport for file operations on this branch's
2010
control files, typically pointing to the .bzr/branch directory.
2011
:ivar repository: Repository for this branch.
2012
:ivar base: The url of the base directory for this branch; the one
2013
containing the .bzr directory.
2016
def __init__(self, _format=None,
2017
_control_files=None, a_bzrdir=None, _repository=None,
2018
ignore_fallbacks=False):
2019
"""Create new branch object at a particular location."""
2020
if a_bzrdir is None:
2021
raise ValueError('a_bzrdir must be supplied')
2023
self.bzrdir = a_bzrdir
2024
self._base = self.bzrdir.transport.clone('..').base
2025
# XXX: We should be able to just do
2026
# self.base = self.bzrdir.root_transport.base
2027
# but this does not quite work yet -- mbp 20080522
2028
self._format = _format
2029
if _control_files is None:
2030
raise ValueError('BzrBranch _control_files is None')
2031
self.control_files = _control_files
2032
self._transport = _control_files._transport
2033
self.repository = _repository
2034
Branch.__init__(self)
2037
return '%s(%r)' % (self.__class__.__name__, self.base)
2041
def _get_base(self):
2042
"""Returns the directory containing the control directory."""
2045
base = property(_get_base, doc="The URL for the root of this branch.")
2047
def _get_config(self):
2048
return TransportConfig(self._transport, 'branch.conf')
2050
def is_locked(self):
2051
return self.control_files.is_locked()
2053
def lock_write(self, token=None):
2054
# All-in-one needs to always unlock/lock.
2055
repo_control = getattr(self.repository, 'control_files', None)
2056
if self.control_files == repo_control or not self.is_locked():
2057
self.repository.lock_write()
2062
return self.control_files.lock_write(token=token)
2065
self.repository.unlock()
2068
def lock_read(self):
2069
# All-in-one needs to always unlock/lock.
2070
repo_control = getattr(self.repository, 'control_files', None)
2071
if self.control_files == repo_control or not self.is_locked():
2072
self.repository.lock_read()
2077
self.control_files.lock_read()
2080
self.repository.unlock()
2085
self.control_files.unlock()
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
2090
not self.control_files.is_locked()):
2091
self.repository.unlock()
2092
if not self.control_files.is_locked():
2093
# we just released the lock
2094
self._clear_cached_state()
2096
def peek_lock_mode(self):
2097
if self.control_files._lock_count == 0:
2100
return self.control_files._lock_mode
2102
def get_physical_lock_status(self):
2103
return self.control_files.get_physical_lock_status()
2106
def print_file(self, file, revision_id):
2107
"""See Branch.print_file."""
2108
return self.repository.print_file(file, revision_id)
2110
def _write_revision_history(self, history):
2111
"""Factored out of set_revision_history.
2113
This performs the actual writing to disk.
2114
It is intended to be called by BzrBranch5.set_revision_history."""
2115
self._transport.put_bytes(
2116
'revision-history', '\n'.join(history),
2117
mode=self.bzrdir._get_file_mode())
2120
def set_revision_history(self, rev_history):
2121
"""See Branch.set_revision_history."""
2122
if 'evil' in debug.debug_flags:
2123
mutter_callsite(3, "set_revision_history scales with history.")
2124
check_not_reserved_id = _mod_revision.check_not_reserved_id
2125
for rev_id in rev_history:
2126
check_not_reserved_id(rev_id)
2127
if Branch.hooks['post_change_branch_tip']:
2128
# Don't calculate the last_revision_info() if there are no hooks
2130
old_revno, old_revid = self.last_revision_info()
2131
if len(rev_history) == 0:
2132
revid = _mod_revision.NULL_REVISION
2134
revid = rev_history[-1]
2135
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2136
self._write_revision_history(rev_history)
2137
self._clear_cached_state()
2138
self._cache_revision_history(rev_history)
2139
for hook in Branch.hooks['set_rh']:
2140
hook(self, rev_history)
2141
if Branch.hooks['post_change_branch_tip']:
2142
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2144
def _synchronize_history(self, destination, revision_id):
2145
"""Synchronize last revision and revision history between branches.
2147
This version is most efficient when the destination is also a
2148
BzrBranch5, but works for BzrBranch6 as long as the revision
2149
history is the true lefthand parent history, and all of the revisions
2150
are in the destination's repository. If not, set_revision_history
2153
:param destination: The branch to copy the history into
2154
:param revision_id: The revision-id to truncate history at. May
2155
be None to copy complete history.
2157
if not isinstance(destination._format, BzrBranchFormat5):
2158
super(BzrBranch, self)._synchronize_history(
2159
destination, revision_id)
2161
if revision_id == _mod_revision.NULL_REVISION:
2164
new_history = self.revision_history()
2165
if revision_id is not None and new_history != []:
2167
new_history = new_history[:new_history.index(revision_id) + 1]
2169
rev = self.repository.get_revision(revision_id)
2170
new_history = rev.get_history(self.repository)[1:]
2171
destination.set_revision_history(new_history)
2174
def set_last_revision_info(self, revno, revision_id):
2175
"""Set the last revision of this branch.
2177
The caller is responsible for checking that the revno is correct
2178
for this revision id.
2180
It may be possible to set the branch last revision to an id not
2181
present in the repository. However, branches can also be
2182
configured to check constraints on history, in which case this may not
2185
revision_id = _mod_revision.ensure_null(revision_id)
2186
# this old format stores the full history, but this api doesn't
2187
# provide it, so we must generate, and might as well check it's
2189
history = self._lefthand_history(revision_id)
2190
if len(history) != revno:
2191
raise AssertionError('%d != %d' % (len(history), revno))
2192
self.set_revision_history(history)
2194
def _gen_revision_history(self):
2195
history = self._transport.get_bytes('revision-history').split('\n')
2196
if history[-1:] == ['']:
2197
# There shouldn't be a trailing newline, but just in case.
2202
def generate_revision_history(self, revision_id, last_rev=None,
2204
"""Create a new revision history that will finish with revision_id.
2206
:param revision_id: the new tip to use.
2207
:param last_rev: The previous last_revision. If not None, then this
2208
must be a ancestory of revision_id, or DivergedBranches is raised.
2209
:param other_branch: The other branch that DivergedBranches should
2210
raise with respect to.
2212
self.set_revision_history(self._lefthand_history(revision_id,
2213
last_rev, other_branch))
2215
def basis_tree(self):
2216
"""See Branch.basis_tree."""
2217
return self.repository.revision_tree(self.last_revision())
2219
def _get_parent_location(self):
2220
_locs = ['parent', 'pull', 'x-pull']
2223
return self._transport.get_bytes(l).strip('\n')
2224
except errors.NoSuchFile:
2228
def _basic_push(self, target, overwrite, stop_revision):
2229
"""Basic implementation of push without bound branches or hooks.
2231
Must be called with source read locked and target write locked.
2233
result = BranchPushResult()
2234
result.source_branch = self
2235
result.target_branch = target
2236
result.old_revno, result.old_revid = target.last_revision_info()
2237
self.update_references(target)
2238
if result.old_revid != self.last_revision():
2239
# We assume that during 'push' this repository is closer than
2241
graph = self.repository.get_graph(target.repository)
2242
target.update_revisions(self, stop_revision,
2243
overwrite=overwrite, graph=graph)
2244
if self._push_should_merge_tags():
2245
result.tag_conflicts = self.tags.merge_to(target.tags,
2247
result.new_revno, result.new_revid = target.last_revision_info()
2250
def get_stacked_on_url(self):
2251
raise errors.UnstackableBranchFormat(self._format, self.base)
2253
def set_push_location(self, location):
2254
"""See Branch.set_push_location."""
2255
self.get_config().set_user_option(
2256
'push_location', location,
2257
store=_mod_config.STORE_LOCATION_NORECURSE)
2259
def _set_parent_location(self, url):
2261
self._transport.delete('parent')
2263
self._transport.put_bytes('parent', url + '\n',
2264
mode=self.bzrdir._get_file_mode())
2267
class BzrBranch5(BzrBranch):
2268
"""A format 5 branch. This supports new features over plain branches.
2270
It has support for a master_branch which is the data for bound branches.
2273
def get_bound_location(self):
2275
return self._transport.get_bytes('bound')[:-1]
2276
except errors.NoSuchFile:
2280
def get_master_branch(self, possible_transports=None):
2281
"""Return the branch we are bound to.
2283
:return: Either a Branch, or None
2285
This could memoise the branch, but if thats done
2286
it must be revalidated on each new lock.
2287
So for now we just don't memoise it.
2288
# RBC 20060304 review this decision.
2290
bound_loc = self.get_bound_location()
2294
return Branch.open(bound_loc,
2295
possible_transports=possible_transports)
2296
except (errors.NotBranchError, errors.ConnectionError), e:
2297
raise errors.BoundBranchConnectionFailure(
2301
def set_bound_location(self, location):
2302
"""Set the target where this branch is bound to.
2304
:param location: URL to the target branch
2307
self._transport.put_bytes('bound', location+'\n',
2308
mode=self.bzrdir._get_file_mode())
2311
self._transport.delete('bound')
2312
except errors.NoSuchFile:
2317
def bind(self, other):
2318
"""Bind this branch to the branch other.
2320
This does not push or pull data between the branches, though it does
2321
check for divergence to raise an error when the branches are not
2322
either the same, or one a prefix of the other. That behaviour may not
2323
be useful, so that check may be removed in future.
2325
:param other: The branch to bind to
2328
# TODO: jam 20051230 Consider checking if the target is bound
2329
# It is debatable whether you should be able to bind to
2330
# a branch which is itself bound.
2331
# Committing is obviously forbidden,
2332
# but binding itself may not be.
2333
# Since we *have* to check at commit time, we don't
2334
# *need* to check here
2336
# we want to raise diverged if:
2337
# last_rev is not in the other_last_rev history, AND
2338
# other_last_rev is not in our history, and do it without pulling
2340
self.set_bound_location(other.base)
2344
"""If bound, unbind"""
2345
return self.set_bound_location(None)
2348
def update(self, possible_transports=None):
2349
"""Synchronise this branch with the master branch if any.
2351
:return: None or the last_revision that was pivoted out during the
2354
master = self.get_master_branch(possible_transports)
2355
if master is not None:
2356
old_tip = _mod_revision.ensure_null(self.last_revision())
2357
self.pull(master, overwrite=True)
2358
if self.repository.get_graph().is_ancestor(old_tip,
2359
_mod_revision.ensure_null(self.last_revision())):
2365
class BzrBranch8(BzrBranch5):
2366
"""A branch that stores tree-reference locations."""
2368
def _open_hook(self):
2369
if self._ignore_fallbacks:
2372
url = self.get_stacked_on_url()
2373
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2374
errors.UnstackableBranchFormat):
2377
for hook in Branch.hooks['transform_fallback_location']:
2378
url = hook(self, url)
2380
hook_name = Branch.hooks.get_hook_name(hook)
2381
raise AssertionError(
2382
"'transform_fallback_location' hook %s returned "
2383
"None, not a URL." % hook_name)
2384
self._activate_fallback_location(url, None)
2386
def __init__(self, *args, **kwargs):
2387
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2388
super(BzrBranch8, self).__init__(*args, **kwargs)
2389
self._last_revision_info_cache = None
2390
self._partial_revision_history_cache = []
2391
self._reference_info = None
2393
def _clear_cached_state(self):
2394
super(BzrBranch8, self)._clear_cached_state()
2395
self._last_revision_info_cache = None
2396
self._partial_revision_history_cache = []
2397
self._reference_info = None
2399
def _last_revision_info(self):
2400
revision_string = self._transport.get_bytes('last-revision')
2401
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2402
revision_id = cache_utf8.get_cached_utf8(revision_id)
2404
return revno, revision_id
2406
def _write_last_revision_info(self, revno, revision_id):
2407
"""Simply write out the revision id, with no checks.
2409
Use set_last_revision_info to perform this safely.
2411
Does not update the revision_history cache.
2412
Intended to be called by set_last_revision_info and
2413
_write_revision_history.
2415
revision_id = _mod_revision.ensure_null(revision_id)
2416
out_string = '%d %s\n' % (revno, revision_id)
2417
self._transport.put_bytes('last-revision', out_string,
2418
mode=self.bzrdir._get_file_mode())
2421
def set_last_revision_info(self, revno, revision_id):
2422
revision_id = _mod_revision.ensure_null(revision_id)
2423
old_revno, old_revid = self.last_revision_info()
2424
if self._get_append_revisions_only():
2425
self._check_history_violation(revision_id)
2426
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2427
self._write_last_revision_info(revno, revision_id)
2428
self._clear_cached_state()
2429
self._last_revision_info_cache = revno, revision_id
2430
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2432
def _synchronize_history(self, destination, revision_id):
2433
"""Synchronize last revision and revision history between branches.
2435
:see: Branch._synchronize_history
2437
# XXX: The base Branch has a fast implementation of this method based
2438
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2439
# that uses set_revision_history. This class inherits from BzrBranch5,
2440
# but wants the fast implementation, so it calls
2441
# Branch._synchronize_history directly.
2442
Branch._synchronize_history(self, destination, revision_id)
2444
def _check_history_violation(self, revision_id):
2445
last_revision = _mod_revision.ensure_null(self.last_revision())
2446
if _mod_revision.is_null(last_revision):
2448
if last_revision not in self._lefthand_history(revision_id):
2449
raise errors.AppendRevisionsOnlyViolation(self.base)
2451
def _gen_revision_history(self):
2452
"""Generate the revision history from last revision
2454
last_revno, last_revision = self.last_revision_info()
2455
self._extend_partial_history(stop_index=last_revno-1)
2456
return list(reversed(self._partial_revision_history_cache))
2458
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2459
"""Extend the partial history to include a given index
2461
If a stop_index is supplied, stop when that index has been reached.
2462
If a stop_revision is supplied, stop when that revision is
2463
encountered. Otherwise, stop when the beginning of history is
2466
:param stop_index: The index which should be present. When it is
2467
present, history extension will stop.
2468
:param revision_id: The revision id which should be present. When
2469
it is encountered, history extension will stop.
2471
repo = self.repository
2472
if len(self._partial_revision_history_cache) == 0:
2473
iterator = repo.iter_reverse_revision_history(self.last_revision())
2475
start_revision = self._partial_revision_history_cache[-1]
2476
iterator = repo.iter_reverse_revision_history(start_revision)
2477
#skip the last revision in the list
2478
next_revision = iterator.next()
2479
for revision_id in iterator:
2480
self._partial_revision_history_cache.append(revision_id)
2481
if (stop_index is not None and
2482
len(self._partial_revision_history_cache) > stop_index):
2484
if revision_id == stop_revision:
2487
def _write_revision_history(self, history):
2488
"""Factored out of set_revision_history.
2490
This performs the actual writing to disk, with format-specific checks.
2491
It is intended to be called by BzrBranch5.set_revision_history.
2493
if len(history) == 0:
2494
last_revision = 'null:'
2496
if history != self._lefthand_history(history[-1]):
2497
raise errors.NotLefthandHistory(history)
2498
last_revision = history[-1]
2499
if self._get_append_revisions_only():
2500
self._check_history_violation(last_revision)
2501
self._write_last_revision_info(len(history), last_revision)
2504
def _set_parent_location(self, url):
2505
"""Set the parent branch"""
2506
self._set_config_location('parent_location', url, make_relative=True)
2509
def _get_parent_location(self):
2510
"""Set the parent branch"""
2511
return self._get_config_location('parent_location')
2514
def _set_all_reference_info(self, info_dict):
2515
"""Replace all reference info stored in a branch.
2517
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2520
writer = rio.RioWriter(s)
2521
for key, (tree_path, branch_location) in info_dict.iteritems():
2522
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2523
branch_location=branch_location)
2524
writer.write_stanza(stanza)
2525
self._transport.put_bytes('references', s.getvalue())
2526
self._reference_info = info_dict
2529
def _get_all_reference_info(self):
2530
"""Return all the reference info stored in a branch.
2532
:return: A dict of {file_id: (tree_path, branch_location)}
2534
if self._reference_info is not None:
2535
return self._reference_info
2536
rio_file = self._transport.get('references')
2538
stanzas = rio.read_stanzas(rio_file)
2539
info_dict = dict((s['file_id'], (s['tree_path'],
2540
s['branch_location'])) for s in stanzas)
2543
self._reference_info = info_dict
2546
def set_reference_info(self, file_id, tree_path, branch_location):
2547
"""Set the branch location to use for a tree reference.
2549
:param file_id: The file-id of the tree reference.
2550
:param tree_path: The path of the tree reference in the tree.
2551
:param branch_location: The location of the branch to retrieve tree
2554
info_dict = self._get_all_reference_info()
2555
info_dict[file_id] = (tree_path, branch_location)
2556
if None in (tree_path, branch_location):
2557
if tree_path is not None:
2558
raise ValueError('tree_path must be None when branch_location'
2560
if branch_location is not None:
2561
raise ValueError('branch_location must be None when tree_path'
2563
del info_dict[file_id]
2564
self._set_all_reference_info(info_dict)
2566
def get_reference_info(self, file_id):
2567
"""Get the tree_path and branch_location for a tree reference.
2569
:return: a tuple of (tree_path, branch_location)
2571
return self._get_all_reference_info().get(file_id, (None, None))
2573
def reference_parent(self, file_id, path, possible_transports=None):
2574
"""Return the parent branch for a tree-reference file_id.
2576
:param file_id: The file_id of the tree reference
2577
:param path: The path of the file_id in the tree
2578
:return: A branch associated with the file_id
2580
branch_location = self.get_reference_info(file_id)[1]
2581
if branch_location is None:
2582
return Branch.reference_parent(self, file_id, path,
2583
possible_transports)
2584
branch_location = urlutils.join(self.base, branch_location)
2585
return Branch.open(branch_location,
2586
possible_transports=possible_transports)
2588
def set_push_location(self, location):
2589
"""See Branch.set_push_location."""
2590
self._set_config_location('push_location', location)
2592
def set_bound_location(self, location):
2593
"""See Branch.set_push_location."""
2595
config = self.get_config()
2596
if location is None:
2597
if config.get_user_option('bound') != 'True':
2600
config.set_user_option('bound', 'False', warn_masked=True)
2603
self._set_config_location('bound_location', location,
2605
config.set_user_option('bound', 'True', warn_masked=True)
2608
def _get_bound_location(self, bound):
2609
"""Return the bound location in the config file.
2611
Return None if the bound parameter does not match"""
2612
config = self.get_config()
2613
config_bound = (config.get_user_option('bound') == 'True')
2614
if config_bound != bound:
2616
return self._get_config_location('bound_location', config=config)
2618
def get_bound_location(self):
2619
"""See Branch.set_push_location."""
2620
return self._get_bound_location(True)
2622
def get_old_bound_location(self):
2623
"""See Branch.get_old_bound_location"""
2624
return self._get_bound_location(False)
2626
def get_stacked_on_url(self):
2627
# you can always ask for the URL; but you might not be able to use it
2628
# if the repo can't support stacking.
2629
## self._check_stackable_repo()
2630
stacked_url = self._get_config_location('stacked_on_location')
2631
if stacked_url is None:
2632
raise errors.NotStacked(self)
2635
def set_append_revisions_only(self, enabled):
2640
self.get_config().set_user_option('append_revisions_only', value,
2643
def _get_append_revisions_only(self):
2644
value = self.get_config().get_user_option('append_revisions_only')
2645
return value == 'True'
2648
def generate_revision_history(self, revision_id, last_rev=None,
2650
"""See BzrBranch5.generate_revision_history"""
2651
history = self._lefthand_history(revision_id, last_rev, other_branch)
2652
revno = len(history)
2653
self.set_last_revision_info(revno, revision_id)
2656
def get_rev_id(self, revno, history=None):
2657
"""Find the revision id of the specified revno."""
2659
return _mod_revision.NULL_REVISION
2661
last_revno, last_revision_id = self.last_revision_info()
2662
if revno <= 0 or revno > last_revno:
2663
raise errors.NoSuchRevision(self, revno)
2665
if history is not None:
2666
return history[revno - 1]
2668
index = last_revno - revno
2669
if len(self._partial_revision_history_cache) <= index:
2670
self._extend_partial_history(stop_index=index)
2671
if len(self._partial_revision_history_cache) > index:
2672
return self._partial_revision_history_cache[index]
2674
raise errors.NoSuchRevision(self, revno)
2677
def revision_id_to_revno(self, revision_id):
2678
"""Given a revision id, return its revno"""
2679
if _mod_revision.is_null(revision_id):
2682
index = self._partial_revision_history_cache.index(revision_id)
2684
self._extend_partial_history(stop_revision=revision_id)
2685
index = len(self._partial_revision_history_cache) - 1
2686
if self._partial_revision_history_cache[index] != revision_id:
2687
raise errors.NoSuchRevision(self, revision_id)
2688
return self.revno() - index
2691
class BzrBranch7(BzrBranch8):
2692
"""A branch with support for a fallback repository."""
2694
def set_reference_info(self, file_id, tree_path, branch_location):
2695
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2697
def get_reference_info(self, file_id):
2698
Branch.get_reference_info(self, file_id)
2700
def reference_parent(self, file_id, path, possible_transports=None):
2701
return Branch.reference_parent(self, file_id, path,
2702
possible_transports)
2705
class BzrBranch6(BzrBranch7):
2706
"""See BzrBranchFormat6 for the capabilities of this branch.
2708
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2712
def get_stacked_on_url(self):
2713
raise errors.UnstackableBranchFormat(self._format, self.base)
2716
######################################################################
2717
# results of operations
2720
class _Result(object):
2722
def _show_tag_conficts(self, to_file):
2723
if not getattr(self, 'tag_conflicts', None):
2725
to_file.write('Conflicting tags:\n')
2726
for name, value1, value2 in self.tag_conflicts:
2727
to_file.write(' %s\n' % (name, ))
2730
class PullResult(_Result):
2731
"""Result of a Branch.pull operation.
2733
:ivar old_revno: Revision number before pull.
2734
:ivar new_revno: Revision number after pull.
2735
:ivar old_revid: Tip revision id before pull.
2736
:ivar new_revid: Tip revision id after pull.
2737
:ivar source_branch: Source (local) branch object. (read locked)
2738
:ivar master_branch: Master branch of the target, or the target if no
2740
:ivar local_branch: target branch if there is a Master, else None
2741
:ivar target_branch: Target/destination branch object. (write locked)
2742
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2746
# DEPRECATED: pull used to return the change in revno
2747
return self.new_revno - self.old_revno
2749
def report(self, to_file):
2751
if self.old_revid == self.new_revid:
2752
to_file.write('No revisions to pull.\n')
2754
to_file.write('Now on revision %d.\n' % self.new_revno)
2755
self._show_tag_conficts(to_file)
2758
class BranchPushResult(_Result):
2759
"""Result of a Branch.push operation.
2761
:ivar old_revno: Revision number (eg 10) of the target before push.
2762
:ivar new_revno: Revision number (eg 12) of the target after push.
2763
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2765
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2767
:ivar source_branch: Source branch object that the push was from. This is
2768
read locked, and generally is a local (and thus low latency) branch.
2769
:ivar master_branch: If target is a bound branch, the master branch of
2770
target, or target itself. Always write locked.
2771
:ivar target_branch: The direct Branch where data is being sent (write
2773
:ivar local_branch: If the target is a bound branch this will be the
2774
target, otherwise it will be None.
2778
# DEPRECATED: push used to return the change in revno
2779
return self.new_revno - self.old_revno
2781
def report(self, to_file):
2782
"""Write a human-readable description of the result."""
2783
if self.old_revid == self.new_revid:
2784
note('No new revisions to push.')
2786
note('Pushed up to revision %d.' % self.new_revno)
2787
self._show_tag_conficts(to_file)
2790
class BranchCheckResult(object):
2791
"""Results of checking branch consistency.
2796
def __init__(self, branch):
2797
self.branch = branch
2798
self.ghosts_in_mainline = False
2800
def report_results(self, verbose):
2801
"""Report the check results via trace.note.
2803
:param verbose: Requests more detailed display of what was checked,
2806
note('checked branch %s format %s',
2808
self.branch._format)
2809
if self.ghosts_in_mainline:
2810
note('branch contains ghosts in mainline')
2813
class Converter5to6(object):
2814
"""Perform an in-place upgrade of format 5 to format 6"""
2816
def convert(self, branch):
2817
# Data for 5 and 6 can peacefully coexist.
2818
format = BzrBranchFormat6()
2819
new_branch = format.open(branch.bzrdir, _found=True)
2821
# Copy source data into target
2822
new_branch._write_last_revision_info(*branch.last_revision_info())
2823
new_branch.set_parent(branch.get_parent())
2824
new_branch.set_bound_location(branch.get_bound_location())
2825
new_branch.set_push_location(branch.get_push_location())
2827
# New branch has no tags by default
2828
new_branch.tags._set_tag_dict({})
2830
# Copying done; now update target format
2831
new_branch._transport.put_bytes('format',
2832
format.get_format_string(),
2833
mode=new_branch.bzrdir._get_file_mode())
2835
# Clean up old files
2836
new_branch._transport.delete('revision-history')
2838
branch.set_parent(None)
2839
except errors.NoSuchFile:
2841
branch.set_bound_location(None)
2844
class Converter6to7(object):
2845
"""Perform an in-place upgrade of format 6 to format 7"""
2847
def convert(self, branch):
2848
format = BzrBranchFormat7()
2849
branch._set_config_location('stacked_on_location', '')
2850
# update target format
2851
branch._transport.put_bytes('format', format.get_format_string())
2854
class Converter7to8(object):
2855
"""Perform an in-place upgrade of format 6 to format 7"""
2857
def convert(self, branch):
2858
format = BzrBranchFormat8()
2859
branch._transport.put_bytes('references', '')
2860
# update target format
2861
branch._transport.put_bytes('format', format.get_format_string())
2864
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2865
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2868
_run_with_write_locked_target will attempt to release the lock it acquires.
2870
If an exception is raised by callable, then that exception *will* be
2871
propagated, even if the unlock attempt raises its own error. Thus
2872
_run_with_write_locked_target should be preferred to simply doing::
2876
return callable(*args, **kwargs)
2881
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2882
# should share code?
2885
result = callable(*args, **kwargs)
2887
exc_info = sys.exc_info()
2891
raise exc_info[0], exc_info[1], exc_info[2]
2897
class InterBranch(InterObject):
2898
"""This class represents operations taking place between two branches.
2900
Its instances have methods like pull() and push() and contain
2901
references to the source and target repositories these operations
2902
can be carried out on.
2906
"""The available optimised InterBranch types."""
2909
def _get_branch_formats_to_test():
2910
"""Return a tuple with the Branch formats to use when testing."""
2911
raise NotImplementedError(self._get_branch_formats_to_test)
2913
def pull(self, overwrite=False, stop_revision=None,
2914
possible_transports=None, local=False):
2915
"""Mirror source into target branch.
2917
The target branch is considered to be 'local', having low latency.
2919
:returns: PullResult instance
2921
raise NotImplementedError(self.pull)
2923
def update_revisions(self, stop_revision=None, overwrite=False,
2925
"""Pull in new perfect-fit revisions.
2927
:param stop_revision: Updated until the given revision
2928
:param overwrite: Always set the branch pointer, rather than checking
2929
to see if it is a proper descendant.
2930
:param graph: A Graph object that can be used to query history
2931
information. This can be None.
2934
raise NotImplementedError(self.update_revisions)
2936
def push(self, overwrite=False, stop_revision=None,
2937
_override_hook_source_branch=None):
2938
"""Mirror the source branch into the target branch.
2940
The source branch is considered to be 'local', having low latency.
2942
raise NotImplementedError(self.push)
2945
class GenericInterBranch(InterBranch):
2946
"""InterBranch implementation that uses public Branch functions.
2950
def _get_branch_formats_to_test():
2951
return BranchFormat._default_format, BranchFormat._default_format
2953
def update_revisions(self, stop_revision=None, overwrite=False,
2955
"""See InterBranch.update_revisions()."""
2956
self.source.lock_read()
2958
other_revno, other_last_revision = self.source.last_revision_info()
2959
stop_revno = None # unknown
2960
if stop_revision is None:
2961
stop_revision = other_last_revision
2962
if _mod_revision.is_null(stop_revision):
2963
# if there are no commits, we're done.
2965
stop_revno = other_revno
2967
# what's the current last revision, before we fetch [and change it
2969
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2970
# we fetch here so that we don't process data twice in the common
2971
# case of having something to pull, and so that the check for
2972
# already merged can operate on the just fetched graph, which will
2973
# be cached in memory.
2974
self.target.fetch(self.source, stop_revision)
2975
# Check to see if one is an ancestor of the other
2978
graph = self.target.repository.get_graph()
2979
if self.target._check_if_descendant_or_diverged(
2980
stop_revision, last_rev, graph, self.source):
2981
# stop_revision is a descendant of last_rev, but we aren't
2982
# overwriting, so we're done.
2984
if stop_revno is None:
2986
graph = self.target.repository.get_graph()
2987
this_revno, this_last_revision = \
2988
self.target.last_revision_info()
2989
stop_revno = graph.find_distance_to_null(stop_revision,
2990
[(other_last_revision, other_revno),
2991
(this_last_revision, this_revno)])
2992
self.target.set_last_revision_info(stop_revno, stop_revision)
2994
self.source.unlock()
2996
def pull(self, overwrite=False, stop_revision=None,
2997
possible_transports=None, _hook_master=None, run_hooks=True,
2998
_override_hook_target=None, local=False):
3001
:param _hook_master: Private parameter - set the branch to
3002
be supplied as the master to pull hooks.
3003
:param run_hooks: Private parameter - if false, this branch
3004
is being called because it's the master of the primary branch,
3005
so it should not run its hooks.
3006
:param _override_hook_target: Private parameter - set the branch to be
3007
supplied as the target_branch to pull hooks.
3008
:param local: Only update the local branch, and not the bound branch.
3010
# This type of branch can't be bound.
3012
raise errors.LocalRequiresBoundBranch()
3013
result = PullResult()
3014
result.source_branch = self.source
3015
if _override_hook_target is None:
3016
result.target_branch = self.target
3018
result.target_branch = _override_hook_target
3019
self.source.lock_read()
3021
# We assume that during 'pull' the target repository is closer than
3023
self.source.update_references(self.target)
3024
graph = self.target.repository.get_graph(self.source.repository)
3025
# TODO: Branch formats should have a flag that indicates
3026
# that revno's are expensive, and pull() should honor that flag.
3028
result.old_revno, result.old_revid = \
3029
self.target.last_revision_info()
3030
self.target.update_revisions(self.source, stop_revision,
3031
overwrite=overwrite, graph=graph)
3032
# TODO: The old revid should be specified when merging tags,
3033
# so a tags implementation that versions tags can only
3034
# pull in the most recent changes. -- JRV20090506
3035
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3037
result.new_revno, result.new_revid = self.target.last_revision_info()
3039
result.master_branch = _hook_master
3040
result.local_branch = result.target_branch
3042
result.master_branch = result.target_branch
3043
result.local_branch = None
3045
for hook in Branch.hooks['post_pull']:
3048
self.source.unlock()
3051
def push(self, overwrite=False, stop_revision=None,
3052
_override_hook_source_branch=None):
3053
"""See InterBranch.push.
3055
This is the basic concrete implementation of push()
3057
:param _override_hook_source_branch: If specified, run
3058
the hooks passing this Branch as the source, rather than self.
3059
This is for use of RemoteBranch, where push is delegated to the
3060
underlying vfs-based Branch.
3062
# TODO: Public option to disable running hooks - should be trivial but
3064
self.source.lock_read()
3066
return _run_with_write_locked_target(
3067
self.target, self._push_with_bound_branches, overwrite,
3069
_override_hook_source_branch=_override_hook_source_branch)
3071
self.source.unlock()
3074
def _push_with_bound_branches(self, overwrite, stop_revision,
3075
_override_hook_source_branch=None):
3076
"""Push from source into target, and into target's master if any.
3079
if _override_hook_source_branch:
3080
result.source_branch = _override_hook_source_branch
3081
for hook in Branch.hooks['post_push']:
3084
bound_location = self.target.get_bound_location()
3085
if bound_location and self.target.base != bound_location:
3086
# there is a master branch.
3088
# XXX: Why the second check? Is it even supported for a branch to
3089
# be bound to itself? -- mbp 20070507
3090
master_branch = self.target.get_master_branch()
3091
master_branch.lock_write()
3093
# push into the master from the source branch.
3094
self.source._basic_push(master_branch, overwrite, stop_revision)
3095
# and push into the target branch from the source. Note that we
3096
# push from the source branch again, because its considered the
3097
# highest bandwidth repository.
3098
result = self.source._basic_push(self.target, overwrite,
3100
result.master_branch = master_branch
3101
result.local_branch = self.target
3105
master_branch.unlock()
3108
result = self.source._basic_push(self.target, overwrite,
3110
# TODO: Why set master_branch and local_branch if there's no
3111
# binding? Maybe cleaner to just leave them unset? -- mbp
3113
result.master_branch = self.target
3114
result.local_branch = None
3119
def is_compatible(self, source, target):
3120
# GenericBranch uses the public API, so always compatible
3124
class InterToBranch5(GenericInterBranch):
3127
def _get_branch_formats_to_test():
3128
return BranchFormat._default_format, BzrBranchFormat5()
3130
def pull(self, overwrite=False, stop_revision=None,
3131
possible_transports=None, run_hooks=True,
3132
_override_hook_target=None, local=False):
3133
"""Pull from source into self, updating my master if any.
3135
:param run_hooks: Private parameter - if false, this branch
3136
is being called because it's the master of the primary branch,
3137
so it should not run its hooks.
3139
bound_location = self.target.get_bound_location()
3140
if local and not bound_location:
3141
raise errors.LocalRequiresBoundBranch()
3142
master_branch = None
3143
if not local and bound_location and self.source.base != bound_location:
3144
# not pulling from master, so we need to update master.
3145
master_branch = self.target.get_master_branch(possible_transports)
3146
master_branch.lock_write()
3149
# pull from source into master.
3150
master_branch.pull(self.source, overwrite, stop_revision,
3152
return super(InterToBranch5, self).pull(overwrite,
3153
stop_revision, _hook_master=master_branch,
3154
run_hooks=run_hooks,
3155
_override_hook_target=_override_hook_target)
3158
master_branch.unlock()
3161
InterBranch.register_optimiser(GenericInterBranch)
3162
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
