247
176
message_callback=None,
250
possible_master_transports=None,
252
178
"""Commit working copy as a new revision.
254
:param message: the commit message (it or message_callback is required)
255
:param message_callback: A callback: message =
256
message_callback(cmt_obj)
258
:param timestamp: if not None, seconds-since-epoch for a
259
postdated/predated commit.
261
:param specific_files: If not None, commit only those files. An empty
262
list means 'commit no files'.
264
:param rev_id: If set, use this as the new revision id.
180
branch -- the deprecated branch to commit to. New callers should pass in
183
message -- the commit message (it or message_callback is required)
185
timestamp -- if not None, seconds-since-epoch for a
186
postdated/predated commit.
188
specific_files -- If true, commit only those files.
190
rev_id -- If set, use this as the new revision id.
265
191
Useful for test or import commands that need to tightly
266
192
control what revisions are assigned. If you duplicate
267
193
a revision id that exists elsewhere it is your own fault.
268
194
If null (default), a time/random revision id is generated.
270
:param allow_pointless: If true (default), commit even if nothing
196
allow_pointless -- If true (default), commit even if nothing
271
197
has changed and no merges are recorded.
273
:param strict: If true, don't allow a commit if the working tree
199
strict -- If true, don't allow a commit if the working tree
274
200
contains unknown files.
276
:param revprops: Properties for new revision
202
revprops -- Properties for new revision
277
203
:param local: Perform a local only commit.
278
:param reporter: the reporter to use or None for the default
279
:param verbose: if True and the reporter is not None, report everything
280
204
:param recursive: If set to 'down', commit in any subtrees that have
281
205
pending changes of any sort during this commit.
282
:param exclude: None or a list of relative paths to exclude from the
283
commit. Pending changes to excluded files will be ignored by the
285
:param lossy: When committing to a foreign VCS, ignore any
286
data that can not be natively represented.
288
with ExitStack() as stack:
289
self.revprops = revprops or {}
290
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
291
self.config_stack = config or self.config_stack
292
mutter('preparing to commit')
294
if working_tree is None:
295
raise BzrError("working_tree must be passed into commit().")
297
self.work_tree = working_tree
298
self.branch = self.work_tree.branch
299
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
300
if not self.branch.repository.supports_rich_root():
301
raise errors.RootNotRich()
302
if message_callback is None:
303
if message is not None:
304
if isinstance(message, bytes):
305
message = message.decode(get_user_encoding())
307
def message_callback(x):
310
raise BzrError("The message or message_callback keyword"
311
" parameter is required for commit().")
313
self.bound_branch = None
314
self.any_entries_deleted = False
315
if exclude is not None:
316
self.exclude = sorted(
317
minimum_path_selection(exclude))
321
self.master_branch = None
322
self.recursive = recursive
324
# self.specific_files is None to indicate no filter, or any iterable to
325
# indicate a filter - [] means no files at all, as per iter_changes.
326
if specific_files is not None:
327
self.specific_files = sorted(
328
minimum_path_selection(specific_files))
330
self.specific_files = None
332
self.allow_pointless = allow_pointless
333
self.message_callback = message_callback
334
self.timestamp = timestamp
335
self.timezone = timezone
336
self.committer = committer
338
self.verbose = verbose
340
stack.enter_context(self.work_tree.lock_write())
341
self.parents = self.work_tree.get_parent_ids()
342
self.pb = ui.ui_factory.nested_progress_bar()
343
stack.callback(self.pb.finished)
344
self.basis_revid = self.work_tree.last_revision()
345
self.basis_tree = self.work_tree.basis_tree()
346
stack.enter_context(self.basis_tree.lock_read())
207
mutter('preparing to commit')
209
if deprecated_passed(branch):
210
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
211
"deprecated as of bzr 0.8. Please use working_tree= instead.",
212
DeprecationWarning, stacklevel=2)
214
self.work_tree = self.branch.bzrdir.open_workingtree()
215
elif working_tree is None:
216
raise BzrError("One of branch and working_tree must be passed into commit().")
218
self.work_tree = working_tree
219
self.branch = self.work_tree.branch
220
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
221
if not self.branch.repository.supports_rich_root():
222
raise errors.RootNotRich()
223
if message_callback is None:
224
if message is not None:
225
if isinstance(message, str):
226
message = message.decode(bzrlib.user_encoding)
227
message_callback = lambda x: message
229
raise BzrError("The message or message_callback keyword"
230
" parameter is required for commit().")
232
self.bound_branch = None
234
self.master_branch = None
235
self.master_locked = False
237
self.specific_files = specific_files
238
self.allow_pointless = allow_pointless
239
self.recursive = recursive
240
self.revprops = revprops
241
self.message_callback = message_callback
242
self.timestamp = timestamp
243
self.timezone = timezone
244
self.committer = committer
245
self.specific_files = specific_files
247
self.verbose = verbose
250
if reporter is None and self.reporter is None:
251
self.reporter = NullCommitReporter()
252
elif reporter is not None:
253
self.reporter = reporter
255
self.work_tree.lock_write()
256
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
257
self.basis_tree = self.work_tree.basis_tree()
258
self.basis_tree.lock_read()
347
260
# Cannot commit with conflicts present.
348
if len(self.work_tree.conflicts()) > 0:
261
if len(self.work_tree.conflicts())>0:
349
262
raise ConflictsInTree
351
# Setup the bound branch variables as needed.
352
self._check_bound_branch(stack, possible_master_transports)
353
if self.config_stack is None:
354
self.config_stack = self.work_tree.get_config_stack()
356
# Check that the working tree is up to date
357
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
359
# Complete configuration setup
360
if reporter is not None:
361
self.reporter = reporter
362
elif self.reporter is None:
363
self.reporter = self._select_reporter()
365
# Setup the progress bar. As the number of files that need to be
366
# committed in unknown, progress is reported as stages.
367
# We keep track of entries separately though and include that
368
# information in the progress bar during the relevant stages.
369
self.pb_stage_name = ""
370
self.pb_stage_count = 0
371
self.pb_stage_total = 5
372
if self.bound_branch:
373
# 2 extra stages: "Uploading data to master branch" and "Merging
374
# tags to master branch"
375
self.pb_stage_total += 2
376
self.pb.show_pct = False
377
self.pb.show_spinner = False
378
self.pb.show_eta = False
379
self.pb.show_count = True
380
self.pb.show_bar = True
382
# After a merge, a selected file commit is not supported.
383
# See 'bzr help merge' for an explanation as to why.
384
if len(self.parents) > 1 and self.specific_files is not None:
385
raise CannotCommitSelectedFileMerge(self.specific_files)
386
# Excludes are a form of selected file commit.
387
if len(self.parents) > 1 and self.exclude:
388
raise CannotCommitSelectedFileMerge(self.exclude)
390
# Collect the changes
391
self._set_progress_stage("Collecting changes", counter=True)
393
self.builder = self.branch.get_commit_builder(
394
self.parents, self.config_stack, timestamp, timezone, committer,
395
self.revprops, rev_id, lossy=lossy)
397
if self.builder.updates_branch and self.bound_branch:
399
raise AssertionError(
400
"bound branches not supported for commit builders "
401
"that update the branch")
264
# setup the bound branch variables as needed.
265
self._check_bound_branch()
267
# check for out of date working trees
404
# find the location being committed to
405
if self.bound_branch:
406
master_location = self.master_branch.base
408
master_location = self.branch.base
410
# report the start of the commit
411
self.reporter.started(new_revno, self.rev_id, master_location)
413
self._update_builder_with_changes()
414
self._check_pointless()
416
# TODO: Now the new inventory is known, check for conflicts.
417
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
418
# weave lines, because nothing should be recorded until it is known
419
# that commit will succeed.
420
self._set_progress_stage("Saving data locally")
421
self.builder.finish_inventory()
423
# Prompt the user for a commit message if none provided
424
message = message_callback(self)
425
self.message = message
427
# Add revision data to the local branch
428
self.rev_id = self.builder.commit(self.message)
431
mutter("aborting commit write group because of exception:")
432
trace.log_exception_quietly()
436
self._update_branches(old_revno, old_revid, new_revno)
438
# Make the working tree be up to date with the branch. This
439
# includes automatic changes scheduled to be made to the tree, such
440
# as updating its basis and unversioning paths that were missing.
441
self.work_tree.unversion(self.deleted_paths)
442
self._set_progress_stage("Updating the working tree")
443
self.work_tree.update_basis_by_delta(self.rev_id,
444
self.builder.get_basis_delta())
445
self.reporter.completed(new_revno, self.rev_id)
446
self._process_post_hooks(old_revno, new_revno)
449
def _update_branches(self, old_revno, old_revid, new_revno):
450
"""Update the master and local branch to the new revision.
452
This will try to make sure that the master branch is updated
453
before the local branch.
455
:param old_revno: Revision number of master branch before the
457
:param old_revid: Tip of master branch before the commit
458
:param new_revno: Revision number of the new commit
460
if not self.builder.updates_branch:
461
self._process_pre_hooks(old_revno, new_revno)
463
# Upload revision data to the master.
269
first_tree_parent = self.work_tree.get_parent_ids()[0]
271
# if there are no parents, treat our parent as 'None'
272
# this is so that we still consier the master branch
273
# - in a checkout scenario the tree may have no
274
# parents but the branch may do.
275
first_tree_parent = bzrlib.revision.NULL_REVISION
276
old_revno, master_last = self.master_branch.last_revision_info()
277
if master_last != first_tree_parent:
278
if master_last != bzrlib.revision.NULL_REVISION:
279
raise errors.OutOfDateTree(self.work_tree)
280
if self.branch.repository.has_revision(first_tree_parent):
281
new_revno = old_revno + 1
283
# ghost parents never appear in revision history.
286
# raise an exception as soon as we find a single unknown.
287
for unknown in self.work_tree.unknowns():
288
raise StrictCommitFailed()
290
if self.config is None:
291
self.config = self.branch.get_config()
293
self.work_inv = self.work_tree.inventory
294
self.basis_inv = self.basis_tree.inventory
295
if specific_files is not None:
296
# Ensure specified files are versioned
297
# (We don't actually need the ids here)
298
# XXX: Dont we have filter_unversioned to do this more
300
tree.find_ids_across_trees(specific_files,
301
[self.basis_tree, self.work_tree])
302
# one to finish, one for rev and inventory, and one for each
303
# inventory entry, and the same for the new inventory.
304
# note that this estimate is too long when we do a partial tree
305
# commit which excludes some new files from being considered.
306
# The estimate is corrected when we populate the new inv.
307
self.pb_total = len(self.work_inv) + 5
310
self._gather_parents()
311
if len(self.parents) > 1 and self.specific_files:
312
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
315
self.builder = self.branch.get_commit_builder(self.parents,
316
self.config, timestamp, timezone, committer, revprops, rev_id)
318
self._remove_deleted()
319
self._populate_new_inv()
320
self._report_deletes()
322
self._check_pointless()
324
self._emit_progress_update()
325
# TODO: Now the new inventory is known, check for conflicts and
326
# prompt the user for a commit message.
327
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
328
# weave lines, because nothing should be recorded until it is known
329
# that commit will succeed.
330
self.builder.finish_inventory()
331
self._emit_progress_update()
332
message = message_callback(self)
333
assert isinstance(message, unicode), type(message)
334
self.message = message
335
self._escape_commit_message()
337
self.rev_id = self.builder.commit(self.message)
338
self._emit_progress_update()
339
# revision data is in the local branch now.
341
# upload revision data to the master.
464
342
# this will propagate merged revisions too if needed.
465
343
if self.bound_branch:
466
self._set_progress_stage("Uploading data to master branch")
467
# 'commit' to the master first so a timeout here causes the
468
# local branch to be out of date
469
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
470
self.branch, new_revno, self.rev_id, lossy=self._lossy)
472
self.branch.fetch(self.master_branch, self.rev_id)
344
self.master_branch.repository.fetch(self.branch.repository,
345
revision_id=self.rev_id)
346
# now the master has the revision data
347
# 'commit' to the master first so a timeout here causes the local
348
# branch to be out of date
349
self.master_branch.set_last_revision_info(new_revno,
474
352
# and now do the commit locally.
475
if new_revno is None:
476
# Keep existing behaviour around ghosts
478
353
self.branch.set_last_revision_info(new_revno, self.rev_id)
481
self._process_pre_hooks(old_revno, new_revno)
482
except BaseException:
483
# The commit builder will already have updated the branch,
485
self.branch.set_last_revision_info(old_revno, old_revid)
488
# Merge local tags to remote
489
if self.bound_branch:
490
self._set_progress_stage("Merging tags to master branch")
491
tag_updates, tag_conflicts = self.branch.tags.merge_to(
492
self.master_branch.tags)
494
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
495
note(gettext("Conflicting tags in bound branch:\n{0}".format(
496
"\n".join(warning_lines))))
498
def _select_reporter(self):
499
"""Select the CommitReporter to use."""
501
return NullCommitReporter()
502
return ReportCommitToLog()
355
rev_tree = self.builder.revision_tree()
356
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
357
# now the work tree is up to date with the branch
359
self.reporter.completed(new_revno, self.rev_id)
360
# old style commit hooks - should be deprecated ? (obsoleted in
362
if self.config.post_commit() is not None:
363
hooks = self.config.post_commit().split(' ')
364
# this would be nicer with twisted.python.reflect.namedAny
366
result = eval(hook + '(branch, rev_id)',
367
{'branch':self.branch,
369
'rev_id':self.rev_id})
370
# new style commit hooks:
371
if not self.bound_branch:
372
hook_master = self.branch
375
hook_master = self.master_branch
376
hook_local = self.branch
377
# With bound branches, when the master is behind the local branch,
378
# the 'old_revno' and old_revid values here are incorrect.
379
# XXX: FIXME ^. RBC 20060206
381
old_revid = self.parents[0]
383
old_revid = bzrlib.revision.NULL_REVISION
384
for hook in Branch.hooks['post_commit']:
385
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
387
self._emit_progress_update()
392
def _any_real_changes(self):
393
"""Are there real changes between new_inventory and basis?
395
For trees without rich roots, inv.root.revision changes every commit.
396
But if that is the only change, we want to treat it as though there
399
new_entries = self.builder.new_inventory.iter_entries()
400
basis_entries = self.basis_inv.iter_entries()
401
new_path, new_root_ie = new_entries.next()
402
basis_path, basis_root_ie = basis_entries.next()
404
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
405
def ie_equal_no_revision(this, other):
406
return ((this.file_id == other.file_id)
407
and (this.name == other.name)
408
and (this.symlink_target == other.symlink_target)
409
and (this.text_sha1 == other.text_sha1)
410
and (this.text_size == other.text_size)
411
and (this.text_id == other.text_id)
412
and (this.parent_id == other.parent_id)
413
and (this.kind == other.kind)
414
and (this.executable == other.executable)
415
and (this.reference_revision == other.reference_revision)
417
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
420
for new_ie, basis_ie in zip(new_entries, basis_entries):
421
if new_ie != basis_ie:
424
# No actual changes present
504
427
def _check_pointless(self):
505
428
if self.allow_pointless:
533
465
# If the master branch is bound, we must fail
534
466
master_bound_location = self.master_branch.get_bound_location()
535
467
if master_bound_location:
536
raise errors.CommitToDoubleBoundBranch(
537
self.branch, self.master_branch, master_bound_location)
468
raise errors.CommitToDoubleBoundBranch(self.branch,
469
self.master_branch, master_bound_location)
539
471
# TODO: jam 20051230 We could automatically push local
540
472
# commits to the remote branch if they would fit.
541
473
# But for now, just require remote to be identical
544
476
# Make sure the local branch is identical to the master
545
master_revid = self.master_branch.last_revision()
546
local_revid = self.branch.last_revision()
547
if local_revid != master_revid:
477
master_info = self.master_branch.last_revision_info()
478
local_info = self.branch.last_revision_info()
479
if local_info != master_info:
548
480
raise errors.BoundBranchOutOfDate(self.branch,
551
483
# Now things are ready to change the master branch
552
484
# so grab the lock
553
485
self.bound_branch = self.branch
554
stack.enter_context(self.master_branch.lock_write())
556
def _check_out_of_date_tree(self):
557
"""Check that the working tree is up to date.
559
:return: old_revision_number, old_revision_id, new_revision_number
486
self.master_branch.lock_write()
487
self.master_locked = True
490
"""Cleanup any open locks, progress bars etc."""
491
cleanups = [self._cleanup_bound_branch,
492
self.basis_tree.unlock,
493
self.work_tree.unlock,
495
found_exception = None
496
for cleanup in cleanups:
499
# we want every cleanup to run no matter what.
500
# so we have a catchall here, but we will raise the
501
# last encountered exception up the stack: and
502
# typically this will be useful enough.
505
if found_exception is not None:
506
# don't do a plan raise, because the last exception may have been
507
# trashed, e is our sure-to-work exception even though it loses the
508
# full traceback. XXX: RBC 20060421 perhaps we could check the
509
# exc_info and if its the same one do a plain raise otherwise
510
# 'raise e' as we do now.
513
def _cleanup_bound_branch(self):
514
"""Executed at the end of a try/finally to cleanup a bound branch.
516
If the branch wasn't bound, this is a no-op.
517
If it was, it resents self.branch to the local branch, instead
563
first_tree_parent = self.work_tree.get_parent_ids()[0]
565
# if there are no parents, treat our parent as 'None'
566
# this is so that we still consider the master branch
567
# - in a checkout scenario the tree may have no
568
# parents but the branch may do.
569
first_tree_parent = breezy.revision.NULL_REVISION
570
if (self.master_branch._format.stores_revno() or
571
self.config_stack.get('calculate_revnos')):
573
old_revno, master_last = self.master_branch.last_revision_info()
574
except errors.UnsupportedOperation:
575
master_last = self.master_branch.last_revision()
576
old_revno = self.branch.revision_id_to_revno(master_last)
578
master_last = self.master_branch.last_revision()
580
if master_last != first_tree_parent:
581
if master_last != breezy.revision.NULL_REVISION:
582
raise errors.OutOfDateTree(self.work_tree)
583
if (old_revno is not None and
584
self.branch.repository.has_revision(first_tree_parent)):
585
new_revno = old_revno + 1
587
# ghost parents never appear in revision history.
589
return old_revno, master_last, new_revno
591
def _process_pre_hooks(self, old_revno, new_revno):
592
"""Process any registered pre commit hooks."""
593
self._set_progress_stage("Running pre_commit hooks")
594
self._process_hooks("pre_commit", old_revno, new_revno)
596
def _process_post_hooks(self, old_revno, new_revno):
597
"""Process any registered post commit hooks."""
598
# Process the post commit hooks, if any
599
self._set_progress_stage("Running post_commit hooks")
600
# old style commit hooks - should be deprecated ? (obsoleted in
601
# 0.15^H^H^H^H 2.5.0)
602
post_commit = self.config_stack.get('post_commit')
603
if post_commit is not None:
604
hooks = post_commit.split(' ')
605
# this would be nicer with twisted.python.reflect.namedAny
607
result = eval(hook + '(branch, rev_id)',
608
{'branch': self.branch,
610
'rev_id': self.rev_id})
611
# process new style post commit hooks
612
self._process_hooks("post_commit", old_revno, new_revno)
614
def _process_hooks(self, hook_name, old_revno, new_revno):
615
if not Branch.hooks[hook_name]:
618
# new style commit hooks:
619
520
if not self.bound_branch:
620
hook_master = self.branch
623
hook_master = self.master_branch
624
hook_local = self.branch
625
# With bound branches, when the master is behind the local branch,
626
# the 'old_revno' and old_revid values here are incorrect.
627
# XXX: FIXME ^. RBC 20060206
629
old_revid = self.parents[0]
631
old_revid = breezy.revision.NULL_REVISION
633
if hook_name == "pre_commit":
634
future_tree = self.builder.revision_tree()
635
tree_delta = future_tree.changes_from(self.basis_tree,
638
for hook in Branch.hooks[hook_name]:
639
# show the running hook in the progress bar. As hooks may
640
# end up doing nothing (e.g. because they are not configured by
641
# the user) this is still showing progress, not showing overall
642
# actions - its up to each plugin to show a UI if it want's to
643
# (such as 'Emailing diff to foo@example.com').
644
self.pb_stage_name = "Running %s hooks [%s]" % \
645
(hook_name, Branch.hooks.get_hook_name(hook))
646
self._emit_progress()
647
if 'hooks' in debug.debug_flags:
648
mutter("Invoking commit hook: %r", hook)
649
if hook_name == "post_commit":
650
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
652
elif hook_name == "pre_commit":
653
hook(hook_local, hook_master,
654
old_revno, old_revid, new_revno, self.rev_id,
655
tree_delta, future_tree)
657
def _update_builder_with_changes(self):
658
"""Update the commit builder with the data about what has changed.
660
specific_files = self.specific_files
661
mutter("Selecting files for commit with filter %r", specific_files)
664
iter_changes = self.work_tree.iter_changes(
665
self.basis_tree, specific_files=specific_files)
667
iter_changes = filter_excluded(iter_changes, self.exclude)
668
iter_changes = self._filter_iter_changes(iter_changes)
669
for path, fs_hash in self.builder.record_iter_changes(
670
self.work_tree, self.basis_revid, iter_changes):
671
self.work_tree._observed_sha1(path, fs_hash)
673
def _filter_iter_changes(self, iter_changes):
674
"""Process iter_changes.
676
This method reports on the changes in iter_changes to the user, and
677
converts 'missing' entries in the iter_changes iterator to 'deleted'
678
entries. 'missing' entries have their
680
:param iter_changes: An iter_changes to process.
681
:return: A generator of changes.
683
reporter = self.reporter
684
report_changes = reporter.is_verbose()
686
for change in iter_changes:
688
old_path = change.path[0]
689
new_path = change.path[1]
690
versioned = change.versioned[1]
691
kind = change.kind[1]
692
versioned = change.versioned[1]
693
if kind is None and versioned:
696
reporter.missing(new_path)
697
if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
698
trace.warning('Ignoring "%s" as symlinks are not '
699
'supported on this filesystem.' % (change.path[0],))
522
if self.master_locked:
523
self.master_branch.unlock()
525
def _escape_commit_message(self):
526
"""Replace xml-incompatible control characters."""
527
# FIXME: RBC 20060419 this should be done by the revision
528
# serialiser not by commit. Then we can also add an unescaper
529
# in the deserializer and start roundtripping revision messages
530
# precisely. See repository_implementations/test_repository.py
532
# Python strings can include characters that can't be
533
# represented in well-formed XML; escape characters that
534
# aren't listed in the XML specification
535
# (http://www.w3.org/TR/REC-xml/#NT-Char).
536
self.message, escape_count = re.subn(
537
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
538
lambda match: match.group(0).encode('unicode_escape'),
541
self.reporter.escaped(escape_count, self.message)
543
def _gather_parents(self):
544
"""Record the parents of a merge for merge detection."""
545
# TODO: Make sure that this list doesn't contain duplicate
546
# entries and the order is preserved when doing this.
547
self.parents = self.work_tree.get_parent_ids()
548
self.parent_invs = [self.basis_inv]
549
for revision in self.parents[1:]:
550
if self.branch.repository.has_revision(revision):
551
mutter('commit parent revision {%s}', revision)
552
inventory = self.branch.repository.get_inventory(revision)
553
self.parent_invs.append(inventory)
555
mutter('commit parent ghost revision {%s}', revision)
557
def _remove_deleted(self):
558
"""Remove deleted files from the working inventories.
560
This is done prior to taking the working inventory as the
561
basis for the new committed inventory.
563
This returns true if any files
564
*that existed in the basis inventory* were deleted.
565
Files that were added and deleted
566
in the working copy don't matter.
568
specific = self.specific_files
570
deleted_paths = set()
571
for path, ie in self.work_inv.iter_entries():
572
if is_inside_any(deleted_paths, path):
573
# The tree will delete the required ids recursively.
575
if specific and not is_inside_any(specific, path):
577
if not self.work_tree.has_filename(path):
578
deleted_paths.add(path)
579
self.reporter.missing(path)
580
deleted_ids.append(ie.file_id)
581
self.work_tree.unversion(deleted_ids)
583
def _populate_new_inv(self):
584
"""Build revision inventory.
586
This creates a new empty inventory. Depending on
587
which files are selected for commit, and what is present in the
588
current tree, the new inventory is populated. inventory entries
589
which are candidates for modification have their revision set to
590
None; inventory entries that are carried over untouched have their
591
revision set to their prior value.
593
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
594
# results to create a new inventory at the same time, which results
595
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
597
mutter("Selecting files for commit with filter %s", self.specific_files)
598
assert self.work_inv.root is not None
599
entries = self.work_inv.iter_entries()
600
if not self.builder.record_root_entry:
601
symbol_versioning.warn('CommitBuilders should support recording'
602
' the root entry as of bzr 0.10.', DeprecationWarning,
604
self.builder.new_inventory.add(self.basis_inv.root.copy())
606
self._emit_progress_update()
607
for path, new_ie in entries:
608
self._emit_progress_update()
609
file_id = new_ie.file_id
611
kind = self.work_tree.kind(file_id)
612
if kind == 'tree-reference' and self.recursive == 'down':
613
# nested tree: commit in it
614
sub_tree = WorkingTree.open(self.work_tree.abspath(path))
615
# FIXME: be more comprehensive here:
616
# this works when both trees are in --trees repository,
617
# but when both are bound to a different repository,
618
# it fails; a better way of approaching this is to
619
# finally implement the explicit-caches approach design
620
# a while back - RBC 20070306.
621
if (sub_tree.branch.repository.bzrdir.root_transport.base
623
self.work_tree.branch.repository.bzrdir.root_transport.base):
624
sub_tree.branch.repository = \
625
self.work_tree.branch.repository
627
sub_tree.commit(message=None, revprops=self.revprops,
628
recursive=self.recursive,
629
message_callback=self.message_callback,
630
timestamp=self.timestamp, timezone=self.timezone,
631
committer=self.committer,
632
allow_pointless=self.allow_pointless,
633
strict=self.strict, verbose=self.verbose,
634
local=self.local, reporter=self.reporter)
635
except errors.PointlessCommit:
637
if kind != new_ie.kind:
638
new_ie = inventory.make_entry(kind, new_ie.name,
639
new_ie.parent_id, file_id)
640
except errors.NoSuchFile:
642
# mutter('check %s {%s}', path, file_id)
643
if (not self.specific_files or
644
is_inside_or_parent_of_any(self.specific_files, path)):
645
# mutter('%s selected for commit', path)
649
# mutter('%s not selected for commit', path)
650
if self.basis_inv.has_id(file_id):
651
ie = self.basis_inv[file_id].copy()
653
# this entry is new and not being committed
701
deleted_paths.append(change.path[1])
702
# Reset the new path (None) and new versioned flag (False)
703
change = change.discard_new()
704
new_path = change.path[1]
706
elif kind == 'tree-reference':
707
if self.recursive == 'down':
708
self._commit_nested_tree(change.path[1])
709
if change.versioned[0] or change.versioned[1]:
713
reporter.deleted(old_path)
714
elif old_path is None:
715
reporter.snapshot_change(gettext('added'), new_path)
716
elif old_path != new_path:
717
reporter.renamed(gettext('renamed'),
721
or self.work_tree.branch.repository._format.rich_root_data):
722
# Don't report on changes to '' in non rich root
724
reporter.snapshot_change(
725
gettext('modified'), new_path)
726
self._next_progress_entry()
727
# Unversion files that were found to be deleted
728
self.deleted_paths = deleted_paths
730
def _check_strict(self):
731
# XXX: when we use iter_changes this would likely be faster if
732
# iter_changes would check for us (even in the presence of
735
# raise an exception as soon as we find a single unknown.
736
for unknown in self.work_tree.unknowns():
737
raise StrictCommitFailed()
739
def _commit_nested_tree(self, path):
740
"Commit a nested tree."
741
sub_tree = self.work_tree.get_nested_tree(path)
742
# FIXME: be more comprehensive here:
743
# this works when both trees are in --trees repository,
744
# but when both are bound to a different repository,
745
# it fails; a better way of approaching this is to
746
# finally implement the explicit-caches approach design
747
# a while back - RBC 20070306.
748
if sub_tree.branch.repository.has_same_location(
749
self.work_tree.branch.repository):
750
sub_tree.branch.repository = \
751
self.work_tree.branch.repository
753
return sub_tree.commit(message=None, revprops=self.revprops,
754
recursive=self.recursive,
755
message_callback=self.message_callback,
756
timestamp=self.timestamp,
757
timezone=self.timezone,
758
committer=self.committer,
759
allow_pointless=self.allow_pointless,
760
strict=self.strict, verbose=self.verbose,
761
local=self.local, reporter=self.reporter)
762
except PointlessCommit:
763
return self.work_tree.get_reference_revision(path)
765
def _set_progress_stage(self, name, counter=False):
766
"""Set the progress stage and emit an update to the progress bar."""
767
self.pb_stage_name = name
768
self.pb_stage_count += 1
770
self.pb_entries_count = 0
772
self.pb_entries_count = None
773
self._emit_progress()
775
def _next_progress_entry(self):
776
"""Emit an update to the progress bar and increment the entry count."""
777
self.pb_entries_count += 1
778
self._emit_progress()
780
def _emit_progress(self):
781
if self.pb_entries_count is not None:
782
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
783
self.pb_entries_count)
785
text = gettext("%s - Stage") % (self.pb_stage_name, )
786
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
655
self.builder.record_entry_contents(ie, self.parent_invs,
656
path, self.work_tree)
657
# describe the nature of the change that has occurred relative to
658
# the basis inventory.
659
if (self.basis_inv.has_id(ie.file_id)):
660
basis_ie = self.basis_inv[ie.file_id]
663
change = ie.describe_change(basis_ie, ie)
664
if change in (InventoryEntry.RENAMED,
665
InventoryEntry.MODIFIED_AND_RENAMED):
666
old_path = self.basis_inv.id2path(ie.file_id)
667
self.reporter.renamed(change, old_path, path)
669
self.reporter.snapshot_change(change, path)
671
if not self.specific_files:
674
# ignore removals that don't match filespec
675
for path, new_ie in self.basis_inv.iter_entries():
676
if new_ie.file_id in self.work_inv:
678
if is_inside_any(self.specific_files, path):
682
self.builder.record_entry_contents(ie, self.parent_invs, path,
685
def _emit_progress_update(self):
686
"""Emit an update to the progress bar."""
687
self.pb.update("Committing", self.pb_count, self.pb_total)
690
def _report_deletes(self):
691
for path, ie in self.basis_inv.iter_entries():
692
if ie.file_id not in self.builder.new_inventory:
693
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
