137
69
"""Branch holding a history of revisions.
140
Base directory of the branch.
146
If _lock_mode is true, a positive count of the number of times the
150
Lock object from bzrlib.lock.
72
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
76
# this is really an instance variable - FIXME move it there
157
# Map some sort of prefix into a namespace
158
# stuff like "revno:10", "revid:", etc.
159
# This should match a prefix with a function which accepts
160
REVISION_NAMESPACES = {}
162
def __init__(self, base, init=False, find_root=True):
163
"""Create new branch object at a particular location.
165
base -- Base directory for the branch.
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
86
self._revision_history_cache = None
87
self._revision_id_to_revno_cache = None
90
"""Break a lock if one is present from another instance.
92
Uses the ui factory to ask for confirmation if the lock may be from
95
This will probe the repository for its lock as well.
97
self.control_files.break_lock()
98
self.repository.break_lock()
99
master = self.get_master_branch()
100
if master is not None:
104
def open(base, _unsupported=False, possible_transports=None):
105
"""Open the branch rooted at base.
107
For instance, if the branch is at URL/.bzr/branch,
108
Branch.open(URL) -> a Branch instance.
110
control = bzrdir.BzrDir.open(base, _unsupported,
111
possible_transports=possible_transports)
112
return control.open_branch(_unsupported)
115
def open_from_transport(transport, _unsupported=False):
116
"""Open the branch rooted at transport"""
117
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
118
return control.open_branch(_unsupported)
121
def open_containing(url, possible_transports=None):
122
"""Open an existing branch which contains url.
167
init -- If True, create new control files in a previously
168
unversioned directory. If False, the branch must already
171
find_root -- If true and init is false, find the root of the
172
existing branch containing base.
174
In the test suite, creation of new trees is tested using the
175
`ScratchBranch` class.
124
This probes for a branch at url, and searches upwards from there.
126
Basically we keep looking up until we find the control directory or
127
run into the root. If there isn't one, raises NotBranchError.
128
If there is one and it is either an unrecognised format or an unsupported
129
format, UnknownFormatError or UnsupportedFormatError are raised.
130
If there is one, it is returned, along with the unused portion of url.
177
from bzrlib.store import ImmutableStore
179
self.base = os.path.realpath(base)
182
self.base = find_branch_root(base)
184
self.base = os.path.realpath(base)
185
if not isdir(self.controlfilename('.')):
186
from errors import NotBranchError
187
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
188
['use "bzr init" to initialize a new working tree',
189
'current bzr can only operate from top-of-tree'])
192
self.text_store = ImmutableStore(self.controlfilename('text-store'))
193
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
194
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
198
return '%s(%r)' % (self.__class__.__name__, self.base)
205
if self._lock_mode or self._lock:
206
from warnings import warn
207
warn("branch %r was not explicitly unlocked" % self)
132
control, relpath = bzrdir.BzrDir.open_containing(url,
134
return control.open_branch(), relpath
136
def get_config(self):
137
return BranchConfig(self)
140
return self.get_config().get_nickname()
142
def _set_nick(self, nick):
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
145
nick = property(_get_nick, _set_nick)
148
raise NotImplementedError(self.is_locked)
212
150
def lock_write(self):
214
if self._lock_mode != 'w':
215
from errors import LockError
216
raise LockError("can't upgrade to a write lock from %r" %
218
self._lock_count += 1
220
from bzrlib.lock import WriteLock
222
self._lock = WriteLock(self.controlfilename('branch-lock'))
223
self._lock_mode = 'w'
151
raise NotImplementedError(self.lock_write)
228
153
def lock_read(self):
230
assert self._lock_mode in ('r', 'w'), \
231
"invalid lock mode %r" % self._lock_mode
232
self._lock_count += 1
234
from bzrlib.lock import ReadLock
236
self._lock = ReadLock(self.controlfilename('branch-lock'))
237
self._lock_mode = 'r'
154
raise NotImplementedError(self.lock_read)
242
156
def unlock(self):
243
if not self._lock_mode:
244
from errors import LockError
245
raise LockError('branch %r is not locked' % (self))
247
if self._lock_count > 1:
248
self._lock_count -= 1
157
raise NotImplementedError(self.unlock)
159
def peek_lock_mode(self):
160
"""Return lock mode for the Branch: 'r', 'w' or None"""
161
raise NotImplementedError(self.peek_lock_mode)
163
def get_physical_lock_status(self):
164
raise NotImplementedError(self.get_physical_lock_status)
167
def get_revision_id_to_revno_map(self):
168
"""Return the revision_id => dotted revno map.
170
This will be regenerated on demand, but will be cached.
172
:return: A dictionary mapping revision_id => dotted revno.
173
This dictionary should not be modified by the caller.
175
if self._revision_id_to_revno_cache is not None:
176
mapping = self._revision_id_to_revno_cache
252
self._lock_mode = self._lock_count = None
178
mapping = self._gen_revno_map()
179
self._cache_revision_id_to_revno(mapping)
180
# TODO: jam 20070417 Since this is being cached, should we be returning
182
# I would rather not, and instead just declare that users should not
183
# modify the return value.
186
def _gen_revno_map(self):
187
"""Create a new mapping from revision ids to dotted revnos.
189
Dotted revnos are generated based on the current tip in the revision
191
This is the worker function for get_revision_id_to_revno_map, which
192
just caches the return value.
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
204
revision_id_to_revno = dict((rev_id, revno)
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
207
return revision_id_to_revno
209
def leave_lock_in_place(self):
210
"""Tell this branch object not to release the physical lock when this
213
If lock_write doesn't return a token, then this method is not supported.
215
self.control_files.leave_in_place()
217
def dont_leave_lock_in_place(self):
218
"""Tell this branch object to release the physical lock when this
219
object is unlocked, even if it didn't originally acquire it.
221
If lock_write doesn't return a token, then this method is not supported.
223
self.control_files.dont_leave_in_place()
225
@deprecated_method(deprecated_in((0, 16, 0)))
255
226
def abspath(self, name):
256
"""Return absolute filename for something in the branch"""
257
return os.path.join(self.base, name)
260
def relpath(self, path):
261
"""Return path relative to this branch of something inside it.
263
Raises an error if path is not in this branch."""
264
return _relpath(self.base, path)
267
def controlfilename(self, file_or_path):
268
"""Return location relative to branch."""
269
if isinstance(file_or_path, basestring):
270
file_or_path = [file_or_path]
271
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
274
def controlfile(self, file_or_path, mode='r'):
275
"""Open a control file for this branch.
277
There are two classes of file in the control directory: text
278
and binary. binary files are untranslated byte streams. Text
279
control files are stored with Unix newlines and in UTF-8, even
280
if the platform or locale defaults are different.
282
Controlfiles should almost never be opened in write mode but
283
rather should be atomically copied and replaced using atomicfile.
286
fn = self.controlfilename(file_or_path)
288
if mode == 'rb' or mode == 'wb':
289
return file(fn, mode)
290
elif mode == 'r' or mode == 'w':
291
# open in binary mode anyhow so there's no newline translation;
292
# codecs uses line buffering by default; don't want that.
294
return codecs.open(fn, mode + 'b', 'utf-8',
297
raise BzrError("invalid controlfile mode %r" % mode)
301
def _make_control(self):
302
from bzrlib.inventory import Inventory
303
from bzrlib.xml import pack_xml
305
os.mkdir(self.controlfilename([]))
306
self.controlfile('README', 'w').write(
307
"This is a Bazaar-NG control directory.\n"
308
"Do not change any files in this directory.\n")
309
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
310
for d in ('text-store', 'inventory-store', 'revision-store'):
311
os.mkdir(self.controlfilename(d))
312
for f in ('revision-history', 'merged-patches',
313
'pending-merged-patches', 'branch-name',
316
self.controlfile(f, 'w').write('')
317
mutter('created control directory in ' + self.base)
319
pack_xml(Inventory(gen_root_id()), self.controlfile('inventory','w'))
322
def _check_format(self):
323
"""Check this branch format is supported.
325
The current tool only supports the current unstable format.
327
In the future, we might need different in-memory Branch
328
classes to support downlevel branches. But not yet.
330
# This ignores newlines so that we can open branches created
331
# on Windows from Linux and so on. I think it might be better
332
# to always make all internal files in unix format.
333
fmt = self.controlfile('branch-format', 'r').read()
334
fmt.replace('\r\n', '')
335
if fmt != BZR_BRANCH_FORMAT:
336
raise BzrError('sorry, branch format %r not supported' % fmt,
337
['use a different bzr version',
338
'or remove the .bzr directory and "bzr init" again'])
340
def get_root_id(self):
341
"""Return the id of this branches root"""
342
inv = self.read_working_inventory()
343
return inv.root.file_id
345
def set_root_id(self, file_id):
346
inv = self.read_working_inventory()
347
orig_root_id = inv.root.file_id
348
del inv._byid[inv.root.file_id]
349
inv.root.file_id = file_id
350
inv._byid[inv.root.file_id] = inv.root
353
if entry.parent_id in (None, orig_root_id):
354
entry.parent_id = inv.root.file_id
355
self._write_inventory(inv)
357
def read_working_inventory(self):
358
"""Read the working inventory."""
359
from bzrlib.inventory import Inventory
360
from bzrlib.xml import unpack_xml
361
from time import time
365
# ElementTree does its own conversion from UTF-8, so open in
367
inv = unpack_xml(Inventory,
368
self.controlfile('inventory', 'rb'))
369
mutter("loaded inventory of %d items in %f"
370
% (len(inv), time() - before))
376
def _write_inventory(self, inv):
377
"""Update the working inventory.
379
That is to say, the inventory describing changes underway, that
380
will be committed to the next revision.
382
from bzrlib.atomicfile import AtomicFile
383
from bzrlib.xml import pack_xml
387
f = AtomicFile(self.controlfilename('inventory'), 'wb')
396
mutter('wrote working inventory')
399
inventory = property(read_working_inventory, _write_inventory, None,
400
"""Inventory for the working copy.""")
403
def add(self, files, verbose=False, ids=None):
404
"""Make files versioned.
406
Note that the command line normally calls smart_add instead.
408
This puts the files in the Added state, so that they will be
409
recorded by the next commit.
412
List of paths to add, relative to the base of the tree.
415
If set, use these instead of automatically generated ids.
416
Must be the same length as the list of files, but may
417
contain None for ids that are to be autogenerated.
419
TODO: Perhaps have an option to add the ids even if the files do
422
TODO: Perhaps return the ids of the files? But then again it
423
is easy to retrieve them if they're needed.
425
TODO: Adding a directory should optionally recurse down and
426
add all non-ignored children. Perhaps do that in a
429
# TODO: Re-adding a file that is removed in the working copy
430
# should probably put it back with the previous ID.
431
if isinstance(files, basestring):
432
assert(ids is None or isinstance(ids, basestring))
438
ids = [None] * len(files)
440
assert(len(ids) == len(files))
444
inv = self.read_working_inventory()
445
for f,file_id in zip(files, ids):
446
if is_control_file(f):
447
raise BzrError("cannot add control file %s" % quotefn(f))
452
raise BzrError("cannot add top-level %r" % f)
454
fullpath = os.path.normpath(self.abspath(f))
457
kind = file_kind(fullpath)
459
# maybe something better?
460
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
462
if kind != 'file' and kind != 'directory':
463
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
file_id = gen_file_id(f)
467
inv.add_path(f, kind=kind, file_id=file_id)
470
print 'added', quotefn(f)
472
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
474
self._write_inventory(inv)
479
def print_file(self, file, revno):
480
"""Print `file` to stdout."""
483
tree = self.revision_tree(self.lookup_revision(revno))
484
# use inventory as it was in that revision
485
file_id = tree.inventory.path2id(file)
487
raise BzrError("%r is not present in revision %s" % (file, revno))
488
tree.print_file(file_id)
493
def remove(self, files, verbose=False):
494
"""Mark nominated files for removal from the inventory.
496
This does not remove their text. This does not run on
498
TODO: Refuse to remove modified files unless --force is given?
500
TODO: Do something useful with directories.
502
TODO: Should this remove the text or not? Tough call; not
503
removing may be useful and the user can just use use rm, and
504
is the opposite of add. Removing it is consistent with most
505
other tools. Maybe an option.
507
## TODO: Normalize names
508
## TODO: Remove nested loops; better scalability
509
if isinstance(files, basestring):
515
tree = self.working_tree()
518
# do this before any modifications
522
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
523
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
525
# having remove it, it must be either ignored or unknown
526
if tree.is_ignored(f):
530
show_status(new_status, inv[fid].kind, quotefn(f))
533
self._write_inventory(inv)
538
# FIXME: this doesn't need to be a branch method
539
def set_inventory(self, new_inventory_list):
540
from bzrlib.inventory import Inventory, InventoryEntry
541
inv = Inventory(self.get_root_id())
542
for path, file_id, parent, kind in new_inventory_list:
543
name = os.path.basename(path)
546
inv.add(InventoryEntry(file_id, name, kind, parent))
547
self._write_inventory(inv)
551
"""Return all unknown files.
553
These are files in the working directory that are not versioned or
554
control files or ignored.
556
>>> b = ScratchBranch(files=['foo', 'foo~'])
557
>>> list(b.unknowns())
560
>>> list(b.unknowns())
563
>>> list(b.unknowns())
566
return self.working_tree().unknowns()
569
def append_revision(self, *revision_ids):
570
from bzrlib.atomicfile import AtomicFile
572
for revision_id in revision_ids:
573
mutter("add {%s} to revision-history" % revision_id)
575
rev_history = self.revision_history()
576
rev_history.extend(revision_ids)
578
f = AtomicFile(self.controlfilename('revision-history'))
580
for rev_id in rev_history:
587
def get_revision_xml(self, revision_id):
588
"""Return XML file object for revision object."""
589
if not revision_id or not isinstance(revision_id, basestring):
590
raise InvalidRevisionId(revision_id)
595
return self.revision_store[revision_id]
597
raise bzrlib.errors.NoSuchRevision(revision_id)
602
def get_revision(self, revision_id):
603
"""Return the Revision object for a named revision"""
604
xml_file = self.get_revision_xml(revision_id)
607
r = unpack_xml(Revision, xml_file)
608
except SyntaxError, e:
609
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
assert r.revision_id == revision_id
227
"""Return absolute filename for something in the branch
229
XXX: Robert Collins 20051017 what is this used for? why is it a branch
230
method and not a tree method.
232
raise NotImplementedError(self.abspath)
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
617
316
def get_revision_delta(self, revno):
618
317
"""Return the delta for one revision.
1125
515
Note that to_name is only the last component of the new name;
1126
516
this doesn't change the directory.
1130
## TODO: Option to move IDs only
1131
assert not isinstance(from_paths, basestring)
1132
tree = self.working_tree()
1133
inv = tree.inventory
1134
to_abs = self.abspath(to_name)
1135
if not isdir(to_abs):
1136
raise BzrError("destination %r is not a directory" % to_abs)
1137
if not tree.has_filename(to_name):
1138
raise BzrError("destination %r not in working directory" % to_abs)
1139
to_dir_id = inv.path2id(to_name)
1140
if to_dir_id == None and to_name != '':
1141
raise BzrError("destination %r is not a versioned directory" % to_name)
1142
to_dir_ie = inv[to_dir_id]
1143
if to_dir_ie.kind not in ('directory', 'root_directory'):
1144
raise BzrError("destination %r is not a directory" % to_abs)
1146
to_idpath = inv.get_idpath(to_dir_id)
1148
for f in from_paths:
1149
if not tree.has_filename(f):
1150
raise BzrError("%r does not exist in working tree" % f)
1151
f_id = inv.path2id(f)
1153
raise BzrError("%r is not versioned" % f)
1154
name_tail = splitpath(f)[-1]
1155
dest_path = appendpath(to_name, name_tail)
1156
if tree.has_filename(dest_path):
1157
raise BzrError("destination %r already exists" % dest_path)
1158
if f_id in to_idpath:
1159
raise BzrError("can't move %r to a subdirectory of itself" % f)
1161
# OK, so there's a race here, it's possible that someone will
1162
# create a file in this interval and then the rename might be
1163
# left half-done. But we should have caught most problems.
1165
for f in from_paths:
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
print "%s => %s" % (f, dest_path)
1169
inv.rename(inv.path2id(f), to_dir_id, name_tail)
518
This returns a list of (from_path, to_path) pairs for each
521
raise NotImplementedError(self.move)
523
def get_parent(self):
524
"""Return the parent location of the branch.
526
This is the default location for push/pull/missing. The usual
527
pattern is that the user can override it by specifying a
530
raise NotImplementedError(self.get_parent)
532
def _set_config_location(self, name, url, config=None,
533
make_relative=False):
535
config = self.get_config()
539
url = urlutils.relative_url(self.base, url)
540
config.set_user_option(name, url, warn_masked=True)
542
def _get_config_location(self, name, config=None):
544
config = self.get_config()
545
location = config.get_user_option(name)
550
def get_submit_branch(self):
551
"""Return the submit location of the branch.
553
This is the default location for bundle. The usual
554
pattern is that the user can override it by specifying a
557
return self.get_config().get_user_option('submit_branch')
559
def set_submit_branch(self, location):
560
"""Return the submit location of the branch.
562
This is the default location for bundle. The usual
563
pattern is that the user can override it by specifying a
566
self.get_config().set_user_option('submit_branch', location,
569
def get_public_branch(self):
570
"""Return the public location of the branch.
572
This is is used by merge directives.
574
return self._get_config_location('public_branch')
576
def set_public_branch(self, location):
577
"""Return the submit location of the branch.
579
This is the default location for bundle. The usual
580
pattern is that the user can override it by specifying a
583
self._set_config_location('public_branch', location)
585
def get_push_location(self):
586
"""Return the None or the location to push this branch to."""
587
push_loc = self.get_config().get_user_option('push_location')
590
def set_push_location(self, location):
591
"""Set a new push location for this branch."""
592
raise NotImplementedError(self.set_push_location)
594
def set_parent(self, url):
595
raise NotImplementedError(self.set_parent)
599
"""Synchronise this branch with the master branch if any.
601
:return: None or the last_revision pivoted out during the update.
605
def check_revno(self, revno):
607
Check whether a revno corresponds to any revision.
608
Zero (the NULL revision) is considered valid.
611
self.check_real_revno(revno)
613
def check_real_revno(self, revno):
615
Check whether a revno corresponds to a real revision.
616
Zero (the NULL revision) is considered invalid
618
if revno < 1 or revno > self.revno():
619
raise errors.InvalidRevisionNumber(revno)
622
def clone(self, to_bzrdir, revision_id=None):
623
"""Clone this branch into to_bzrdir preserving all semantic values.
625
revision_id: if not None, the revision history in the new branch will
626
be truncated to end with revision_id.
628
result = self._format.initialize(to_bzrdir)
629
self.copy_content_into(result, revision_id=revision_id)
633
def sprout(self, to_bzrdir, revision_id=None):
634
"""Create a new line of development from the branch, into to_bzrdir.
636
revision_id: if not None, the revision history in the new branch will
637
be truncated to end with revision_id.
639
result = self._format.initialize(to_bzrdir)
640
self.copy_content_into(result, revision_id=revision_id)
641
result.set_parent(self.bzrdir.root_transport.base)
644
def _synchronize_history(self, destination, revision_id):
645
"""Synchronize last revision and revision history between branches.
647
This version is most efficient when the destination is also a
648
BzrBranch5, but works for BzrBranch6 as long as the revision
649
history is the true lefthand parent history, and all of the revisions
650
are in the destination's repository. If not, set_revision_history
653
:param destination: The branch to copy the history into
654
:param revision_id: The revision-id to truncate history at. May
655
be None to copy complete history.
657
if revision_id == _mod_revision.NULL_REVISION:
659
new_history = self.revision_history()
660
if revision_id is not None and new_history != []:
662
new_history = new_history[:new_history.index(revision_id) + 1]
664
rev = self.repository.get_revision(revision_id)
665
new_history = rev.get_history(self.repository)[1:]
666
destination.set_revision_history(new_history)
669
def copy_content_into(self, destination, revision_id=None):
670
"""Copy the content of self into destination.
672
revision_id: if not None, the revision history in the new branch will
673
be truncated to end with revision_id.
675
self._synchronize_history(destination, revision_id)
677
parent = self.get_parent()
678
except errors.InaccessibleParent, e:
679
mutter('parent was not accessible to copy: %s', e)
682
destination.set_parent(parent)
683
self.tags.merge_to(destination.tags)
687
"""Check consistency of the branch.
689
In particular this checks that revisions given in the revision-history
690
do actually match up in the revision graph, and that they're all
691
present in the repository.
693
Callers will typically also want to check the repository.
695
:return: A BranchCheckResult.
697
mainline_parent_id = None
698
last_revno, last_revision_id = self.last_revision_info()
699
real_rev_history = list(self.repository.iter_reverse_revision_history(
701
real_rev_history.reverse()
702
if len(real_rev_history) != last_revno:
703
raise errors.BzrCheckError('revno does not match len(mainline)'
704
' %s != %s' % (last_revno, len(real_rev_history)))
705
# TODO: We should probably also check that real_rev_history actually
706
# matches self.revision_history()
707
for revision_id in real_rev_history:
709
revision = self.repository.get_revision(revision_id)
710
except errors.NoSuchRevision, e:
711
raise errors.BzrCheckError("mainline revision {%s} not in repository"
713
# In general the first entry on the revision history has no parents.
714
# But it's not illegal for it to have parents listed; this can happen
715
# in imports from Arch when the parents weren't reachable.
716
if mainline_parent_id is not None:
717
if mainline_parent_id not in revision.parent_ids:
718
raise errors.BzrCheckError("previous revision {%s} not listed among "
720
% (mainline_parent_id, revision_id))
721
mainline_parent_id = revision_id
722
return BranchCheckResult(self)
724
def _get_checkout_format(self):
725
"""Return the most suitable metadir for a checkout of this branch.
726
Weaves are used if this branch's repository uses weaves.
728
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
729
from bzrlib.repofmt import weaverepo
730
format = bzrdir.BzrDirMetaFormat1()
731
format.repository_format = weaverepo.RepositoryFormat7()
733
format = self.repository.bzrdir.checkout_metadir()
734
format.set_branch_format(self._format)
737
def create_checkout(self, to_location, revision_id=None,
738
lightweight=False, accelerator_tree=None,
740
"""Create a checkout of a branch.
742
:param to_location: The url to produce the checkout at
743
:param revision_id: The revision to check out
744
:param lightweight: If True, produce a lightweight checkout, otherwise,
745
produce a bound branch (heavyweight checkout)
746
:param accelerator_tree: A tree which can be used for retrieving file
747
contents more quickly than the revision tree, i.e. a workingtree.
748
The revision tree will be used for cases where accelerator_tree's
749
content is different.
750
:param hardlink: If true, hard-link files from accelerator_tree,
752
:return: The tree of the created checkout
754
t = transport.get_transport(to_location)
757
format = self._get_checkout_format()
758
checkout = format.initialize_on_transport(t)
759
from_branch = BranchReferenceFormat().initialize(checkout, self)
761
format = self._get_checkout_format()
762
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
763
to_location, force_new_tree=False, format=format)
764
checkout = checkout_branch.bzrdir
765
checkout_branch.bind(self)
766
# pull up to the specified revision_id to set the initial
767
# branch tip correctly, and seed it with history.
768
checkout_branch.pull(self, stop_revision=revision_id)
770
tree = checkout.create_workingtree(revision_id,
771
from_branch=from_branch,
772
accelerator_tree=accelerator_tree,
774
basis_tree = tree.basis_tree()
775
basis_tree.lock_read()
777
for path, file_id in basis_tree.iter_references():
778
reference_parent = self.reference_parent(file_id, path)
779
reference_parent.create_checkout(tree.abspath(path),
780
basis_tree.get_reference_revision(file_id, path),
787
def reconcile(self, thorough=True):
788
"""Make sure the data stored in this branch is consistent."""
789
from bzrlib.reconcile import BranchReconciler
790
reconciler = BranchReconciler(self, thorough=thorough)
791
reconciler.reconcile()
794
def reference_parent(self, file_id, path):
795
"""Return the parent branch for a tree-reference file_id
796
:param file_id: The file_id of the tree reference
797
:param path: The path of the file_id in the tree
798
:return: A branch associated with the file_id
800
# FIXME should provide multiple branches, based on config
801
return Branch.open(self.bzrdir.root_transport.clone(path).base)
803
def supports_tags(self):
804
return self._format.supports_tags()
807
class BranchFormat(object):
808
"""An encapsulation of the initialization and open routines for a format.
810
Formats provide three things:
811
* An initialization routine,
815
Formats are placed in an dict by their format string for reference
816
during branch opening. Its not required that these be instances, they
817
can be classes themselves with class methods - it simply depends on
818
whether state is needed for a given format or not.
820
Once a format is deprecated, just deprecate the initialize and open
821
methods on the format class. Do not deprecate the object, as the
822
object will be created every time regardless.
825
_default_format = None
826
"""The default format used for new branches."""
829
"""The known formats."""
831
def __eq__(self, other):
832
return self.__class__ is other.__class__
834
def __ne__(self, other):
835
return not (self == other)
838
def find_format(klass, a_bzrdir):
839
"""Return the format for the branch object in a_bzrdir."""
841
transport = a_bzrdir.get_branch_transport(None)
842
format_string = transport.get("format").read()
843
return klass._formats[format_string]
844
except errors.NoSuchFile:
845
raise errors.NotBranchError(path=transport.base)
847
raise errors.UnknownFormatError(format=format_string, kind='branch')
850
def get_default_format(klass):
851
"""Return the current default format."""
852
return klass._default_format
854
def get_reference(self, a_bzrdir):
855
"""Get the target reference of the branch in a_bzrdir.
857
format probing must have been completed before calling
858
this method - it is assumed that the format of the branch
859
in a_bzrdir is correct.
861
:param a_bzrdir: The bzrdir to get the branch data from.
862
:return: None if the branch is not a reference branch.
867
def set_reference(self, a_bzrdir, to_branch):
868
"""Set the target reference of the branch in a_bzrdir.
870
format probing must have been completed before calling
871
this method - it is assumed that the format of the branch
872
in a_bzrdir is correct.
874
:param a_bzrdir: The bzrdir to set the branch reference for.
875
:param to_branch: branch that the checkout is to reference
877
raise NotImplementedError(self.set_reference)
879
def get_format_string(self):
880
"""Return the ASCII format string that identifies this format."""
881
raise NotImplementedError(self.get_format_string)
883
def get_format_description(self):
884
"""Return the short format description for this format."""
885
raise NotImplementedError(self.get_format_description)
887
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
889
"""Initialize a branch in a bzrdir, with specified files
891
:param a_bzrdir: The bzrdir to initialize the branch in
892
:param utf8_files: The files to create as a list of
893
(filename, content) tuples
894
:param set_format: If True, set the format with
895
self.get_format_string. (BzrBranch4 has its format set
897
:return: a branch in this format
899
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
900
branch_transport = a_bzrdir.get_branch_transport(self)
902
'metadir': ('lock', lockdir.LockDir),
903
'branch4': ('branch-lock', lockable_files.TransportLock),
905
lock_name, lock_class = lock_map[lock_type]
906
control_files = lockable_files.LockableFiles(branch_transport,
907
lock_name, lock_class)
908
control_files.create_lock()
909
control_files.lock_write()
911
utf8_files += [('format', self.get_format_string())]
913
for (filename, content) in utf8_files:
914
branch_transport.put_bytes(
916
mode=control_files._file_mode)
918
control_files.unlock()
919
return self.open(a_bzrdir, _found=True)
921
def initialize(self, a_bzrdir):
922
"""Create a branch of this format in a_bzrdir."""
923
raise NotImplementedError(self.initialize)
925
def is_supported(self):
926
"""Is this format supported?
928
Supported formats can be initialized and opened.
929
Unsupported formats may not support initialization or committing or
930
some other features depending on the reason for not being supported.
934
def open(self, a_bzrdir, _found=False):
935
"""Return the branch object for a_bzrdir
937
_found is a private parameter, do not use it. It is used to indicate
938
if format probing has already be done.
940
raise NotImplementedError(self.open)
943
def register_format(klass, format):
944
klass._formats[format.get_format_string()] = format
947
def set_default_format(klass, format):
948
klass._default_format = format
951
def unregister_format(klass, format):
952
del klass._formats[format.get_format_string()]
955
return self.get_format_string().rstrip()
957
def supports_tags(self):
958
"""True if this format supports tags stored in the branch"""
959
return False # by default
962
class BranchHooks(Hooks):
963
"""A dictionary mapping hook name to a list of callables for branch hooks.
965
e.g. ['set_rh'] Is the list of items to be called when the
966
set_revision_history function is invoked.
970
"""Create the default hooks.
972
These are all empty initially, because by default nothing should get
976
# Introduced in 0.15:
977
# invoked whenever the revision history has been set
978
# with set_revision_history. The api signature is
979
# (branch, revision_history), and the branch will
982
# invoked after a push operation completes.
983
# the api signature is
985
# containing the members
986
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
987
# where local is the local target branch or None, master is the target
988
# master branch, and the rest should be self explanatory. The source
989
# is read locked and the target branches write locked. Source will
990
# be the local low-latency branch.
991
self['post_push'] = []
992
# invoked after a pull operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. The local
1000
# branch is the low-latency branch.
1001
self['post_pull'] = []
1002
# invoked before a commit operation takes place.
1003
# the api signature is
1004
# (local, master, old_revno, old_revid, future_revno, future_revid,
1005
# tree_delta, future_tree).
1006
# old_revid is NULL_REVISION for the first commit to a branch
1007
# tree_delta is a TreeDelta object describing changes from the basis
1008
# revision, hooks MUST NOT modify this delta
1009
# future_tree is an in-memory tree obtained from
1010
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1011
self['pre_commit'] = []
1012
# invoked after a commit operation completes.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, new_revno, new_revid)
1015
# old_revid is NULL_REVISION for the first commit to a branch.
1016
self['post_commit'] = []
1017
# invoked after a uncommit operation completes.
1018
# the api signature is
1019
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1020
# local is the local branch or None, master is the target branch,
1021
# and an empty branch recieves new_revno of 0, new_revid of None.
1022
self['post_uncommit'] = []
1024
# Invoked after the tip of a branch changes.
1025
# the api signature is
1026
# (params) where params is a ChangeBranchTipParams with the members
1027
# (branch, old_revno, new_revno, old_revid, new_revid)
1028
self['post_change_branch_tip'] = []
1031
# install the default hooks into the Branch class.
1032
Branch.hooks = BranchHooks()
1035
class ChangeBranchTipParams(object):
1036
"""Object holding parameters passed to *_change_branch_tip hooks.
1038
There are 5 fields that hooks may wish to access:
1040
:ivar branch: the branch being changed
1041
:ivar old_revno: revision number before the change
1042
:ivar new_revno: revision number after the change
1043
:ivar old_revid: revision id before the change
1044
:ivar new_revid: revision id after the change
1046
The revid fields are strings. The revno fields are integers.
1049
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1050
"""Create a group of ChangeBranchTip parameters.
1052
:param branch: The branch being changed.
1053
:param old_revno: Revision number before the change.
1054
:param new_revno: Revision number after the change.
1055
:param old_revid: Tip revision id before the change.
1056
:param new_revid: Tip revision id after the change.
1058
self.branch = branch
1059
self.old_revno = old_revno
1060
self.new_revno = new_revno
1061
self.old_revid = old_revid
1062
self.new_revid = new_revid
1065
class BzrBranchFormat4(BranchFormat):
1066
"""Bzr branch format 4.
1069
- a revision-history file.
1070
- a branch-lock lock file [ to be shared with the bzrdir ]
1073
def get_format_description(self):
1074
"""See BranchFormat.get_format_description()."""
1075
return "Branch format 4"
1077
def initialize(self, a_bzrdir):
1078
"""Create a branch of this format in a_bzrdir."""
1079
utf8_files = [('revision-history', ''),
1080
('branch-name', ''),
1082
return self._initialize_helper(a_bzrdir, utf8_files,
1083
lock_type='branch4', set_format=False)
1086
super(BzrBranchFormat4, self).__init__()
1087
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1089
def open(self, a_bzrdir, _found=False):
1090
"""Return the branch object for a_bzrdir
1092
_found is a private parameter, do not use it. It is used to indicate
1093
if format probing has already be done.
1096
# we are being called directly and must probe.
1097
raise NotImplementedError
1098
return BzrBranch(_format=self,
1099
_control_files=a_bzrdir._control_files,
1101
_repository=a_bzrdir.open_repository())
1104
return "Bazaar-NG branch format 4"
1107
class BzrBranchFormat5(BranchFormat):
1108
"""Bzr branch format 5.
1111
- a revision-history file.
1113
- a lock dir guarding the branch itself
1114
- all of this stored in a branch/ subdirectory
1115
- works with shared repositories.
1117
This format is new in bzr 0.8.
1120
def get_format_string(self):
1121
"""See BranchFormat.get_format_string()."""
1122
return "Bazaar-NG branch format 5\n"
1124
def get_format_description(self):
1125
"""See BranchFormat.get_format_description()."""
1126
return "Branch format 5"
1128
def initialize(self, a_bzrdir):
1129
"""Create a branch of this format in a_bzrdir."""
1130
utf8_files = [('revision-history', ''),
1131
('branch-name', ''),
1133
return self._initialize_helper(a_bzrdir, utf8_files)
1136
super(BzrBranchFormat5, self).__init__()
1137
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1139
def open(self, a_bzrdir, _found=False):
1140
"""Return the branch object for a_bzrdir
1142
_found is a private parameter, do not use it. It is used to indicate
1143
if format probing has already be done.
1146
format = BranchFormat.find_format(a_bzrdir)
1147
if format.__class__ != self.__class__:
1148
raise AssertionError("wrong format %r found for %r" %
1151
transport = a_bzrdir.get_branch_transport(None)
1152
control_files = lockable_files.LockableFiles(transport, 'lock',
1154
return BzrBranch5(_format=self,
1155
_control_files=control_files,
1157
_repository=a_bzrdir.find_repository())
1158
except errors.NoSuchFile:
1159
raise errors.NotBranchError(path=transport.base)
1162
class BzrBranchFormat6(BzrBranchFormat5):
1163
"""Branch format with last-revision and tags.
1165
Unlike previous formats, this has no explicit revision history. Instead,
1166
this just stores the last-revision, and the left-hand history leading
1167
up to there is the history.
1169
This format was introduced in bzr 0.15
1170
and became the default in 0.91.
1173
def get_format_string(self):
1174
"""See BranchFormat.get_format_string()."""
1175
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1177
def get_format_description(self):
1178
"""See BranchFormat.get_format_description()."""
1179
return "Branch format 6"
1181
def initialize(self, a_bzrdir):
1182
"""Create a branch of this format in a_bzrdir."""
1183
utf8_files = [('last-revision', '0 null:\n'),
1184
('branch.conf', ''),
1187
return self._initialize_helper(a_bzrdir, utf8_files)
1189
def open(self, a_bzrdir, _found=False):
1190
"""Return the branch object for a_bzrdir
1192
_found is a private parameter, do not use it. It is used to indicate
1193
if format probing has already be done.
1196
format = BranchFormat.find_format(a_bzrdir)
1197
if format.__class__ != self.__class__:
1198
raise AssertionError("wrong format %r found for %r" %
1200
transport = a_bzrdir.get_branch_transport(None)
1201
control_files = lockable_files.LockableFiles(transport, 'lock',
1203
return BzrBranch6(_format=self,
1204
_control_files=control_files,
1206
_repository=a_bzrdir.find_repository())
1208
def supports_tags(self):
1212
class BranchReferenceFormat(BranchFormat):
1213
"""Bzr branch reference format.
1215
Branch references are used in implementing checkouts, they
1216
act as an alias to the real branch which is at some other url.
1223
def get_format_string(self):
1224
"""See BranchFormat.get_format_string()."""
1225
return "Bazaar-NG Branch Reference Format 1\n"
1227
def get_format_description(self):
1228
"""See BranchFormat.get_format_description()."""
1229
return "Checkout reference format 1"
1231
def get_reference(self, a_bzrdir):
1232
"""See BranchFormat.get_reference()."""
1233
transport = a_bzrdir.get_branch_transport(None)
1234
return transport.get('location').read()
1236
def set_reference(self, a_bzrdir, to_branch):
1237
"""See BranchFormat.set_reference()."""
1238
transport = a_bzrdir.get_branch_transport(None)
1239
location = transport.put_bytes('location', to_branch.base)
1241
def initialize(self, a_bzrdir, target_branch=None):
1242
"""Create a branch of this format in a_bzrdir."""
1243
if target_branch is None:
1244
# this format does not implement branch itself, thus the implicit
1245
# creation contract must see it as uninitializable
1246
raise errors.UninitializableFormat(self)
1247
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1248
branch_transport = a_bzrdir.get_branch_transport(self)
1249
branch_transport.put_bytes('location',
1250
target_branch.bzrdir.root_transport.base)
1251
branch_transport.put_bytes('format', self.get_format_string())
1253
a_bzrdir, _found=True,
1254
possible_transports=[target_branch.bzrdir.root_transport])
1257
super(BranchReferenceFormat, self).__init__()
1258
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1260
def _make_reference_clone_function(format, a_branch):
1261
"""Create a clone() routine for a branch dynamically."""
1262
def clone(to_bzrdir, revision_id=None):
1263
"""See Branch.clone()."""
1264
return format.initialize(to_bzrdir, a_branch)
1265
# cannot obey revision_id limits when cloning a reference ...
1266
# FIXME RBC 20060210 either nuke revision_id for clone, or
1267
# emit some sort of warning/error to the caller ?!
1270
def open(self, a_bzrdir, _found=False, location=None,
1271
possible_transports=None):
1272
"""Return the branch that the branch reference in a_bzrdir points at.
1274
_found is a private parameter, do not use it. It is used to indicate
1275
if format probing has already be done.
1278
format = BranchFormat.find_format(a_bzrdir)
1279
if format.__class__ != self.__class__:
1280
raise AssertionError("wrong format %r found for %r" %
1282
if location is None:
1283
location = self.get_reference(a_bzrdir)
1284
real_bzrdir = bzrdir.BzrDir.open(
1285
location, possible_transports=possible_transports)
1286
result = real_bzrdir.open_branch()
1287
# this changes the behaviour of result.clone to create a new reference
1288
# rather than a copy of the content of the branch.
1289
# I did not use a proxy object because that needs much more extensive
1290
# testing, and we are only changing one behaviour at the moment.
1291
# If we decide to alter more behaviours - i.e. the implicit nickname
1292
# then this should be refactored to introduce a tested proxy branch
1293
# and a subclass of that for use in overriding clone() and ....
1295
result.clone = self._make_reference_clone_function(result)
1299
# formats which have no format string are not discoverable
1300
# and not independently creatable, so are not registered.
1301
__format5 = BzrBranchFormat5()
1302
__format6 = BzrBranchFormat6()
1303
BranchFormat.register_format(__format5)
1304
BranchFormat.register_format(BranchReferenceFormat())
1305
BranchFormat.register_format(__format6)
1306
BranchFormat.set_default_format(__format6)
1307
_legacy_formats = [BzrBranchFormat4(),
1310
class BzrBranch(Branch):
1311
"""A branch stored in the actual filesystem.
1313
Note that it's "local" in the context of the filesystem; it doesn't
1314
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1315
it's writable, and can be accessed via the normal filesystem API.
1317
:ivar _transport: Transport for file operations on this branch's
1318
control files, typically pointing to the .bzr/branch directory.
1319
:ivar repository: Repository for this branch.
1320
:ivar base: The url of the base directory for this branch; the one
1321
containing the .bzr directory.
1324
def __init__(self, _format=None,
1325
_control_files=None, a_bzrdir=None, _repository=None):
1326
"""Create new branch object at a particular location."""
1327
Branch.__init__(self)
1328
if a_bzrdir is None:
1329
raise ValueError('a_bzrdir must be supplied')
1331
self.bzrdir = a_bzrdir
1332
self._base = self.bzrdir.transport.clone('..').base
1333
# self.base = self.bzrdir.root_transport.base
1334
self._format = _format
1335
if _control_files is None:
1336
raise ValueError('BzrBranch _control_files is None')
1337
self.control_files = _control_files
1338
self._transport = _control_files._transport
1339
self.repository = _repository
1342
return '%s(%r)' % (self.__class__.__name__, self.base)
1346
def _get_base(self):
1347
"""Returns the directory containing the control directory."""
1350
base = property(_get_base, doc="The URL for the root of this branch.")
1352
@deprecated_method(deprecated_in((0, 16, 0)))
1353
def abspath(self, name):
1354
"""See Branch.abspath."""
1355
return self._transport.abspath(name)
1357
def is_locked(self):
1358
return self.control_files.is_locked()
1360
def lock_write(self, token=None):
1361
repo_token = self.repository.lock_write()
1363
token = self.control_files.lock_write(token=token)
1365
self.repository.unlock()
1369
def lock_read(self):
1370
self.repository.lock_read()
1372
self.control_files.lock_read()
1374
self.repository.unlock()
1378
# TODO: test for failed two phase locks. This is known broken.
1380
self.control_files.unlock()
1382
self.repository.unlock()
1383
if not self.control_files.is_locked():
1384
# we just released the lock
1385
self._clear_cached_state()
1387
def peek_lock_mode(self):
1388
if self.control_files._lock_count == 0:
1391
return self.control_files._lock_mode
1393
def get_physical_lock_status(self):
1394
return self.control_files.get_physical_lock_status()
1397
def print_file(self, file, revision_id):
1398
"""See Branch.print_file."""
1399
return self.repository.print_file(file, revision_id)
1401
def _write_revision_history(self, history):
1402
"""Factored out of set_revision_history.
1404
This performs the actual writing to disk.
1405
It is intended to be called by BzrBranch5.set_revision_history."""
1406
self._transport.put_bytes(
1407
'revision-history', '\n'.join(history),
1408
mode=self.control_files._file_mode)
1411
def set_revision_history(self, rev_history):
1412
"""See Branch.set_revision_history."""
1413
if 'evil' in debug.debug_flags:
1414
mutter_callsite(3, "set_revision_history scales with history.")
1415
self._write_revision_history(rev_history)
1416
self._clear_cached_state()
1417
self._cache_revision_history(rev_history)
1418
for hook in Branch.hooks['set_rh']:
1419
hook(self, rev_history)
1421
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1422
"""Run the post_change_branch_tip hooks."""
1423
hooks = Branch.hooks['post_change_branch_tip']
1426
new_revno, new_revid = self.last_revision_info()
1427
params = ChangeBranchTipParams(
1428
self, old_revno, new_revno, old_revid, new_revid)
1433
def set_last_revision_info(self, revno, revision_id):
1434
"""Set the last revision of this branch.
1436
The caller is responsible for checking that the revno is correct
1437
for this revision id.
1439
It may be possible to set the branch last revision to an id not
1440
present in the repository. However, branches can also be
1441
configured to check constraints on history, in which case this may not
1444
revision_id = _mod_revision.ensure_null(revision_id)
1445
old_revno, old_revid = self.last_revision_info()
1446
# this old format stores the full history, but this api doesn't
1447
# provide it, so we must generate, and might as well check it's
1449
history = self._lefthand_history(revision_id)
1450
if len(history) != revno:
1451
raise AssertionError('%d != %d' % (len(history), revno))
1452
self.set_revision_history(history)
1453
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1455
def _gen_revision_history(self):
1456
history = self._transport.get_bytes('revision-history').split('\n')
1457
if history[-1:] == ['']:
1458
# There shouldn't be a trailing newline, but just in case.
1462
def _lefthand_history(self, revision_id, last_rev=None,
1464
if 'evil' in debug.debug_flags:
1465
mutter_callsite(4, "_lefthand_history scales with history.")
1466
# stop_revision must be a descendant of last_revision
1467
graph = self.repository.get_graph()
1468
if last_rev is not None:
1469
if not graph.is_ancestor(last_rev, revision_id):
1470
# our previous tip is not merged into stop_revision
1471
raise errors.DivergedBranches(self, other_branch)
1472
# make a new revision history from the graph
1473
parents_map = graph.get_parent_map([revision_id])
1474
if revision_id not in parents_map:
1475
raise errors.NoSuchRevision(self, revision_id)
1476
current_rev_id = revision_id
1478
# Do not include ghosts or graph origin in revision_history
1479
while (current_rev_id in parents_map and
1480
len(parents_map[current_rev_id]) > 0):
1481
new_history.append(current_rev_id)
1482
current_rev_id = parents_map[current_rev_id][0]
1483
parents_map = graph.get_parent_map([current_rev_id])
1484
new_history.reverse()
1488
def generate_revision_history(self, revision_id, last_rev=None,
1490
"""Create a new revision history that will finish with revision_id.
1492
:param revision_id: the new tip to use.
1493
:param last_rev: The previous last_revision. If not None, then this
1494
must be a ancestory of revision_id, or DivergedBranches is raised.
1495
:param other_branch: The other branch that DivergedBranches should
1496
raise with respect to.
1498
self.set_revision_history(self._lefthand_history(revision_id,
1499
last_rev, other_branch))
1502
def update_revisions(self, other, stop_revision=None, overwrite=False):
1503
"""See Branch.update_revisions."""
1506
other_last_revno, other_last_revision = other.last_revision_info()
1507
if stop_revision is None:
1508
stop_revision = other_last_revision
1509
if _mod_revision.is_null(stop_revision):
1510
# if there are no commits, we're done.
1512
# whats the current last revision, before we fetch [and change it
1514
last_rev = _mod_revision.ensure_null(self.last_revision())
1515
# we fetch here so that we don't process data twice in the common
1516
# case of having something to pull, and so that the check for
1517
# already merged can operate on the just fetched graph, which will
1518
# be cached in memory.
1519
self.fetch(other, stop_revision)
1520
# Check to see if one is an ancestor of the other
1522
heads = self.repository.get_graph().heads([stop_revision,
1524
if heads == set([last_rev]):
1525
# The current revision is a decendent of the target,
1528
elif heads == set([stop_revision, last_rev]):
1529
# These branches have diverged
1530
raise errors.DivergedBranches(self, other)
1531
elif heads != set([stop_revision]):
1532
raise AssertionError("invalid heads: %r" % heads)
1533
if other_last_revision == stop_revision:
1534
self.set_last_revision_info(other_last_revno,
1535
other_last_revision)
1537
# TODO: jam 2007-11-29 Is there a way to determine the
1538
# revno without searching all of history??
1540
self.generate_revision_history(stop_revision)
1542
self.generate_revision_history(stop_revision,
1543
last_rev=last_rev, other_branch=other)
1547
def basis_tree(self):
1548
"""See Branch.basis_tree."""
1549
return self.repository.revision_tree(self.last_revision())
1552
def pull(self, source, overwrite=False, stop_revision=None,
1553
_hook_master=None, run_hooks=True, possible_transports=None):
1556
:param _hook_master: Private parameter - set the branch to
1557
be supplied as the master to push hooks.
1558
:param run_hooks: Private parameter - if false, this branch
1559
is being called because it's the master of the primary branch,
1560
so it should not run its hooks.
1562
result = PullResult()
1563
result.source_branch = source
1564
result.target_branch = self
1567
result.old_revno, result.old_revid = self.last_revision_info()
1568
self.update_revisions(source, stop_revision, overwrite=overwrite)
1569
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1570
result.new_revno, result.new_revid = self.last_revision_info()
1572
result.master_branch = _hook_master
1573
result.local_branch = self
1575
result.master_branch = self
1576
result.local_branch = None
1578
for hook in Branch.hooks['post_pull']:
1584
def _get_parent_location(self):
1585
_locs = ['parent', 'pull', 'x-pull']
1588
return self._transport.get_bytes(l).strip('\n')
1589
except errors.NoSuchFile:
1594
def push(self, target, overwrite=False, stop_revision=None,
1595
_override_hook_source_branch=None):
1598
This is the basic concrete implementation of push()
1600
:param _override_hook_source_branch: If specified, run
1601
the hooks passing this Branch as the source, rather than self.
1602
This is for use of RemoteBranch, where push is delegated to the
1603
underlying vfs-based Branch.
1605
# TODO: Public option to disable running hooks - should be trivial but
1609
result = self._push_with_bound_branches(target, overwrite,
1611
_override_hook_source_branch=_override_hook_source_branch)
1616
def _push_with_bound_branches(self, target, overwrite,
1618
_override_hook_source_branch=None):
1619
"""Push from self into target, and into target's master if any.
1621
This is on the base BzrBranch class even though it doesn't support
1622
bound branches because the *target* might be bound.
1625
if _override_hook_source_branch:
1626
result.source_branch = _override_hook_source_branch
1627
for hook in Branch.hooks['post_push']:
1630
bound_location = target.get_bound_location()
1631
if bound_location and target.base != bound_location:
1632
# there is a master branch.
1634
# XXX: Why the second check? Is it even supported for a branch to
1635
# be bound to itself? -- mbp 20070507
1636
master_branch = target.get_master_branch()
1637
master_branch.lock_write()
1639
# push into the master from this branch.
1640
self._basic_push(master_branch, overwrite, stop_revision)
1641
# and push into the target branch from this. Note that we push from
1642
# this branch again, because its considered the highest bandwidth
1644
result = self._basic_push(target, overwrite, stop_revision)
1645
result.master_branch = master_branch
1646
result.local_branch = target
1650
master_branch.unlock()
1653
result = self._basic_push(target, overwrite, stop_revision)
1654
# TODO: Why set master_branch and local_branch if there's no
1655
# binding? Maybe cleaner to just leave them unset? -- mbp
1657
result.master_branch = target
1658
result.local_branch = None
1662
def _basic_push(self, target, overwrite, stop_revision):
1663
"""Basic implementation of push without bound branches or hooks.
1665
Must be called with self read locked and target write locked.
1667
result = PushResult()
1668
result.source_branch = self
1669
result.target_branch = target
1670
result.old_revno, result.old_revid = target.last_revision_info()
1672
target.update_revisions(self, stop_revision)
1673
except errors.DivergedBranches:
1677
target.set_revision_history(self.revision_history())
1678
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1679
result.new_revno, result.new_revid = target.last_revision_info()
1682
def get_parent(self):
1683
"""See Branch.get_parent."""
1684
parent = self._get_parent_location()
1687
# This is an old-format absolute path to a local branch
1688
# turn it into a url
1689
if parent.startswith('/'):
1690
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1692
return urlutils.join(self.base[:-1], parent)
1693
except errors.InvalidURLJoin, e:
1694
raise errors.InaccessibleParent(parent, self.base)
1696
def set_push_location(self, location):
1697
"""See Branch.set_push_location."""
1698
self.get_config().set_user_option(
1699
'push_location', location,
1700
store=_mod_config.STORE_LOCATION_NORECURSE)
1703
def set_parent(self, url):
1704
"""See Branch.set_parent."""
1705
# TODO: Maybe delete old location files?
1706
# URLs should never be unicode, even on the local fs,
1707
# FIXUP this and get_parent in a future branch format bump:
1708
# read and rewrite the file. RBC 20060125
1710
if isinstance(url, unicode):
1171
os.rename(self.abspath(f), self.abspath(dest_path))
1173
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1174
["rename rolled back"])
1176
self._write_inventory(inv)
1181
def revert(self, filenames, old_tree=None, backups=True):
1182
"""Restore selected files to the versions from a previous tree.
1185
If true (default) backups are made of files before
1188
from bzrlib.errors import NotVersionedError, BzrError
1189
from bzrlib.atomicfile import AtomicFile
1190
from bzrlib.osutils import backup_file
1192
inv = self.read_working_inventory()
1193
if old_tree is None:
1194
old_tree = self.basis_tree()
1195
old_inv = old_tree.inventory
1198
for fn in filenames:
1199
file_id = inv.path2id(fn)
1201
raise NotVersionedError("not a versioned file", fn)
1202
if not old_inv.has_id(file_id):
1203
raise BzrError("file not present in old tree", fn, file_id)
1204
nids.append((fn, file_id))
1206
# TODO: Rename back if it was previously at a different location
1208
# TODO: If given a directory, restore the entire contents from
1209
# the previous version.
1211
# TODO: Make a backup to a temporary file.
1213
# TODO: If the file previously didn't exist, delete it?
1214
for fn, file_id in nids:
1217
f = AtomicFile(fn, 'wb')
1219
f.write(old_tree.get_file(file_id).read())
1225
def pending_merges(self):
1226
"""Return a list of pending merges.
1228
These are revisions that have been merged into the working
1229
directory but not yet committed.
1231
cfn = self.controlfilename('pending-merges')
1232
if not os.path.exists(cfn):
1235
for l in self.controlfile('pending-merges', 'r').readlines():
1236
p.append(l.rstrip('\n'))
1240
def add_pending_merge(self, revision_id):
1241
from bzrlib.revision import validate_revision_id
1243
validate_revision_id(revision_id)
1245
p = self.pending_merges()
1246
if revision_id in p:
1248
p.append(revision_id)
1249
self.set_pending_merges(p)
1252
def set_pending_merges(self, rev_list):
1253
from bzrlib.atomicfile import AtomicFile
1256
f = AtomicFile(self.controlfilename('pending-merges'))
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
1712
url = url.encode('ascii')
1713
except UnicodeEncodeError:
1714
raise errors.InvalidURL(url,
1715
"Urls must be 7-bit ascii, "
1716
"use bzrlib.urlutils.escape")
1717
url = urlutils.relative_url(self.base, url)
1718
self._set_parent_location(url)
1720
def _set_parent_location(self, url):
1722
self._transport.delete('parent')
1724
self._transport.put_bytes('parent', url + '\n',
1725
mode=self.control_files._file_mode)
1728
class BzrBranch5(BzrBranch):
1729
"""A format 5 branch. This supports new features over plain branches.
1731
It has support for a master_branch which is the data for bound branches.
1279
def __init__(self, files=[], dirs=[], base=None):
1280
"""Make a test branch.
1282
This creates a temporary directory and runs init-tree in it.
1284
If any files are listed, they are created in the working copy.
1286
from tempfile import mkdtemp
1291
Branch.__init__(self, base, init=init)
1293
os.mkdir(self.abspath(d))
1296
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1301
>>> orig = ScratchBranch(files=["file1", "file2"])
1302
>>> clone = orig.clone()
1303
>>> os.path.samefile(orig.base, clone.base)
1305
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1308
from shutil import copytree
1309
from tempfile import mkdtemp
1312
copytree(self.base, base, symlinks=True)
1313
return ScratchBranch(base=base)
1319
"""Destroy the test branch, removing the scratch directory."""
1320
from shutil import rmtree
1323
mutter("delete ScratchBranch %s" % self.base)
1326
# Work around for shutil.rmtree failing on Windows when
1327
# readonly files are encountered
1328
mutter("hit exception in destroying ScratchBranch: %s" % e)
1329
for root, dirs, files in os.walk(self.base, topdown=False):
1331
os.chmod(os.path.join(root, name), 0700)
1337
######################################################################
1341
def is_control_file(filename):
1342
## FIXME: better check
1343
filename = os.path.normpath(filename)
1344
while filename != '':
1345
head, tail = os.path.split(filename)
1346
## mutter('check %r for control file' % ((head, tail), ))
1347
if tail == bzrlib.BZRDIR:
1739
super(BzrBranch5, self).__init__(_format=_format,
1740
_control_files=_control_files,
1742
_repository=_repository)
1745
def pull(self, source, overwrite=False, stop_revision=None,
1746
run_hooks=True, possible_transports=None):
1747
"""Pull from source into self, updating my master if any.
1749
:param run_hooks: Private parameter - if false, this branch
1750
is being called because it's the master of the primary branch,
1751
so it should not run its hooks.
1753
bound_location = self.get_bound_location()
1754
master_branch = None
1755
if bound_location and source.base != bound_location:
1756
# not pulling from master, so we need to update master.
1757
master_branch = self.get_master_branch(possible_transports)
1758
master_branch.lock_write()
1761
# pull from source into master.
1762
master_branch.pull(source, overwrite, stop_revision,
1764
return super(BzrBranch5, self).pull(source, overwrite,
1765
stop_revision, _hook_master=master_branch,
1766
run_hooks=run_hooks)
1769
master_branch.unlock()
1771
def get_bound_location(self):
1773
return self._transport.get_bytes('bound')[:-1]
1774
except errors.NoSuchFile:
1778
def get_master_branch(self, possible_transports=None):
1779
"""Return the branch we are bound to.
1781
:return: Either a Branch, or None
1783
This could memoise the branch, but if thats done
1784
it must be revalidated on each new lock.
1785
So for now we just don't memoise it.
1786
# RBC 20060304 review this decision.
1788
bound_loc = self.get_bound_location()
1792
return Branch.open(bound_loc,
1793
possible_transports=possible_transports)
1794
except (errors.NotBranchError, errors.ConnectionError), e:
1795
raise errors.BoundBranchConnectionFailure(
1799
def set_bound_location(self, location):
1800
"""Set the target where this branch is bound to.
1802
:param location: URL to the target branch
1805
self._transport.put_bytes('bound', location+'\n')
1808
self._transport.delete('bound')
1809
except errors.NoSuchFile:
1349
if filename == head:
1356
def gen_file_id(name):
1357
"""Return new file id.
1359
This should probably generate proper UUIDs, but for the moment we
1360
cope with just randomness because running uuidgen every time is
1363
from binascii import hexlify
1364
from time import time
1366
# get last component
1367
idx = name.rfind('/')
1369
name = name[idx+1 : ]
1370
idx = name.rfind('\\')
1372
name = name[idx+1 : ]
1374
# make it not a hidden file
1375
name = name.lstrip('.')
1377
# remove any wierd characters; we don't escape them but rather
1378
# just pull them out
1379
name = re.sub(r'[^\w.]', '', name)
1381
s = hexlify(rand_bytes(8))
1382
return '-'.join((name, compact_date(time()), s))
1386
"""Return a new tree-root file id."""
1387
return gen_file_id('TREE_ROOT')
1814
def bind(self, other):
1815
"""Bind this branch to the branch other.
1817
This does not push or pull data between the branches, though it does
1818
check for divergence to raise an error when the branches are not
1819
either the same, or one a prefix of the other. That behaviour may not
1820
be useful, so that check may be removed in future.
1822
:param other: The branch to bind to
1825
# TODO: jam 20051230 Consider checking if the target is bound
1826
# It is debatable whether you should be able to bind to
1827
# a branch which is itself bound.
1828
# Committing is obviously forbidden,
1829
# but binding itself may not be.
1830
# Since we *have* to check at commit time, we don't
1831
# *need* to check here
1833
# we want to raise diverged if:
1834
# last_rev is not in the other_last_rev history, AND
1835
# other_last_rev is not in our history, and do it without pulling
1837
self.set_bound_location(other.base)
1841
"""If bound, unbind"""
1842
return self.set_bound_location(None)
1845
def update(self, possible_transports=None):
1846
"""Synchronise this branch with the master branch if any.
1848
:return: None or the last_revision that was pivoted out during the
1851
master = self.get_master_branch(possible_transports)
1852
if master is not None:
1853
old_tip = _mod_revision.ensure_null(self.last_revision())
1854
self.pull(master, overwrite=True)
1855
if self.repository.get_graph().is_ancestor(old_tip,
1856
_mod_revision.ensure_null(self.last_revision())):
1862
class BzrBranch6(BzrBranch5):
1864
def __init__(self, *args, **kwargs):
1865
super(BzrBranch6, self).__init__(*args, **kwargs)
1866
self._last_revision_info_cache = None
1867
self._partial_revision_history_cache = []
1869
def _clear_cached_state(self):
1870
super(BzrBranch6, self)._clear_cached_state()
1871
self._last_revision_info_cache = None
1872
self._partial_revision_history_cache = []
1875
def last_revision_info(self):
1876
"""Return information about the last revision.
1878
:return: A tuple (revno, revision_id).
1880
if self._last_revision_info_cache is None:
1881
self._last_revision_info_cache = self._last_revision_info()
1882
return self._last_revision_info_cache
1884
def _last_revision_info(self):
1885
revision_string = self._transport.get_bytes('last-revision')
1886
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1887
revision_id = cache_utf8.get_cached_utf8(revision_id)
1889
return revno, revision_id
1891
def _write_last_revision_info(self, revno, revision_id):
1892
"""Simply write out the revision id, with no checks.
1894
Use set_last_revision_info to perform this safely.
1896
Does not update the revision_history cache.
1897
Intended to be called by set_last_revision_info and
1898
_write_revision_history.
1900
revision_id = _mod_revision.ensure_null(revision_id)
1901
out_string = '%d %s\n' % (revno, revision_id)
1902
self._transport.put_bytes('last-revision', out_string,
1903
mode=self.control_files._file_mode)
1906
def set_last_revision_info(self, revno, revision_id):
1907
revision_id = _mod_revision.ensure_null(revision_id)
1908
old_revno, old_revid = self.last_revision_info()
1909
if self._get_append_revisions_only():
1910
self._check_history_violation(revision_id)
1911
self._write_last_revision_info(revno, revision_id)
1912
self._clear_cached_state()
1913
self._last_revision_info_cache = revno, revision_id
1914
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1916
def _check_history_violation(self, revision_id):
1917
last_revision = _mod_revision.ensure_null(self.last_revision())
1918
if _mod_revision.is_null(last_revision):
1920
if last_revision not in self._lefthand_history(revision_id):
1921
raise errors.AppendRevisionsOnlyViolation(self.base)
1923
def _gen_revision_history(self):
1924
"""Generate the revision history from last revision
1926
self._extend_partial_history()
1927
return list(reversed(self._partial_revision_history_cache))
1929
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1930
"""Extend the partial history to include a given index
1932
If a stop_index is supplied, stop when that index has been reached.
1933
If a stop_revision is supplied, stop when that revision is
1934
encountered. Otherwise, stop when the beginning of history is
1937
:param stop_index: The index which should be present. When it is
1938
present, history extension will stop.
1939
:param revision_id: The revision id which should be present. When
1940
it is encountered, history extension will stop.
1942
repo = self.repository
1943
if len(self._partial_revision_history_cache) == 0:
1944
iterator = repo.iter_reverse_revision_history(self.last_revision())
1946
start_revision = self._partial_revision_history_cache[-1]
1947
iterator = repo.iter_reverse_revision_history(start_revision)
1948
#skip the last revision in the list
1949
next_revision = iterator.next()
1950
for revision_id in iterator:
1951
self._partial_revision_history_cache.append(revision_id)
1952
if (stop_index is not None and
1953
len(self._partial_revision_history_cache) > stop_index):
1955
if revision_id == stop_revision:
1958
def _write_revision_history(self, history):
1959
"""Factored out of set_revision_history.
1961
This performs the actual writing to disk, with format-specific checks.
1962
It is intended to be called by BzrBranch5.set_revision_history.
1964
if len(history) == 0:
1965
last_revision = 'null:'
1967
if history != self._lefthand_history(history[-1]):
1968
raise errors.NotLefthandHistory(history)
1969
last_revision = history[-1]
1970
if self._get_append_revisions_only():
1971
self._check_history_violation(last_revision)
1972
self._write_last_revision_info(len(history), last_revision)
1975
def _set_parent_location(self, url):
1976
"""Set the parent branch"""
1977
self._set_config_location('parent_location', url, make_relative=True)
1980
def _get_parent_location(self):
1981
"""Set the parent branch"""
1982
return self._get_config_location('parent_location')
1984
def set_push_location(self, location):
1985
"""See Branch.set_push_location."""
1986
self._set_config_location('push_location', location)
1988
def set_bound_location(self, location):
1989
"""See Branch.set_push_location."""
1991
config = self.get_config()
1992
if location is None:
1993
if config.get_user_option('bound') != 'True':
1996
config.set_user_option('bound', 'False', warn_masked=True)
1999
self._set_config_location('bound_location', location,
2001
config.set_user_option('bound', 'True', warn_masked=True)
2004
def _get_bound_location(self, bound):
2005
"""Return the bound location in the config file.
2007
Return None if the bound parameter does not match"""
2008
config = self.get_config()
2009
config_bound = (config.get_user_option('bound') == 'True')
2010
if config_bound != bound:
2012
return self._get_config_location('bound_location', config=config)
2014
def get_bound_location(self):
2015
"""See Branch.set_push_location."""
2016
return self._get_bound_location(True)
2018
def get_old_bound_location(self):
2019
"""See Branch.get_old_bound_location"""
2020
return self._get_bound_location(False)
2022
def set_append_revisions_only(self, enabled):
2027
self.get_config().set_user_option('append_revisions_only', value,
2030
def _get_append_revisions_only(self):
2031
value = self.get_config().get_user_option('append_revisions_only')
2032
return value == 'True'
2034
def _synchronize_history(self, destination, revision_id):
2035
"""Synchronize last revision and revision history between branches.
2037
This version is most efficient when the destination is also a
2038
BzrBranch6, but works for BzrBranch5, as long as the destination's
2039
repository contains all the lefthand ancestors of the intended
2040
last_revision. If not, set_last_revision_info will fail.
2042
:param destination: The branch to copy the history into
2043
:param revision_id: The revision-id to truncate history at. May
2044
be None to copy complete history.
2046
source_revno, source_revision_id = self.last_revision_info()
2047
if revision_id is None:
2048
revno, revision_id = source_revno, source_revision_id
2049
elif source_revision_id == revision_id:
2050
# we know the revno without needing to walk all of history
2051
revno = source_revno
2053
# To figure out the revno for a random revision, we need to build
2054
# the revision history, and count its length.
2055
# We don't care about the order, just how long it is.
2056
# Alternatively, we could start at the current location, and count
2057
# backwards. But there is no guarantee that we will find it since
2058
# it may be a merged revision.
2059
revno = len(list(self.repository.iter_reverse_revision_history(
2061
destination.set_last_revision_info(revno, revision_id)
2063
def _make_tags(self):
2064
return BasicTags(self)
2067
def generate_revision_history(self, revision_id, last_rev=None,
2069
"""See BzrBranch5.generate_revision_history"""
2070
history = self._lefthand_history(revision_id, last_rev, other_branch)
2071
revno = len(history)
2072
self.set_last_revision_info(revno, revision_id)
2075
def get_rev_id(self, revno, history=None):
2076
"""Find the revision id of the specified revno."""
2078
return _mod_revision.NULL_REVISION
2080
last_revno, last_revision_id = self.last_revision_info()
2081
if revno <= 0 or revno > last_revno:
2082
raise errors.NoSuchRevision(self, revno)
2084
if history is not None:
2085
return history[revno - 1]
2087
index = last_revno - revno
2088
if len(self._partial_revision_history_cache) <= index:
2089
self._extend_partial_history(stop_index=index)
2090
if len(self._partial_revision_history_cache) > index:
2091
return self._partial_revision_history_cache[index]
2093
raise errors.NoSuchRevision(self, revno)
2096
def revision_id_to_revno(self, revision_id):
2097
"""Given a revision id, return its revno"""
2098
if _mod_revision.is_null(revision_id):
2101
index = self._partial_revision_history_cache.index(revision_id)
2103
self._extend_partial_history(stop_revision=revision_id)
2104
index = len(self._partial_revision_history_cache) - 1
2105
if self._partial_revision_history_cache[index] != revision_id:
2106
raise errors.NoSuchRevision(self, revision_id)
2107
return self.revno() - index
2110
######################################################################
2111
# results of operations
2114
class _Result(object):
2116
def _show_tag_conficts(self, to_file):
2117
if not getattr(self, 'tag_conflicts', None):
2119
to_file.write('Conflicting tags:\n')
2120
for name, value1, value2 in self.tag_conflicts:
2121
to_file.write(' %s\n' % (name, ))
2124
class PullResult(_Result):
2125
"""Result of a Branch.pull operation.
2127
:ivar old_revno: Revision number before pull.
2128
:ivar new_revno: Revision number after pull.
2129
:ivar old_revid: Tip revision id before pull.
2130
:ivar new_revid: Tip revision id after pull.
2131
:ivar source_branch: Source (local) branch object.
2132
:ivar master_branch: Master branch of the target, or None.
2133
:ivar target_branch: Target/destination branch object.
2137
# DEPRECATED: pull used to return the change in revno
2138
return self.new_revno - self.old_revno
2140
def report(self, to_file):
2142
if self.old_revid == self.new_revid:
2143
to_file.write('No revisions to pull.\n')
2145
to_file.write('Now on revision %d.\n' % self.new_revno)
2146
self._show_tag_conficts(to_file)
2149
class PushResult(_Result):
2150
"""Result of a Branch.push operation.
2152
:ivar old_revno: Revision number before push.
2153
:ivar new_revno: Revision number after push.
2154
:ivar old_revid: Tip revision id before push.
2155
:ivar new_revid: Tip revision id after push.
2156
:ivar source_branch: Source branch object.
2157
:ivar master_branch: Master branch of the target, or None.
2158
:ivar target_branch: Target/destination branch object.
2162
# DEPRECATED: push used to return the change in revno
2163
return self.new_revno - self.old_revno
2165
def report(self, to_file):
2166
"""Write a human-readable description of the result."""
2167
if self.old_revid == self.new_revid:
2168
to_file.write('No new revisions to push.\n')
2170
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2171
self._show_tag_conficts(to_file)
2174
class BranchCheckResult(object):
2175
"""Results of checking branch consistency.
2180
def __init__(self, branch):
2181
self.branch = branch
2183
def report_results(self, verbose):
2184
"""Report the check results via trace.note.
2186
:param verbose: Requests more detailed display of what was checked,
2189
note('checked branch %s format %s',
2191
self.branch._format)
2194
class Converter5to6(object):
2195
"""Perform an in-place upgrade of format 5 to format 6"""
2197
def convert(self, branch):
2198
# Data for 5 and 6 can peacefully coexist.
2199
format = BzrBranchFormat6()
2200
new_branch = format.open(branch.bzrdir, _found=True)
2202
# Copy source data into target
2203
new_branch._write_last_revision_info(*branch.last_revision_info())
2204
new_branch.set_parent(branch.get_parent())
2205
new_branch.set_bound_location(branch.get_bound_location())
2206
new_branch.set_push_location(branch.get_push_location())
2208
# New branch has no tags by default
2209
new_branch.tags._set_tag_dict({})
2211
# Copying done; now update target format
2212
new_branch._transport.put_bytes('format',
2213
format.get_format_string(),
2214
mode=new_branch.control_files._file_mode)
2216
# Clean up old files
2217
new_branch._transport.delete('revision-history')
2219
branch.set_parent(None)
2220
except errors.NoSuchFile:
2222
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
