137
65
"""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.
68
Base directory/url of the branch.
70
hooks: An instance of BranchHooks.
72
# 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.
76
# override this to set the strategy for storing tags
78
return DisabledTags(self)
80
def __init__(self, *ignored, **ignored_too):
81
self.tags = self._make_tags()
82
self._revision_history_cache = None
83
self._revision_id_to_revno_cache = None
86
"""Break a lock if one is present from another instance.
88
Uses the ui factory to ask for confirmation if the lock may be from
91
This will probe the repository for its lock as well.
93
self.control_files.break_lock()
94
self.repository.break_lock()
95
master = self.get_master_branch()
96
if master is not None:
100
def open(base, _unsupported=False, possible_transports=None):
101
"""Open the branch rooted at base.
103
For instance, if the branch is at URL/.bzr/branch,
104
Branch.open(URL) -> a Branch instance.
106
control = bzrdir.BzrDir.open(base, _unsupported,
107
possible_transports=possible_transports)
108
return control.open_branch(_unsupported)
111
def open_from_transport(transport, _unsupported=False):
112
"""Open the branch rooted at transport"""
113
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
114
return control.open_branch(_unsupported)
117
def open_containing(url, possible_transports=None):
118
"""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.
120
This probes for a branch at url, and searches upwards from there.
122
Basically we keep looking up until we find the control directory or
123
run into the root. If there isn't one, raises NotBranchError.
124
If there is one and it is either an unrecognised format or an unsupported
125
format, UnknownFormatError or UnsupportedFormatError are raised.
126
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)
128
control, relpath = bzrdir.BzrDir.open_containing(url,
130
return control.open_branch(), relpath
132
def get_config(self):
133
return BranchConfig(self)
136
return self.get_config().get_nickname()
138
def _set_nick(self, nick):
139
self.get_config().set_user_option('nickname', nick, warn_masked=True)
141
nick = property(_get_nick, _set_nick)
144
raise NotImplementedError(self.is_locked)
212
146
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'
147
raise NotImplementedError(self.lock_write)
228
149
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'
150
raise NotImplementedError(self.lock_read)
242
152
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
153
raise NotImplementedError(self.unlock)
155
def peek_lock_mode(self):
156
"""Return lock mode for the Branch: 'r', 'w' or None"""
157
raise NotImplementedError(self.peek_lock_mode)
159
def get_physical_lock_status(self):
160
raise NotImplementedError(self.get_physical_lock_status)
163
def get_revision_id_to_revno_map(self):
164
"""Return the revision_id => dotted revno map.
166
This will be regenerated on demand, but will be cached.
168
:return: A dictionary mapping revision_id => dotted revno.
169
This dictionary should not be modified by the caller.
171
if self._revision_id_to_revno_cache is not None:
172
mapping = self._revision_id_to_revno_cache
252
self._lock_mode = self._lock_count = None
174
mapping = self._gen_revno_map()
175
self._cache_revision_id_to_revno(mapping)
176
# TODO: jam 20070417 Since this is being cached, should we be returning
178
# I would rather not, and instead just declare that users should not
179
# modify the return value.
182
def _gen_revno_map(self):
183
"""Create a new mapping from revision ids to dotted revnos.
185
Dotted revnos are generated based on the current tip in the revision
187
This is the worker function for get_revision_id_to_revno_map, which
188
just caches the return value.
190
:return: A dictionary mapping revision_id => dotted revno.
192
last_revision = self.last_revision()
193
revision_graph = repository._old_get_graph(self.repository,
195
merge_sorted_revisions = tsort.merge_sort(
200
revision_id_to_revno = dict((rev_id, revno)
201
for seq_num, rev_id, depth, revno, end_of_merge
202
in merge_sorted_revisions)
203
return revision_id_to_revno
205
def leave_lock_in_place(self):
206
"""Tell this branch object not to release the physical lock when this
209
If lock_write doesn't return a token, then this method is not supported.
211
self.control_files.leave_in_place()
213
def dont_leave_lock_in_place(self):
214
"""Tell this branch object to release the physical lock when this
215
object is unlocked, even if it didn't originally acquire it.
217
If lock_write doesn't return a token, then this method is not supported.
219
self.control_files.dont_leave_in_place()
255
221
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
222
"""Return absolute filename for something in the branch
224
XXX: Robert Collins 20051017 what is this used for? why is it a branch
225
method and not a tree method.
227
raise NotImplementedError(self.abspath)
229
def bind(self, other):
230
"""Bind the local branch the other branch.
232
:param other: The branch to bind to
235
raise errors.UpgradeRequired(self.base)
238
def fetch(self, from_branch, last_revision=None, pb=None):
239
"""Copy revisions from from_branch into this branch.
241
:param from_branch: Where to copy from.
242
:param last_revision: What revision to stop at (None for at the end
244
:param pb: An optional progress bar to use.
246
Returns the copied revision count and the failed revisions in a tuple:
249
if self.base == from_branch.base:
252
nested_pb = ui.ui_factory.nested_progress_bar()
257
from_branch.lock_read()
259
if last_revision is None:
260
pb.update('get source history')
261
last_revision = from_branch.last_revision()
262
last_revision = _mod_revision.ensure_null(last_revision)
263
return self.repository.fetch(from_branch.repository,
264
revision_id=last_revision,
267
if nested_pb is not None:
271
def get_bound_location(self):
272
"""Return the URL of the branch we are bound to.
274
Older format branches cannot bind, please be sure to use a metadir
279
def get_old_bound_location(self):
280
"""Return the URL of the branch we used to be bound to
282
raise errors.UpgradeRequired(self.base)
284
def get_commit_builder(self, parents, config=None, timestamp=None,
285
timezone=None, committer=None, revprops=None,
287
"""Obtain a CommitBuilder for this branch.
289
:param parents: Revision ids of the parents of the new revision.
290
:param config: Optional configuration to use.
291
:param timestamp: Optional timestamp recorded for commit.
292
:param timezone: Optional timezone for timestamp.
293
:param committer: Optional committer to set for commit.
294
:param revprops: Optional dictionary of revision properties.
295
:param revision_id: Optional revision id.
299
config = self.get_config()
301
return self.repository.get_commit_builder(self, parents, config,
302
timestamp, timezone, committer, revprops, revision_id)
304
def get_master_branch(self, possible_transports=None):
305
"""Return the branch we are bound to.
307
:return: Either a Branch, or None
617
311
def get_revision_delta(self, revno):
618
312
"""Return the delta for one revision.
1125
512
Note that to_name is only the last component of the new name;
1126
513
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)
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:
515
This returns a list of (from_path, to_path) pairs for each
518
raise NotImplementedError(self.move)
520
def get_parent(self):
521
"""Return the parent location of the branch.
523
This is the default location for push/pull/missing. The usual
524
pattern is that the user can override it by specifying a
527
raise NotImplementedError(self.get_parent)
529
def _set_config_location(self, name, url, config=None,
530
make_relative=False):
532
config = self.get_config()
536
url = urlutils.relative_url(self.base, url)
537
config.set_user_option(name, url, warn_masked=True)
539
def _get_config_location(self, name, config=None):
541
config = self.get_config()
542
location = config.get_user_option(name)
547
def get_submit_branch(self):
548
"""Return the submit location of the branch.
550
This is the default location for bundle. The usual
551
pattern is that the user can override it by specifying a
554
return self.get_config().get_user_option('submit_branch')
556
def set_submit_branch(self, location):
557
"""Return the submit location of the branch.
559
This is the default location for bundle. The usual
560
pattern is that the user can override it by specifying a
563
self.get_config().set_user_option('submit_branch', location,
566
def get_public_branch(self):
567
"""Return the public location of the branch.
569
This is is used by merge directives.
571
return self._get_config_location('public_branch')
573
def set_public_branch(self, location):
574
"""Return the submit location of the branch.
576
This is the default location for bundle. The usual
577
pattern is that the user can override it by specifying a
580
self._set_config_location('public_branch', location)
582
def get_push_location(self):
583
"""Return the None or the location to push this branch to."""
584
push_loc = self.get_config().get_user_option('push_location')
587
def set_push_location(self, location):
588
"""Set a new push location for this branch."""
589
raise NotImplementedError(self.set_push_location)
591
def set_parent(self, url):
592
raise NotImplementedError(self.set_parent)
596
"""Synchronise this branch with the master branch if any.
598
:return: None or the last_revision pivoted out during the update.
602
def check_revno(self, revno):
604
Check whether a revno corresponds to any revision.
605
Zero (the NULL revision) is considered valid.
608
self.check_real_revno(revno)
610
def check_real_revno(self, revno):
612
Check whether a revno corresponds to a real revision.
613
Zero (the NULL revision) is considered invalid
615
if revno < 1 or revno > self.revno():
616
raise errors.InvalidRevisionNumber(revno)
619
def clone(self, to_bzrdir, revision_id=None):
620
"""Clone this branch into to_bzrdir preserving all semantic values.
622
revision_id: if not None, the revision history in the new branch will
623
be truncated to end with revision_id.
625
result = self._format.initialize(to_bzrdir)
626
self.copy_content_into(result, revision_id=revision_id)
630
def sprout(self, to_bzrdir, revision_id=None):
631
"""Create a new line of development from the branch, into to_bzrdir.
633
revision_id: if not None, the revision history in the new branch will
634
be truncated to end with revision_id.
636
result = self._format.initialize(to_bzrdir)
637
self.copy_content_into(result, revision_id=revision_id)
638
result.set_parent(self.bzrdir.root_transport.base)
641
def _synchronize_history(self, destination, revision_id):
642
"""Synchronize last revision and revision history between branches.
644
This version is most efficient when the destination is also a
645
BzrBranch5, but works for BzrBranch6 as long as the revision
646
history is the true lefthand parent history, and all of the revisions
647
are in the destination's repository. If not, set_revision_history
650
:param destination: The branch to copy the history into
651
:param revision_id: The revision-id to truncate history at. May
652
be None to copy complete history.
654
if revision_id == _mod_revision.NULL_REVISION:
656
new_history = self.revision_history()
657
if revision_id is not None and new_history != []:
659
new_history = new_history[:new_history.index(revision_id) + 1]
661
rev = self.repository.get_revision(revision_id)
662
new_history = rev.get_history(self.repository)[1:]
663
destination.set_revision_history(new_history)
666
def copy_content_into(self, destination, revision_id=None):
667
"""Copy the content of self into destination.
669
revision_id: if not None, the revision history in the new branch will
670
be truncated to end with revision_id.
672
self._synchronize_history(destination, revision_id)
674
parent = self.get_parent()
675
except errors.InaccessibleParent, e:
676
mutter('parent was not accessible to copy: %s', e)
679
destination.set_parent(parent)
680
self.tags.merge_to(destination.tags)
684
"""Check consistency of the branch.
686
In particular this checks that revisions given in the revision-history
687
do actually match up in the revision graph, and that they're all
688
present in the repository.
690
Callers will typically also want to check the repository.
692
:return: A BranchCheckResult.
694
mainline_parent_id = None
695
last_revno, last_revision_id = self.last_revision_info()
696
real_rev_history = list(self.repository.iter_reverse_revision_history(
698
real_rev_history.reverse()
699
if len(real_rev_history) != last_revno:
700
raise errors.BzrCheckError('revno does not match len(mainline)'
701
' %s != %s' % (last_revno, len(real_rev_history)))
702
# TODO: We should probably also check that real_rev_history actually
703
# matches self.revision_history()
704
for revision_id in real_rev_history:
706
revision = self.repository.get_revision(revision_id)
707
except errors.NoSuchRevision, e:
708
raise errors.BzrCheckError("mainline revision {%s} not in repository"
710
# In general the first entry on the revision history has no parents.
711
# But it's not illegal for it to have parents listed; this can happen
712
# in imports from Arch when the parents weren't reachable.
713
if mainline_parent_id is not None:
714
if mainline_parent_id not in revision.parent_ids:
715
raise errors.BzrCheckError("previous revision {%s} not listed among "
717
% (mainline_parent_id, revision_id))
718
mainline_parent_id = revision_id
719
return BranchCheckResult(self)
721
def _get_checkout_format(self):
722
"""Return the most suitable metadir for a checkout of this branch.
723
Weaves are used if this branch's repository uses weaves.
725
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
726
from bzrlib.repofmt import weaverepo
727
format = bzrdir.BzrDirMetaFormat1()
728
format.repository_format = weaverepo.RepositoryFormat7()
730
format = self.repository.bzrdir.checkout_metadir()
731
format.set_branch_format(self._format)
734
def create_checkout(self, to_location, revision_id=None,
735
lightweight=False, accelerator_tree=None,
737
"""Create a checkout of a branch.
739
:param to_location: The url to produce the checkout at
740
:param revision_id: The revision to check out
741
:param lightweight: If True, produce a lightweight checkout, otherwise,
742
produce a bound branch (heavyweight checkout)
743
:param accelerator_tree: A tree which can be used for retrieving file
744
contents more quickly than the revision tree, i.e. a workingtree.
745
The revision tree will be used for cases where accelerator_tree's
746
content is different.
747
:param hardlink: If true, hard-link files from accelerator_tree,
749
:return: The tree of the created checkout
751
t = transport.get_transport(to_location)
754
format = self._get_checkout_format()
755
checkout = format.initialize_on_transport(t)
756
from_branch = BranchReferenceFormat().initialize(checkout, self)
758
format = self._get_checkout_format()
759
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
760
to_location, force_new_tree=False, format=format)
761
checkout = checkout_branch.bzrdir
762
checkout_branch.bind(self)
763
# pull up to the specified revision_id to set the initial
764
# branch tip correctly, and seed it with history.
765
checkout_branch.pull(self, stop_revision=revision_id)
767
tree = checkout.create_workingtree(revision_id,
768
from_branch=from_branch,
769
accelerator_tree=accelerator_tree,
771
basis_tree = tree.basis_tree()
772
basis_tree.lock_read()
774
for path, file_id in basis_tree.iter_references():
775
reference_parent = self.reference_parent(file_id, path)
776
reference_parent.create_checkout(tree.abspath(path),
777
basis_tree.get_reference_revision(file_id, path),
784
def reconcile(self, thorough=True):
785
"""Make sure the data stored in this branch is consistent."""
786
from bzrlib.reconcile import BranchReconciler
787
reconciler = BranchReconciler(self, thorough=thorough)
788
reconciler.reconcile()
791
def reference_parent(self, file_id, path):
792
"""Return the parent branch for a tree-reference file_id
793
:param file_id: The file_id of the tree reference
794
:param path: The path of the file_id in the tree
795
:return: A branch associated with the file_id
797
# FIXME should provide multiple branches, based on config
798
return Branch.open(self.bzrdir.root_transport.clone(path).base)
800
def supports_tags(self):
801
return self._format.supports_tags()
804
class BranchFormat(object):
805
"""An encapsulation of the initialization and open routines for a format.
807
Formats provide three things:
808
* An initialization routine,
812
Formats are placed in an dict by their format string for reference
813
during branch opening. Its not required that these be instances, they
814
can be classes themselves with class methods - it simply depends on
815
whether state is needed for a given format or not.
817
Once a format is deprecated, just deprecate the initialize and open
818
methods on the format class. Do not deprecate the object, as the
819
object will be created every time regardless.
822
_default_format = None
823
"""The default format used for new branches."""
826
"""The known formats."""
828
def __eq__(self, other):
829
return self.__class__ is other.__class__
831
def __ne__(self, other):
832
return not (self == other)
835
def find_format(klass, a_bzrdir):
836
"""Return the format for the branch object in a_bzrdir."""
838
transport = a_bzrdir.get_branch_transport(None)
839
format_string = transport.get("format").read()
840
return klass._formats[format_string]
841
except errors.NoSuchFile:
842
raise errors.NotBranchError(path=transport.base)
844
raise errors.UnknownFormatError(format=format_string, kind='branch')
847
def get_default_format(klass):
848
"""Return the current default format."""
849
return klass._default_format
851
def get_reference(self, a_bzrdir):
852
"""Get the target reference of the branch in a_bzrdir.
854
format probing must have been completed before calling
855
this method - it is assumed that the format of the branch
856
in a_bzrdir is correct.
858
:param a_bzrdir: The bzrdir to get the branch data from.
859
:return: None if the branch is not a reference branch.
864
def set_reference(self, a_bzrdir, to_branch):
865
"""Set the target reference of the branch in a_bzrdir.
867
format probing must have been completed before calling
868
this method - it is assumed that the format of the branch
869
in a_bzrdir is correct.
871
:param a_bzrdir: The bzrdir to set the branch reference for.
872
:param to_branch: branch that the checkout is to reference
874
raise NotImplementedError(self.set_reference)
876
def get_format_string(self):
877
"""Return the ASCII format string that identifies this format."""
878
raise NotImplementedError(self.get_format_string)
880
def get_format_description(self):
881
"""Return the short format description for this format."""
882
raise NotImplementedError(self.get_format_description)
884
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
886
"""Initialize a branch in a bzrdir, with specified files
888
:param a_bzrdir: The bzrdir to initialize the branch in
889
:param utf8_files: The files to create as a list of
890
(filename, content) tuples
891
:param set_format: If True, set the format with
892
self.get_format_string. (BzrBranch4 has its format set
894
:return: a branch in this format
896
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
897
branch_transport = a_bzrdir.get_branch_transport(self)
899
'metadir': ('lock', lockdir.LockDir),
900
'branch4': ('branch-lock', lockable_files.TransportLock),
902
lock_name, lock_class = lock_map[lock_type]
903
control_files = lockable_files.LockableFiles(branch_transport,
904
lock_name, lock_class)
905
control_files.create_lock()
906
control_files.lock_write()
908
control_files.put_utf8('format', self.get_format_string())
910
for file, content in utf8_files:
911
control_files.put_utf8(file, content)
913
control_files.unlock()
914
return self.open(a_bzrdir, _found=True)
916
def initialize(self, a_bzrdir):
917
"""Create a branch of this format in a_bzrdir."""
918
raise NotImplementedError(self.initialize)
920
def is_supported(self):
921
"""Is this format supported?
923
Supported formats can be initialized and opened.
924
Unsupported formats may not support initialization or committing or
925
some other features depending on the reason for not being supported.
929
def open(self, a_bzrdir, _found=False):
930
"""Return the branch object for a_bzrdir
932
_found is a private parameter, do not use it. It is used to indicate
933
if format probing has already be done.
935
raise NotImplementedError(self.open)
938
def register_format(klass, format):
939
klass._formats[format.get_format_string()] = format
942
def set_default_format(klass, format):
943
klass._default_format = format
946
def unregister_format(klass, format):
947
assert klass._formats[format.get_format_string()] is format
948
del klass._formats[format.get_format_string()]
951
return self.get_format_string().rstrip()
953
def supports_tags(self):
954
"""True if this format supports tags stored in the branch"""
955
return False # by default
957
# XXX: Probably doesn't really belong here -- mbp 20070212
958
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
960
branch_transport = a_bzrdir.get_branch_transport(self)
961
control_files = lockable_files.LockableFiles(branch_transport,
962
lock_filename, lock_class)
963
control_files.create_lock()
964
control_files.lock_write()
966
for filename, content in utf8_files:
967
control_files.put_utf8(filename, content)
969
control_files.unlock()
972
class BranchHooks(Hooks):
973
"""A dictionary mapping hook name to a list of callables for branch hooks.
975
e.g. ['set_rh'] Is the list of items to be called when the
976
set_revision_history function is invoked.
980
"""Create the default hooks.
982
These are all empty initially, because by default nothing should get
986
# Introduced in 0.15:
987
# invoked whenever the revision history has been set
988
# with set_revision_history. The api signature is
989
# (branch, revision_history), and the branch will
992
# invoked after a push 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 target 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. Source will
1000
# be the local low-latency branch.
1001
self['post_push'] = []
1002
# invoked after a pull operation completes.
1003
# the api signature is
1005
# containing the members
1006
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1007
# where local is the local branch or None, master is the target
1008
# master branch, and the rest should be self explanatory. The source
1009
# is read locked and the target branches write locked. The local
1010
# branch is the low-latency branch.
1011
self['post_pull'] = []
1012
# invoked before a commit operation takes place.
1013
# the api signature is
1014
# (local, master, old_revno, old_revid, future_revno, future_revid,
1015
# tree_delta, future_tree).
1016
# old_revid is NULL_REVISION for the first commit to a branch
1017
# tree_delta is a TreeDelta object describing changes from the basis
1018
# revision, hooks MUST NOT modify this delta
1019
# future_tree is an in-memory tree obtained from
1020
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1021
self['pre_commit'] = []
1022
# invoked after a commit operation completes.
1023
# the api signature is
1024
# (local, master, old_revno, old_revid, new_revno, new_revid)
1025
# old_revid is NULL_REVISION for the first commit to a branch.
1026
self['post_commit'] = []
1027
# invoked after a uncommit operation completes.
1028
# the api signature is
1029
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1030
# local is the local branch or None, master is the target branch,
1031
# and an empty branch recieves new_revno of 0, new_revid of None.
1032
self['post_uncommit'] = []
1034
# Invoked after the tip of a branch changes.
1035
# the api signature is
1036
# (params) where params is a ChangeBranchTipParams with the members
1037
# (branch, old_revno, new_revno, old_revid, new_revid)
1038
self['post_change_branch_tip'] = []
1041
# install the default hooks into the Branch class.
1042
Branch.hooks = BranchHooks()
1045
class ChangeBranchTipParams(object):
1046
"""Object holding parameters passed to *_change_branch_tip hooks.
1048
There are 5 fields that hooks may wish to access:
1050
:ivar branch: the branch being changed
1051
:ivar old_revno: revision number before the change
1052
:ivar new_revno: revision number after the change
1053
:ivar old_revid: revision id before the change
1054
:ivar new_revid: revision id after the change
1056
The revid fields are strings. The revno fields are integers.
1059
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1060
"""Create a group of ChangeBranchTip parameters.
1062
:param branch: The branch being changed.
1063
:param old_revno: Revision number before the change.
1064
:param new_revno: Revision number after the change.
1065
:param old_revid: Tip revision id before the change.
1066
:param new_revid: Tip revision id after the change.
1068
self.branch = branch
1069
self.old_revno = old_revno
1070
self.new_revno = new_revno
1071
self.old_revid = old_revid
1072
self.new_revid = new_revid
1075
class BzrBranchFormat4(BranchFormat):
1076
"""Bzr branch format 4.
1079
- a revision-history file.
1080
- a branch-lock lock file [ to be shared with the bzrdir ]
1083
def get_format_description(self):
1084
"""See BranchFormat.get_format_description()."""
1085
return "Branch format 4"
1087
def initialize(self, a_bzrdir):
1088
"""Create a branch of this format in a_bzrdir."""
1089
utf8_files = [('revision-history', ''),
1090
('branch-name', ''),
1092
return self._initialize_helper(a_bzrdir, utf8_files,
1093
lock_type='branch4', set_format=False)
1096
super(BzrBranchFormat4, self).__init__()
1097
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1099
def open(self, a_bzrdir, _found=False):
1100
"""Return the branch object for a_bzrdir
1102
_found is a private parameter, do not use it. It is used to indicate
1103
if format probing has already be done.
1106
# we are being called directly and must probe.
1107
raise NotImplementedError
1108
return BzrBranch(_format=self,
1109
_control_files=a_bzrdir._control_files,
1111
_repository=a_bzrdir.open_repository())
1114
return "Bazaar-NG branch format 4"
1117
class BzrBranchFormat5(BranchFormat):
1118
"""Bzr branch format 5.
1121
- a revision-history file.
1123
- a lock dir guarding the branch itself
1124
- all of this stored in a branch/ subdirectory
1125
- works with shared repositories.
1127
This format is new in bzr 0.8.
1130
def get_format_string(self):
1131
"""See BranchFormat.get_format_string()."""
1132
return "Bazaar-NG branch format 5\n"
1134
def get_format_description(self):
1135
"""See BranchFormat.get_format_description()."""
1136
return "Branch format 5"
1138
def initialize(self, a_bzrdir):
1139
"""Create a branch of this format in a_bzrdir."""
1140
utf8_files = [('revision-history', ''),
1141
('branch-name', ''),
1143
return self._initialize_helper(a_bzrdir, utf8_files)
1146
super(BzrBranchFormat5, self).__init__()
1147
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1149
def open(self, a_bzrdir, _found=False):
1150
"""Return the branch object for a_bzrdir
1152
_found is a private parameter, do not use it. It is used to indicate
1153
if format probing has already be done.
1156
format = BranchFormat.find_format(a_bzrdir)
1157
assert format.__class__ == self.__class__
1159
transport = a_bzrdir.get_branch_transport(None)
1160
control_files = lockable_files.LockableFiles(transport, 'lock',
1162
return BzrBranch5(_format=self,
1163
_control_files=control_files,
1165
_repository=a_bzrdir.find_repository())
1166
except errors.NoSuchFile:
1167
raise errors.NotBranchError(path=transport.base)
1170
class BzrBranchFormat6(BzrBranchFormat5):
1171
"""Branch format with last-revision and tags.
1173
Unlike previous formats, this has no explicit revision history. Instead,
1174
this just stores the last-revision, and the left-hand history leading
1175
up to there is the history.
1177
This format was introduced in bzr 0.15
1178
and became the default in 0.91.
1181
def get_format_string(self):
1182
"""See BranchFormat.get_format_string()."""
1183
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1185
def get_format_description(self):
1186
"""See BranchFormat.get_format_description()."""
1187
return "Branch format 6"
1189
def initialize(self, a_bzrdir):
1190
"""Create a branch of this format in a_bzrdir."""
1191
utf8_files = [('last-revision', '0 null:\n'),
1192
('branch.conf', ''),
1195
return self._initialize_helper(a_bzrdir, utf8_files)
1197
def open(self, a_bzrdir, _found=False):
1198
"""Return the branch object for a_bzrdir
1200
_found is a private parameter, do not use it. It is used to indicate
1201
if format probing has already be done.
1204
format = BranchFormat.find_format(a_bzrdir)
1205
assert format.__class__ == self.__class__
1206
transport = a_bzrdir.get_branch_transport(None)
1207
control_files = lockable_files.LockableFiles(transport, 'lock',
1209
return BzrBranch6(_format=self,
1210
_control_files=control_files,
1212
_repository=a_bzrdir.find_repository())
1214
def supports_tags(self):
1218
class BranchReferenceFormat(BranchFormat):
1219
"""Bzr branch reference format.
1221
Branch references are used in implementing checkouts, they
1222
act as an alias to the real branch which is at some other url.
1229
def get_format_string(self):
1230
"""See BranchFormat.get_format_string()."""
1231
return "Bazaar-NG Branch Reference Format 1\n"
1233
def get_format_description(self):
1234
"""See BranchFormat.get_format_description()."""
1235
return "Checkout reference format 1"
1237
def get_reference(self, a_bzrdir):
1238
"""See BranchFormat.get_reference()."""
1239
transport = a_bzrdir.get_branch_transport(None)
1240
return transport.get('location').read()
1242
def set_reference(self, a_bzrdir, to_branch):
1243
"""See BranchFormat.set_reference()."""
1244
transport = a_bzrdir.get_branch_transport(None)
1245
location = transport.put_bytes('location', to_branch.base)
1247
def initialize(self, a_bzrdir, target_branch=None):
1248
"""Create a branch of this format in a_bzrdir."""
1249
if target_branch is None:
1250
# this format does not implement branch itself, thus the implicit
1251
# creation contract must see it as uninitializable
1252
raise errors.UninitializableFormat(self)
1253
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1254
branch_transport = a_bzrdir.get_branch_transport(self)
1255
branch_transport.put_bytes('location',
1256
target_branch.bzrdir.root_transport.base)
1257
branch_transport.put_bytes('format', self.get_format_string())
1259
a_bzrdir, _found=True,
1260
possible_transports=[target_branch.bzrdir.root_transport])
1263
super(BranchReferenceFormat, self).__init__()
1264
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1266
def _make_reference_clone_function(format, a_branch):
1267
"""Create a clone() routine for a branch dynamically."""
1268
def clone(to_bzrdir, revision_id=None):
1269
"""See Branch.clone()."""
1270
return format.initialize(to_bzrdir, a_branch)
1271
# cannot obey revision_id limits when cloning a reference ...
1272
# FIXME RBC 20060210 either nuke revision_id for clone, or
1273
# emit some sort of warning/error to the caller ?!
1276
def open(self, a_bzrdir, _found=False, location=None,
1277
possible_transports=None):
1278
"""Return the branch that the branch reference in a_bzrdir points at.
1280
_found is a private parameter, do not use it. It is used to indicate
1281
if format probing has already be done.
1284
format = BranchFormat.find_format(a_bzrdir)
1285
assert format.__class__ == self.__class__
1286
if location is None:
1287
location = self.get_reference(a_bzrdir)
1288
real_bzrdir = bzrdir.BzrDir.open(
1289
location, possible_transports=possible_transports)
1290
result = real_bzrdir.open_branch()
1291
# this changes the behaviour of result.clone to create a new reference
1292
# rather than a copy of the content of the branch.
1293
# I did not use a proxy object because that needs much more extensive
1294
# testing, and we are only changing one behaviour at the moment.
1295
# If we decide to alter more behaviours - i.e. the implicit nickname
1296
# then this should be refactored to introduce a tested proxy branch
1297
# and a subclass of that for use in overriding clone() and ....
1299
result.clone = self._make_reference_clone_function(result)
1303
# formats which have no format string are not discoverable
1304
# and not independently creatable, so are not registered.
1305
__format5 = BzrBranchFormat5()
1306
__format6 = BzrBranchFormat6()
1307
BranchFormat.register_format(__format5)
1308
BranchFormat.register_format(BranchReferenceFormat())
1309
BranchFormat.register_format(__format6)
1310
BranchFormat.set_default_format(__format6)
1311
_legacy_formats = [BzrBranchFormat4(),
1314
class BzrBranch(Branch):
1315
"""A branch stored in the actual filesystem.
1317
Note that it's "local" in the context of the filesystem; it doesn't
1318
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1319
it's writable, and can be accessed via the normal filesystem API.
1322
def __init__(self, _format=None,
1323
_control_files=None, a_bzrdir=None, _repository=None):
1324
"""Create new branch object at a particular location."""
1325
Branch.__init__(self)
1326
if a_bzrdir is None:
1327
raise ValueError('a_bzrdir must be supplied')
1329
self.bzrdir = a_bzrdir
1330
# self._transport used to point to the directory containing the
1331
# control directory, but was not used - now it's just the transport
1332
# for the branch control files. mbp 20070212
1333
self._base = self.bzrdir.transport.clone('..').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
def abspath(self, name):
1353
"""See Branch.abspath."""
1354
return self.control_files._transport.abspath(name)
1356
def is_locked(self):
1357
return self.control_files.is_locked()
1359
def lock_write(self, token=None):
1360
repo_token = self.repository.lock_write()
1362
token = self.control_files.lock_write(token=token)
1364
self.repository.unlock()
1368
def lock_read(self):
1369
self.repository.lock_read()
1371
self.control_files.lock_read()
1373
self.repository.unlock()
1377
# TODO: test for failed two phase locks. This is known broken.
1379
self.control_files.unlock()
1381
self.repository.unlock()
1382
if not self.control_files.is_locked():
1383
# we just released the lock
1384
self._clear_cached_state()
1386
def peek_lock_mode(self):
1387
if self.control_files._lock_count == 0:
1390
return self.control_files._lock_mode
1392
def get_physical_lock_status(self):
1393
return self.control_files.get_physical_lock_status()
1396
def print_file(self, file, revision_id):
1397
"""See Branch.print_file."""
1398
return self.repository.print_file(file, revision_id)
1400
def _write_revision_history(self, history):
1401
"""Factored out of set_revision_history.
1403
This performs the actual writing to disk.
1404
It is intended to be called by BzrBranch5.set_revision_history."""
1405
self.control_files.put_bytes(
1406
'revision-history', '\n'.join(history))
1409
def set_revision_history(self, rev_history):
1410
"""See Branch.set_revision_history."""
1411
if 'evil' in debug.debug_flags:
1412
mutter_callsite(3, "set_revision_history scales with history.")
1413
self._write_revision_history(rev_history)
1414
self._clear_cached_state()
1415
self._cache_revision_history(rev_history)
1416
for hook in Branch.hooks['set_rh']:
1417
hook(self, rev_history)
1419
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1420
"""Run the post_change_branch_tip hooks."""
1421
hooks = Branch.hooks['post_change_branch_tip']
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'))
1424
new_revno, new_revid = self.last_revision_info()
1425
params = ChangeBranchTipParams(
1426
self, old_revno, new_revno, old_revid, new_revid)
1431
def set_last_revision_info(self, revno, revision_id):
1432
"""Set the last revision of this branch.
1434
The caller is responsible for checking that the revno is correct
1435
for this revision id.
1437
It may be possible to set the branch last revision to an id not
1438
present in the repository. However, branches can also be
1439
configured to check constraints on history, in which case this may not
1442
revision_id = _mod_revision.ensure_null(revision_id)
1443
old_revno, old_revid = self.last_revision_info()
1444
history = self._lefthand_history(revision_id)
1445
assert len(history) == revno, '%d != %d' % (len(history), revno)
1446
self.set_revision_history(history)
1447
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1449
def _gen_revision_history(self):
1450
history = self.control_files.get('revision-history').read().split('\n')
1451
if history[-1:] == ['']:
1452
# There shouldn't be a trailing newline, but just in case.
1456
def _lefthand_history(self, revision_id, last_rev=None,
1458
if 'evil' in debug.debug_flags:
1459
mutter_callsite(4, "_lefthand_history scales with history.")
1460
# stop_revision must be a descendant of last_revision
1461
graph = self.repository.get_graph()
1462
if last_rev is not None:
1463
if not graph.is_ancestor(last_rev, revision_id):
1464
# our previous tip is not merged into stop_revision
1465
raise errors.DivergedBranches(self, other_branch)
1466
# make a new revision history from the graph
1467
parents_map = graph.get_parent_map([revision_id])
1468
if revision_id not in parents_map:
1469
raise errors.NoSuchRevision(self, revision_id)
1470
current_rev_id = revision_id
1472
# Do not include ghosts or graph origin in revision_history
1473
while (current_rev_id in parents_map and
1474
len(parents_map[current_rev_id]) > 0):
1475
new_history.append(current_rev_id)
1476
current_rev_id = parents_map[current_rev_id][0]
1477
parents_map = graph.get_parent_map([current_rev_id])
1478
new_history.reverse()
1482
def generate_revision_history(self, revision_id, last_rev=None,
1484
"""Create a new revision history that will finish with revision_id.
1486
:param revision_id: the new tip to use.
1487
:param last_rev: The previous last_revision. If not None, then this
1488
must be a ancestory of revision_id, or DivergedBranches is raised.
1489
:param other_branch: The other branch that DivergedBranches should
1490
raise with respect to.
1492
self.set_revision_history(self._lefthand_history(revision_id,
1493
last_rev, other_branch))
1496
def update_revisions(self, other, stop_revision=None, overwrite=False):
1497
"""See Branch.update_revisions."""
1500
other_last_revno, other_last_revision = other.last_revision_info()
1501
if stop_revision is None:
1502
stop_revision = other_last_revision
1503
if _mod_revision.is_null(stop_revision):
1504
# if there are no commits, we're done.
1506
# whats the current last revision, before we fetch [and change it
1508
last_rev = _mod_revision.ensure_null(self.last_revision())
1509
# we fetch here so that we don't process data twice in the common
1510
# case of having something to pull, and so that the check for
1511
# already merged can operate on the just fetched graph, which will
1512
# be cached in memory.
1513
self.fetch(other, stop_revision)
1514
# Check to see if one is an ancestor of the other
1516
heads = self.repository.get_graph().heads([stop_revision,
1518
if heads == set([last_rev]):
1519
# The current revision is a decendent of the target,
1522
elif heads == set([stop_revision, last_rev]):
1523
# These branches have diverged
1524
raise errors.DivergedBranches(self, other)
1525
assert heads == set([stop_revision])
1526
if other_last_revision == stop_revision:
1527
self.set_last_revision_info(other_last_revno,
1528
other_last_revision)
1530
# TODO: jam 2007-11-29 Is there a way to determine the
1531
# revno without searching all of history??
1533
self.generate_revision_history(stop_revision)
1535
self.generate_revision_history(stop_revision,
1536
last_rev=last_rev, other_branch=other)
1540
def basis_tree(self):
1541
"""See Branch.basis_tree."""
1542
return self.repository.revision_tree(self.last_revision())
1545
def pull(self, source, overwrite=False, stop_revision=None,
1546
_hook_master=None, run_hooks=True, possible_transports=None):
1549
:param _hook_master: Private parameter - set the branch to
1550
be supplied as the master to push hooks.
1551
:param run_hooks: Private parameter - if false, this branch
1552
is being called because it's the master of the primary branch,
1553
so it should not run its hooks.
1555
result = PullResult()
1556
result.source_branch = source
1557
result.target_branch = self
1560
result.old_revno, result.old_revid = self.last_revision_info()
1561
self.update_revisions(source, stop_revision, overwrite=overwrite)
1562
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1563
result.new_revno, result.new_revid = self.last_revision_info()
1565
result.master_branch = _hook_master
1566
result.local_branch = self
1568
result.master_branch = self
1569
result.local_branch = None
1571
for hook in Branch.hooks['post_pull']:
1577
def _get_parent_location(self):
1578
_locs = ['parent', 'pull', 'x-pull']
1581
return self.control_files.get(l).read().strip('\n')
1582
except errors.NoSuchFile:
1587
def push(self, target, overwrite=False, stop_revision=None,
1588
_override_hook_source_branch=None):
1591
This is the basic concrete implementation of push()
1593
:param _override_hook_source_branch: If specified, run
1594
the hooks passing this Branch as the source, rather than self.
1595
This is for use of RemoteBranch, where push is delegated to the
1596
underlying vfs-based Branch.
1598
# TODO: Public option to disable running hooks - should be trivial but
1602
result = self._push_with_bound_branches(target, overwrite,
1604
_override_hook_source_branch=_override_hook_source_branch)
1609
def _push_with_bound_branches(self, target, overwrite,
1611
_override_hook_source_branch=None):
1612
"""Push from self into target, and into target's master if any.
1614
This is on the base BzrBranch class even though it doesn't support
1615
bound branches because the *target* might be bound.
1618
if _override_hook_source_branch:
1619
result.source_branch = _override_hook_source_branch
1620
for hook in Branch.hooks['post_push']:
1623
bound_location = target.get_bound_location()
1624
if bound_location and target.base != bound_location:
1625
# there is a master branch.
1627
# XXX: Why the second check? Is it even supported for a branch to
1628
# be bound to itself? -- mbp 20070507
1629
master_branch = target.get_master_branch()
1630
master_branch.lock_write()
1632
# push into the master from this branch.
1633
self._basic_push(master_branch, overwrite, stop_revision)
1634
# and push into the target branch from this. Note that we push from
1635
# this branch again, because its considered the highest bandwidth
1637
result = self._basic_push(target, overwrite, stop_revision)
1638
result.master_branch = master_branch
1639
result.local_branch = target
1268
class ScratchBranch(Branch):
1269
"""Special test class: a branch that cleans up after itself.
1271
>>> b = ScratchBranch()
1643
master_branch.unlock()
1646
result = self._basic_push(target, overwrite, stop_revision)
1647
# TODO: Why set master_branch and local_branch if there's no
1648
# binding? Maybe cleaner to just leave them unset? -- mbp
1650
result.master_branch = target
1651
result.local_branch = None
1655
def _basic_push(self, target, overwrite, stop_revision):
1656
"""Basic implementation of push without bound branches or hooks.
1658
Must be called with self read locked and target write locked.
1660
result = PushResult()
1661
result.source_branch = self
1662
result.target_branch = target
1663
result.old_revno, result.old_revid = target.last_revision_info()
1665
target.update_revisions(self, stop_revision)
1666
except errors.DivergedBranches:
1670
target.set_revision_history(self.revision_history())
1671
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1672
result.new_revno, result.new_revid = target.last_revision_info()
1675
def get_parent(self):
1676
"""See Branch.get_parent."""
1678
assert self.base[-1] == '/'
1679
parent = self._get_parent_location()
1682
# This is an old-format absolute path to a local branch
1683
# turn it into a url
1684
if parent.startswith('/'):
1685
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1687
return urlutils.join(self.base[:-1], parent)
1688
except errors.InvalidURLJoin, e:
1689
raise errors.InaccessibleParent(parent, self.base)
1691
def set_push_location(self, location):
1692
"""See Branch.set_push_location."""
1693
self.get_config().set_user_option(
1694
'push_location', location,
1695
store=_mod_config.STORE_LOCATION_NORECURSE)
1698
def set_parent(self, url):
1699
"""See Branch.set_parent."""
1700
# TODO: Maybe delete old location files?
1701
# URLs should never be unicode, even on the local fs,
1702
# FIXUP this and get_parent in a future branch format bump:
1703
# read and rewrite the file, and have the new format code read
1704
# using .get not .get_utf8. RBC 20060125
1706
if isinstance(url, unicode):
1708
url = url.encode('ascii')
1709
except UnicodeEncodeError:
1710
raise errors.InvalidURL(url,
1711
"Urls must be 7-bit ascii, "
1712
"use bzrlib.urlutils.escape")
1713
url = urlutils.relative_url(self.base, url)
1714
self._set_parent_location(url)
1716
def _set_parent_location(self, url):
1718
self.control_files._transport.delete('parent')
1720
assert isinstance(url, str)
1721
self.control_files.put_bytes('parent', url + '\n')
1724
class BzrBranch5(BzrBranch):
1725
"""A format 5 branch. This supports new features over plain branches.
1727
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:
1735
super(BzrBranch5, self).__init__(_format=_format,
1736
_control_files=_control_files,
1738
_repository=_repository)
1741
def pull(self, source, overwrite=False, stop_revision=None,
1742
run_hooks=True, possible_transports=None):
1743
"""Pull from source into self, updating my master if any.
1745
:param run_hooks: Private parameter - if false, this branch
1746
is being called because it's the master of the primary branch,
1747
so it should not run its hooks.
1749
bound_location = self.get_bound_location()
1750
master_branch = None
1751
if bound_location and source.base != bound_location:
1752
# not pulling from master, so we need to update master.
1753
master_branch = self.get_master_branch(possible_transports)
1754
master_branch.lock_write()
1757
# pull from source into master.
1758
master_branch.pull(source, overwrite, stop_revision,
1760
return super(BzrBranch5, self).pull(source, overwrite,
1761
stop_revision, _hook_master=master_branch,
1762
run_hooks=run_hooks)
1765
master_branch.unlock()
1767
def get_bound_location(self):
1769
return self.control_files.get_utf8('bound').read()[:-1]
1770
except errors.NoSuchFile:
1774
def get_master_branch(self, possible_transports=None):
1775
"""Return the branch we are bound to.
1777
:return: Either a Branch, or None
1779
This could memoise the branch, but if thats done
1780
it must be revalidated on each new lock.
1781
So for now we just don't memoise it.
1782
# RBC 20060304 review this decision.
1784
bound_loc = self.get_bound_location()
1788
return Branch.open(bound_loc,
1789
possible_transports=possible_transports)
1790
except (errors.NotBranchError, errors.ConnectionError), e:
1791
raise errors.BoundBranchConnectionFailure(
1795
def set_bound_location(self, location):
1796
"""Set the target where this branch is bound to.
1798
:param location: URL to the target branch
1801
self.control_files.put_utf8('bound', location+'\n')
1804
self.control_files._transport.delete('bound')
1805
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')
1810
def bind(self, other):
1811
"""Bind this branch to the branch other.
1813
This does not push or pull data between the branches, though it does
1814
check for divergence to raise an error when the branches are not
1815
either the same, or one a prefix of the other. That behaviour may not
1816
be useful, so that check may be removed in future.
1818
:param other: The branch to bind to
1821
# TODO: jam 20051230 Consider checking if the target is bound
1822
# It is debatable whether you should be able to bind to
1823
# a branch which is itself bound.
1824
# Committing is obviously forbidden,
1825
# but binding itself may not be.
1826
# Since we *have* to check at commit time, we don't
1827
# *need* to check here
1829
# we want to raise diverged if:
1830
# last_rev is not in the other_last_rev history, AND
1831
# other_last_rev is not in our history, and do it without pulling
1833
self.set_bound_location(other.base)
1837
"""If bound, unbind"""
1838
return self.set_bound_location(None)
1841
def update(self, possible_transports=None):
1842
"""Synchronise this branch with the master branch if any.
1844
:return: None or the last_revision that was pivoted out during the
1847
master = self.get_master_branch(possible_transports)
1848
if master is not None:
1849
old_tip = _mod_revision.ensure_null(self.last_revision())
1850
self.pull(master, overwrite=True)
1851
if self.repository.get_graph().is_ancestor(old_tip,
1852
_mod_revision.ensure_null(self.last_revision())):
1858
class BzrBranch6(BzrBranch5):
1860
def __init__(self, *args, **kwargs):
1861
super(BzrBranch6, self).__init__(*args, **kwargs)
1862
self._last_revision_info_cache = None
1863
self._partial_revision_history_cache = []
1865
def _clear_cached_state(self):
1866
super(BzrBranch6, self)._clear_cached_state()
1867
self._last_revision_info_cache = None
1868
self._partial_revision_history_cache = []
1871
def last_revision_info(self):
1872
"""Return information about the last revision.
1874
:return: A tuple (revno, revision_id).
1876
if self._last_revision_info_cache is None:
1877
self._last_revision_info_cache = self._last_revision_info()
1878
return self._last_revision_info_cache
1880
def _last_revision_info(self):
1881
revision_string = self.control_files.get('last-revision').read()
1882
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1883
revision_id = cache_utf8.get_cached_utf8(revision_id)
1885
return revno, revision_id
1887
def _write_last_revision_info(self, revno, revision_id):
1888
"""Simply write out the revision id, with no checks.
1890
Use set_last_revision_info to perform this safely.
1892
Does not update the revision_history cache.
1893
Intended to be called by set_last_revision_info and
1894
_write_revision_history.
1896
assert revision_id is not None, "Use NULL_REVISION, not None"
1897
out_string = '%d %s\n' % (revno, revision_id)
1898
self.control_files.put_bytes('last-revision', out_string)
1901
def set_last_revision_info(self, revno, revision_id):
1902
revision_id = _mod_revision.ensure_null(revision_id)
1903
old_revno, old_revid = self.last_revision_info()
1904
if self._get_append_revisions_only():
1905
self._check_history_violation(revision_id)
1906
self._write_last_revision_info(revno, revision_id)
1907
self._clear_cached_state()
1908
self._last_revision_info_cache = revno, revision_id
1909
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1911
def _check_history_violation(self, revision_id):
1912
last_revision = _mod_revision.ensure_null(self.last_revision())
1913
if _mod_revision.is_null(last_revision):
1915
if last_revision not in self._lefthand_history(revision_id):
1916
raise errors.AppendRevisionsOnlyViolation(self.base)
1918
def _gen_revision_history(self):
1919
"""Generate the revision history from last revision
1921
self._extend_partial_history()
1922
return list(reversed(self._partial_revision_history_cache))
1924
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1925
"""Extend the partial history to include a given index
1927
If a stop_index is supplied, stop when that index has been reached.
1928
If a stop_revision is supplied, stop when that revision is
1929
encountered. Otherwise, stop when the beginning of history is
1932
:param stop_index: The index which should be present. When it is
1933
present, history extension will stop.
1934
:param revision_id: The revision id which should be present. When
1935
it is encountered, history extension will stop.
1937
repo = self.repository
1938
if len(self._partial_revision_history_cache) == 0:
1939
iterator = repo.iter_reverse_revision_history(self.last_revision())
1941
start_revision = self._partial_revision_history_cache[-1]
1942
iterator = repo.iter_reverse_revision_history(start_revision)
1943
#skip the last revision in the list
1944
next_revision = iterator.next()
1945
assert next_revision == start_revision
1946
for revision_id in iterator:
1947
self._partial_revision_history_cache.append(revision_id)
1948
if (stop_index is not None and
1949
len(self._partial_revision_history_cache) > stop_index):
1951
if revision_id == stop_revision:
1954
def _write_revision_history(self, history):
1955
"""Factored out of set_revision_history.
1957
This performs the actual writing to disk, with format-specific checks.
1958
It is intended to be called by BzrBranch5.set_revision_history.
1960
if len(history) == 0:
1961
last_revision = 'null:'
1963
if history != self._lefthand_history(history[-1]):
1964
raise errors.NotLefthandHistory(history)
1965
last_revision = history[-1]
1966
if self._get_append_revisions_only():
1967
self._check_history_violation(last_revision)
1968
self._write_last_revision_info(len(history), last_revision)
1971
def _set_parent_location(self, url):
1972
"""Set the parent branch"""
1973
self._set_config_location('parent_location', url, make_relative=True)
1976
def _get_parent_location(self):
1977
"""Set the parent branch"""
1978
return self._get_config_location('parent_location')
1980
def set_push_location(self, location):
1981
"""See Branch.set_push_location."""
1982
self._set_config_location('push_location', location)
1984
def set_bound_location(self, location):
1985
"""See Branch.set_push_location."""
1987
config = self.get_config()
1988
if location is None:
1989
if config.get_user_option('bound') != 'True':
1992
config.set_user_option('bound', 'False', warn_masked=True)
1995
self._set_config_location('bound_location', location,
1997
config.set_user_option('bound', 'True', warn_masked=True)
2000
def _get_bound_location(self, bound):
2001
"""Return the bound location in the config file.
2003
Return None if the bound parameter does not match"""
2004
config = self.get_config()
2005
config_bound = (config.get_user_option('bound') == 'True')
2006
if config_bound != bound:
2008
return self._get_config_location('bound_location', config=config)
2010
def get_bound_location(self):
2011
"""See Branch.set_push_location."""
2012
return self._get_bound_location(True)
2014
def get_old_bound_location(self):
2015
"""See Branch.get_old_bound_location"""
2016
return self._get_bound_location(False)
2018
def set_append_revisions_only(self, enabled):
2023
self.get_config().set_user_option('append_revisions_only', value,
2026
def _get_append_revisions_only(self):
2027
value = self.get_config().get_user_option('append_revisions_only')
2028
return value == 'True'
2030
def _synchronize_history(self, destination, revision_id):
2031
"""Synchronize last revision and revision history between branches.
2033
This version is most efficient when the destination is also a
2034
BzrBranch6, but works for BzrBranch5, as long as the destination's
2035
repository contains all the lefthand ancestors of the intended
2036
last_revision. If not, set_last_revision_info will fail.
2038
:param destination: The branch to copy the history into
2039
:param revision_id: The revision-id to truncate history at. May
2040
be None to copy complete history.
2042
source_revno, source_revision_id = self.last_revision_info()
2043
if revision_id is None:
2044
revno, revision_id = source_revno, source_revision_id
2045
elif source_revision_id == revision_id:
2046
# we know the revno without needing to walk all of history
2047
revno = source_revno
2049
# To figure out the revno for a random revision, we need to build
2050
# the revision history, and count its length.
2051
# We don't care about the order, just how long it is.
2052
# Alternatively, we could start at the current location, and count
2053
# backwards. But there is no guarantee that we will find it since
2054
# it may be a merged revision.
2055
revno = len(list(self.repository.iter_reverse_revision_history(
2057
destination.set_last_revision_info(revno, revision_id)
2059
def _make_tags(self):
2060
return BasicTags(self)
2063
def generate_revision_history(self, revision_id, last_rev=None,
2065
"""See BzrBranch5.generate_revision_history"""
2066
history = self._lefthand_history(revision_id, last_rev, other_branch)
2067
revno = len(history)
2068
self.set_last_revision_info(revno, revision_id)
2071
def get_rev_id(self, revno, history=None):
2072
"""Find the revision id of the specified revno."""
2074
return _mod_revision.NULL_REVISION
2076
last_revno, last_revision_id = self.last_revision_info()
2077
if revno <= 0 or revno > last_revno:
2078
raise errors.NoSuchRevision(self, revno)
2080
if history is not None:
2081
assert len(history) == last_revno, 'revno/history mismatch'
2082
return history[revno - 1]
2084
index = last_revno - revno
2085
if len(self._partial_revision_history_cache) <= index:
2086
self._extend_partial_history(stop_index=index)
2087
if len(self._partial_revision_history_cache) > index:
2088
return self._partial_revision_history_cache[index]
2090
raise errors.NoSuchRevision(self, revno)
2093
def revision_id_to_revno(self, revision_id):
2094
"""Given a revision id, return its revno"""
2095
if _mod_revision.is_null(revision_id):
2098
index = self._partial_revision_history_cache.index(revision_id)
2100
self._extend_partial_history(stop_revision=revision_id)
2101
index = len(self._partial_revision_history_cache) - 1
2102
if self._partial_revision_history_cache[index] != revision_id:
2103
raise errors.NoSuchRevision(self, revision_id)
2104
return self.revno() - index
2107
######################################################################
2108
# results of operations
2111
class _Result(object):
2113
def _show_tag_conficts(self, to_file):
2114
if not getattr(self, 'tag_conflicts', None):
2116
to_file.write('Conflicting tags:\n')
2117
for name, value1, value2 in self.tag_conflicts:
2118
to_file.write(' %s\n' % (name, ))
2121
class PullResult(_Result):
2122
"""Result of a Branch.pull operation.
2124
:ivar old_revno: Revision number before pull.
2125
:ivar new_revno: Revision number after pull.
2126
:ivar old_revid: Tip revision id before pull.
2127
:ivar new_revid: Tip revision id after pull.
2128
:ivar source_branch: Source (local) branch object.
2129
:ivar master_branch: Master branch of the target, or None.
2130
:ivar target_branch: Target/destination branch object.
2134
# DEPRECATED: pull used to return the change in revno
2135
return self.new_revno - self.old_revno
2137
def report(self, to_file):
2139
if self.old_revid == self.new_revid:
2140
to_file.write('No revisions to pull.\n')
2142
to_file.write('Now on revision %d.\n' % self.new_revno)
2143
self._show_tag_conficts(to_file)
2146
class PushResult(_Result):
2147
"""Result of a Branch.push operation.
2149
:ivar old_revno: Revision number before push.
2150
:ivar new_revno: Revision number after push.
2151
:ivar old_revid: Tip revision id before push.
2152
:ivar new_revid: Tip revision id after push.
2153
:ivar source_branch: Source branch object.
2154
:ivar master_branch: Master branch of the target, or None.
2155
:ivar target_branch: Target/destination branch object.
2159
# DEPRECATED: push used to return the change in revno
2160
return self.new_revno - self.old_revno
2162
def report(self, to_file):
2163
"""Write a human-readable description of the result."""
2164
if self.old_revid == self.new_revid:
2165
to_file.write('No new revisions to push.\n')
2167
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2168
self._show_tag_conficts(to_file)
2171
class BranchCheckResult(object):
2172
"""Results of checking branch consistency.
2177
def __init__(self, branch):
2178
self.branch = branch
2180
def report_results(self, verbose):
2181
"""Report the check results via trace.note.
2183
:param verbose: Requests more detailed display of what was checked,
2186
note('checked branch %s format %s',
2188
self.branch._format)
2191
class Converter5to6(object):
2192
"""Perform an in-place upgrade of format 5 to format 6"""
2194
def convert(self, branch):
2195
# Data for 5 and 6 can peacefully coexist.
2196
format = BzrBranchFormat6()
2197
new_branch = format.open(branch.bzrdir, _found=True)
2199
# Copy source data into target
2200
new_branch._write_last_revision_info(*branch.last_revision_info())
2201
new_branch.set_parent(branch.get_parent())
2202
new_branch.set_bound_location(branch.get_bound_location())
2203
new_branch.set_push_location(branch.get_push_location())
2205
# New branch has no tags by default
2206
new_branch.tags._set_tag_dict({})
2208
# Copying done; now update target format
2209
new_branch.control_files.put_utf8('format',
2210
format.get_format_string())
2212
# Clean up old files
2213
new_branch.control_files._transport.delete('revision-history')
2215
branch.set_parent(None)
2216
except errors.NoSuchFile:
2218
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
