1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# The newly committed revision is going to have a shape corresponding
19
# to that of the working inventory. Files that are not in the
20
# working tree and that were in the predecessor are reported as
21
# removed --- this can include files that were either removed from the
22
# inventory or deleted in the working tree. If they were only
23
# deleted from disk, they are removed from the working inventory.
25
# We then consider the remaining entries, which will be in the new
26
# version. Directory entries are simply copied across. File entries
27
# must be checked to see if a new version of the file should be
28
# recorded. For each parent revision inventory, we check to see what
29
# version of the file was present. If the file was present in at
30
# least one tree, and if it was the same version in all the trees,
31
# then we can just refer to that version. Otherwise, a new version
32
# representing the merger of the file versions must be added.
34
# TODO: Update hashcache before and after - or does the WorkingTree
37
# TODO: Rather than mashing together the ancestry and storing it back,
38
# perhaps the weave should have single method which does it all in one
39
# go, avoiding a lot of redundant work.
41
# TODO: Perhaps give a warning if one of the revisions marked as
42
# merged is already in the ancestry, and then don't record it as a
45
# TODO: If the file is newly merged but unchanged from the version it
46
# merges from, then it should still be reported as newly added
47
# relative to the basis revision.
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
# the rest of the code; add a deprecation of the old name.
57
from cStringIO import StringIO
65
from bzrlib.branch import Branch
67
from bzrlib.errors import (BzrError, PointlessCommit,
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
72
is_inside_or_parent_of_any,
73
minimum_path_selection,
74
quotefn, sha_file, split_lines)
75
from bzrlib.testament import Testament
76
from bzrlib.trace import mutter, note, warning, is_quiet
77
from bzrlib.xml5 import serializer_v5
78
from bzrlib.inventory import Inventory, InventoryEntry
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (deprecated_passed,
83
from bzrlib.workingtree import WorkingTree
84
from bzrlib.urlutils import unescape_for_display
88
class NullCommitReporter(object):
89
"""I report on progress of a commit."""
91
def started(self, revno, revid, location=None):
94
def snapshot_change(self, change, path):
97
def completed(self, revno, rev_id):
100
def deleted(self, file_id):
103
def escaped(self, escape_count, message):
106
def missing(self, path):
109
def renamed(self, change, old_path, new_path):
112
def is_verbose(self):
116
class ReportCommitToLog(NullCommitReporter):
118
def _note(self, format, *args):
121
Subclasses may choose to override this method.
125
def snapshot_change(self, change, path):
126
if change == 'unchanged':
128
if change == 'added' and path == '':
130
self._note("%s %s", change, path)
132
def started(self, revno, rev_id, location=None):
133
if location is not None:
134
location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
137
self._note('Committing revision %d%s.', revno, location)
139
def completed(self, revno, rev_id):
140
self._note('Committed revision %d.', revno)
142
def deleted(self, file_id):
143
self._note('deleted %s', file_id)
145
def escaped(self, escape_count, message):
146
self._note("replaced %d control characters in message", escape_count)
148
def missing(self, path):
149
self._note('missing %s', path)
151
def renamed(self, change, old_path, new_path):
152
self._note('%s %s => %s', change, old_path, new_path)
154
def is_verbose(self):
158
class Commit(object):
159
"""Task of committing a new revision.
161
This is a MethodObject: it accumulates state as the commit is
162
prepared, and then it is discarded. It doesn't represent
163
historical revisions, just the act of recording a new one.
166
Modified to hold a list of files that have been deleted from
167
the working directory; these should be removed from the
173
"""Create a Commit object.
175
:param reporter: the default reporter to use or None to decide later
177
self.reporter = reporter
187
allow_pointless=True,
195
message_callback=None,
197
"""Commit working copy as a new revision.
199
:param message: the commit message (it or message_callback is required)
201
:param timestamp: if not None, seconds-since-epoch for a
202
postdated/predated commit.
204
:param specific_files: If true, commit only those files.
206
:param rev_id: If set, use this as the new revision id.
207
Useful for test or import commands that need to tightly
208
control what revisions are assigned. If you duplicate
209
a revision id that exists elsewhere it is your own fault.
210
If null (default), a time/random revision id is generated.
212
:param allow_pointless: If true (default), commit even if nothing
213
has changed and no merges are recorded.
215
:param strict: If true, don't allow a commit if the working tree
216
contains unknown files.
218
:param revprops: Properties for new revision
219
:param local: Perform a local only commit.
220
:param reporter: the reporter to use or None for the default
221
:param verbose: if True and the reporter is not None, report everything
222
:param recursive: If set to 'down', commit in any subtrees that have
223
pending changes of any sort during this commit.
225
mutter('preparing to commit')
227
if working_tree is None:
228
raise BzrError("working_tree must be passed into commit().")
230
self.work_tree = working_tree
231
self.branch = self.work_tree.branch
232
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
233
if not self.branch.repository.supports_rich_root():
234
raise errors.RootNotRich()
235
if message_callback is None:
236
if message is not None:
237
if isinstance(message, str):
238
message = message.decode(bzrlib.user_encoding)
239
message_callback = lambda x: message
241
raise BzrError("The message or message_callback keyword"
242
" parameter is required for commit().")
244
self.bound_branch = None
245
self.any_entries_changed = False
246
self.any_entries_deleted = False
248
self.master_branch = None
249
self.master_locked = False
250
self.recursive = recursive
252
if specific_files is not None:
253
self.specific_files = sorted(
254
minimum_path_selection(specific_files))
256
self.specific_files = None
257
self.specific_file_ids = None
258
self.allow_pointless = allow_pointless
259
self.revprops = revprops
260
self.message_callback = message_callback
261
self.timestamp = timestamp
262
self.timezone = timezone
263
self.committer = committer
265
self.verbose = verbose
267
self.work_tree.lock_write()
268
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
269
self.basis_tree = self.work_tree.basis_tree()
270
self.basis_tree.lock_read()
272
# Cannot commit with conflicts present.
273
if len(self.work_tree.conflicts()) > 0:
274
raise ConflictsInTree
276
# Setup the bound branch variables as needed.
277
self._check_bound_branch()
279
# Check that the working tree is up to date
280
old_revno, new_revno = self._check_out_of_date_tree()
282
# Complete configuration setup
283
if reporter is not None:
284
self.reporter = reporter
285
elif self.reporter is None:
286
self.reporter = self._select_reporter()
287
if self.config is None:
288
self.config = self.branch.get_config()
290
# If provided, ensure the specified files are versioned
291
if self.specific_files is not None:
292
# Note: This routine is being called because it raises
293
# PathNotVersionedError as a side effect of finding the IDs. We
294
# later use the ids we found as input to the working tree
295
# inventory iterator, so we only consider those ids rather than
296
# examining the whole tree again.
297
# XXX: Dont we have filter_unversioned to do this more
299
self.specific_file_ids = tree.find_ids_across_trees(
300
specific_files, [self.basis_tree, self.work_tree])
302
# Setup the progress bar. As the number of files that need to be
303
# committed in unknown, progress is reported as stages.
304
# We keep track of entries separately though and include that
305
# information in the progress bar during the relevant stages.
306
self.pb_stage_name = ""
307
self.pb_stage_count = 0
308
self.pb_stage_total = 5
309
if self.bound_branch:
310
self.pb_stage_total += 1
311
self.pb.show_pct = False
312
self.pb.show_spinner = False
313
self.pb.show_eta = False
314
self.pb.show_count = True
315
self.pb.show_bar = True
317
# After a merge, a selected file commit is not supported.
318
# See 'bzr help merge' for an explanation as to why.
319
self.basis_inv = self.basis_tree.inventory
320
self._gather_parents()
321
if len(self.parents) > 1 and self.specific_files:
322
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
324
# Collect the changes
325
self._set_progress_stage("Collecting changes",
326
entries_title="Directory")
327
self.builder = self.branch.get_commit_builder(self.parents,
328
self.config, timestamp, timezone, committer, revprops, rev_id)
331
# find the location being committed to
332
if self.bound_branch:
333
master_location = self.master_branch.base
335
master_location = self.branch.base
337
# report the start of the commit
338
self.reporter.started(new_revno, self.rev_id, master_location)
340
self._update_builder_with_changes()
341
self._check_pointless()
343
# TODO: Now the new inventory is known, check for conflicts.
344
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
345
# weave lines, because nothing should be recorded until it is known
346
# that commit will succeed.
347
self._set_progress_stage("Saving data locally")
348
self.builder.finish_inventory()
350
# Prompt the user for a commit message if none provided
351
message = message_callback(self)
352
assert isinstance(message, unicode), type(message)
353
self.message = message
354
self._escape_commit_message()
356
# Add revision data to the local branch
357
self.rev_id = self.builder.commit(self.message)
363
self._process_pre_hooks(old_revno, new_revno)
365
# Upload revision data to the master.
366
# this will propagate merged revisions too if needed.
367
if self.bound_branch:
368
self._set_progress_stage("Uploading data to master branch")
369
self.master_branch.repository.fetch(self.branch.repository,
370
revision_id=self.rev_id)
371
# now the master has the revision data
372
# 'commit' to the master first so a timeout here causes the
373
# local branch to be out of date
374
self.master_branch.set_last_revision_info(new_revno,
377
# and now do the commit locally.
378
self.branch.set_last_revision_info(new_revno, self.rev_id)
380
# Make the working tree up to date with the branch
381
self._set_progress_stage("Updating the working tree")
382
rev_tree = self.builder.revision_tree()
383
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
384
self.reporter.completed(new_revno, self.rev_id)
385
self._process_post_hooks(old_revno, new_revno)
390
def _select_reporter(self):
391
"""Select the CommitReporter to use."""
393
return NullCommitReporter()
394
return ReportCommitToLog()
396
def _check_pointless(self):
397
if self.allow_pointless:
399
# A merge with no effect on files
400
if len(self.parents) > 1:
402
# work around the fact that a newly-initted tree does differ from its
404
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
405
raise PointlessCommit()
406
# Shortcut, if the number of entries changes, then we obviously have
408
if len(self.builder.new_inventory) != len(self.basis_inv):
410
# If length == 1, then we only have the root entry. Which means
411
# that there is no real difference (only the root could be different)
412
if len(self.builder.new_inventory) != 1 and (self.any_entries_changed
413
or self.any_entries_deleted):
415
raise PointlessCommit()
417
def _check_bound_branch(self):
418
"""Check to see if the local branch is bound.
420
If it is bound, then most of the commit will actually be
421
done using the remote branch as the target branch.
422
Only at the end will the local branch be updated.
424
if self.local and not self.branch.get_bound_location():
425
raise errors.LocalRequiresBoundBranch()
428
self.master_branch = self.branch.get_master_branch()
430
if not self.master_branch:
431
# make this branch the reference branch for out of date checks.
432
self.master_branch = self.branch
435
# If the master branch is bound, we must fail
436
master_bound_location = self.master_branch.get_bound_location()
437
if master_bound_location:
438
raise errors.CommitToDoubleBoundBranch(self.branch,
439
self.master_branch, master_bound_location)
441
# TODO: jam 20051230 We could automatically push local
442
# commits to the remote branch if they would fit.
443
# But for now, just require remote to be identical
446
# Make sure the local branch is identical to the master
447
master_info = self.master_branch.last_revision_info()
448
local_info = self.branch.last_revision_info()
449
if local_info != master_info:
450
raise errors.BoundBranchOutOfDate(self.branch,
453
# Now things are ready to change the master branch
455
self.bound_branch = self.branch
456
self.master_branch.lock_write()
457
self.master_locked = True
459
def _check_out_of_date_tree(self):
460
"""Check that the working tree is up to date.
462
:return: old_revision_number,new_revision_number tuple
465
first_tree_parent = self.work_tree.get_parent_ids()[0]
467
# if there are no parents, treat our parent as 'None'
468
# this is so that we still consider the master branch
469
# - in a checkout scenario the tree may have no
470
# parents but the branch may do.
471
first_tree_parent = bzrlib.revision.NULL_REVISION
472
old_revno, master_last = self.master_branch.last_revision_info()
473
if master_last != first_tree_parent:
474
if master_last != bzrlib.revision.NULL_REVISION:
475
raise errors.OutOfDateTree(self.work_tree)
476
if self.branch.repository.has_revision(first_tree_parent):
477
new_revno = old_revno + 1
479
# ghost parents never appear in revision history.
481
return old_revno,new_revno
483
def _process_pre_hooks(self, old_revno, new_revno):
484
"""Process any registered pre commit hooks."""
485
self._set_progress_stage("Running pre_commit hooks")
486
self._process_hooks("pre_commit", old_revno, new_revno)
488
def _process_post_hooks(self, old_revno, new_revno):
489
"""Process any registered post commit hooks."""
490
# Process the post commit hooks, if any
491
self._set_progress_stage("Running post_commit hooks")
492
# old style commit hooks - should be deprecated ? (obsoleted in
494
if self.config.post_commit() is not None:
495
hooks = self.config.post_commit().split(' ')
496
# this would be nicer with twisted.python.reflect.namedAny
498
result = eval(hook + '(branch, rev_id)',
499
{'branch':self.branch,
501
'rev_id':self.rev_id})
502
# process new style post commit hooks
503
self._process_hooks("post_commit", old_revno, new_revno)
505
def _process_hooks(self, hook_name, old_revno, new_revno):
506
if not Branch.hooks[hook_name]:
509
# new style commit hooks:
510
if not self.bound_branch:
511
hook_master = self.branch
514
hook_master = self.master_branch
515
hook_local = self.branch
516
# With bound branches, when the master is behind the local branch,
517
# the 'old_revno' and old_revid values here are incorrect.
518
# XXX: FIXME ^. RBC 20060206
520
old_revid = self.parents[0]
522
old_revid = bzrlib.revision.NULL_REVISION
524
if hook_name == "pre_commit":
525
future_tree = self.builder.revision_tree()
526
tree_delta = future_tree.changes_from(self.basis_tree,
529
for hook in Branch.hooks[hook_name]:
530
# show the running hook in the progress bar. As hooks may
531
# end up doing nothing (e.g. because they are not configured by
532
# the user) this is still showing progress, not showing overall
533
# actions - its up to each plugin to show a UI if it want's to
534
# (such as 'Emailing diff to foo@example.com').
535
self.pb_stage_name = "Running %s hooks [%s]" % \
536
(hook_name, Branch.hooks.get_hook_name(hook))
537
self._emit_progress()
538
if 'hooks' in debug.debug_flags:
539
mutter("Invoking commit hook: %r", hook)
540
if hook_name == "post_commit":
541
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
543
elif hook_name == "pre_commit":
544
hook(hook_local, hook_master,
545
old_revno, old_revid, new_revno, self.rev_id,
546
tree_delta, future_tree)
549
"""Cleanup any open locks, progress bars etc."""
550
cleanups = [self._cleanup_bound_branch,
551
self.basis_tree.unlock,
552
self.work_tree.unlock,
554
found_exception = None
555
for cleanup in cleanups:
558
# we want every cleanup to run no matter what.
559
# so we have a catchall here, but we will raise the
560
# last encountered exception up the stack: and
561
# typically this will be useful enough.
564
if found_exception is not None:
565
# don't do a plan raise, because the last exception may have been
566
# trashed, e is our sure-to-work exception even though it loses the
567
# full traceback. XXX: RBC 20060421 perhaps we could check the
568
# exc_info and if its the same one do a plain raise otherwise
569
# 'raise e' as we do now.
572
def _cleanup_bound_branch(self):
573
"""Executed at the end of a try/finally to cleanup a bound branch.
575
If the branch wasn't bound, this is a no-op.
576
If it was, it resents self.branch to the local branch, instead
579
if not self.bound_branch:
581
if self.master_locked:
582
self.master_branch.unlock()
584
def _escape_commit_message(self):
585
"""Replace xml-incompatible control characters."""
586
# FIXME: RBC 20060419 this should be done by the revision
587
# serialiser not by commit. Then we can also add an unescaper
588
# in the deserializer and start roundtripping revision messages
589
# precisely. See repository_implementations/test_repository.py
591
# Python strings can include characters that can't be
592
# represented in well-formed XML; escape characters that
593
# aren't listed in the XML specification
594
# (http://www.w3.org/TR/REC-xml/#NT-Char).
595
self.message, escape_count = re.subn(
596
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
597
lambda match: match.group(0).encode('unicode_escape'),
600
self.reporter.escaped(escape_count, self.message)
602
def _gather_parents(self):
603
"""Record the parents of a merge for merge detection."""
604
# TODO: Make sure that this list doesn't contain duplicate
605
# entries and the order is preserved when doing this.
606
self.parents = self.work_tree.get_parent_ids()
607
self.parent_invs = [self.basis_inv]
608
for revision in self.parents[1:]:
609
if self.branch.repository.has_revision(revision):
610
mutter('commit parent revision {%s}', revision)
611
inventory = self.branch.repository.get_inventory(revision)
612
self.parent_invs.append(inventory)
614
mutter('commit parent ghost revision {%s}', revision)
616
def _update_builder_with_changes(self):
617
"""Update the commit builder with the data about what has changed.
619
# Build the revision inventory.
621
# This starts by creating a new empty inventory. Depending on
622
# which files are selected for commit, and what is present in the
623
# current tree, the new inventory is populated. inventory entries
624
# which are candidates for modification have their revision set to
625
# None; inventory entries that are carried over untouched have their
626
# revision set to their prior value.
628
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
629
# results to create a new inventory at the same time, which results
630
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
633
specific_files = self.specific_files
634
mutter("Selecting files for commit with filter %s", specific_files)
636
# Check and warn about old CommitBuilders
637
if not self.builder.record_root_entry:
638
symbol_versioning.warn('CommitBuilders should support recording'
639
' the root entry as of bzr 0.10.', DeprecationWarning,
641
self.builder.new_inventory.add(self.basis_inv.root.copy())
643
# Build the new inventory
644
self._populate_from_inventory(specific_files)
646
# If specific files are selected, then all un-selected files must be
647
# recorded in their previous state. For more details, see
648
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
650
for path, old_ie in self.basis_inv.iter_entries():
651
if old_ie.file_id in self.builder.new_inventory:
652
# already added - skip.
654
if is_inside_any(specific_files, path):
655
# was inside the selected path, if not present it has been
658
if old_ie.kind == 'directory':
659
self._next_progress_entry()
660
# not in final inv yet, was not in the selected files, so is an
661
# entry to be preserved unaltered.
663
# Note: specific file commits after a merge are currently
664
# prohibited. This test is for sanity/safety in case it's
665
# required after that changes.
666
if len(self.parents) > 1:
668
delta, version_recorded = self.builder.record_entry_contents(
669
ie, self.parent_invs, path, self.basis_tree, None)
671
self.any_entries_changed = True
673
# note that deletes have occurred
674
if set(self.basis_inv._byid.keys()) - set(self.builder.new_inventory._byid.keys()):
675
self.any_entries_deleted = True
676
# Report what was deleted.
677
if self.any_entries_deleted and self.reporter.is_verbose():
678
for path, ie in self.basis_inv.iter_entries():
679
if ie.file_id not in self.builder.new_inventory:
680
self.reporter.deleted(path)
682
def _populate_from_inventory(self, specific_files):
683
"""Populate the CommitBuilder by walking the working tree inventory."""
685
# raise an exception as soon as we find a single unknown.
686
for unknown in self.work_tree.unknowns():
687
raise StrictCommitFailed()
689
report_changes = self.reporter.is_verbose()
691
deleted_paths = set()
692
work_inv = self.work_tree.inventory
693
assert work_inv.root is not None
694
# XXX: Note that entries may have the wrong kind.
695
entries = work_inv.iter_entries_by_dir(
696
specific_file_ids=self.specific_file_ids, yield_parents=True)
697
if not self.builder.record_root_entry:
699
for path, existing_ie in entries:
700
file_id = existing_ie.file_id
701
name = existing_ie.name
702
parent_id = existing_ie.parent_id
703
kind = existing_ie.kind
704
if kind == 'directory':
705
self._next_progress_entry()
706
# Skip files that have been deleted from the working tree.
707
# The deleted files/directories are also recorded so they
708
# can be explicitly unversioned later. Note that when a
709
# filter of specific files is given, we must only skip/record
710
# deleted files matching that filter.
711
if is_inside_any(deleted_paths, path):
713
content_summary = self.work_tree.path_content_summary(path)
714
if not specific_files or is_inside_any(specific_files, path):
715
if content_summary[0] == 'missing':
716
deleted_paths.add(path)
717
self.reporter.missing(path)
718
deleted_ids.append(file_id)
720
# TODO: have the builder do the nested commit just-in-time IF and
722
if content_summary[0] == 'tree-reference':
723
# enforce repository nested tree policy.
724
if (not self.work_tree.supports_tree_reference() or
725
# repository does not support it either.
726
not self.branch.repository._format.supports_tree_reference):
727
content_summary = ('directory',) + content_summary[1:]
728
kind = content_summary[0]
729
# TODO: specific_files filtering before nested tree processing
730
if kind == 'tree-reference':
731
if self.recursive == 'down':
732
nested_revision_id = self._commit_nested_tree(
734
content_summary = content_summary[:3] + (
737
content_summary = content_summary[:3] + (
738
self.work_tree.get_reference_revision(file_id),)
740
# Record an entry for this item
741
# Note: I don't particularly want to have the existing_ie
742
# parameter but the test suite currently (28-Jun-07) breaks
743
# without it thanks to a unicode normalisation issue. :-(
744
definitely_changed = kind != existing_ie.kind
745
self._record_entry(path, file_id, specific_files, kind, name,
746
parent_id, definitely_changed, existing_ie, report_changes,
749
# Unversion IDs that were found to be deleted
750
self.work_tree.unversion(deleted_ids)
752
def _commit_nested_tree(self, file_id, path):
753
"Commit a nested tree."
754
sub_tree = self.work_tree.get_nested_tree(file_id, path)
755
# FIXME: be more comprehensive here:
756
# this works when both trees are in --trees repository,
757
# but when both are bound to a different repository,
758
# it fails; a better way of approaching this is to
759
# finally implement the explicit-caches approach design
760
# a while back - RBC 20070306.
761
if sub_tree.branch.repository.has_same_location(
762
self.work_tree.branch.repository):
763
sub_tree.branch.repository = \
764
self.work_tree.branch.repository
766
return sub_tree.commit(message=None, revprops=self.revprops,
767
recursive=self.recursive,
768
message_callback=self.message_callback,
769
timestamp=self.timestamp, timezone=self.timezone,
770
committer=self.committer,
771
allow_pointless=self.allow_pointless,
772
strict=self.strict, verbose=self.verbose,
773
local=self.local, reporter=self.reporter)
774
except errors.PointlessCommit:
775
return self.work_tree.get_reference_revision(file_id)
777
def _record_entry(self, path, file_id, specific_files, kind, name,
778
parent_id, definitely_changed, existing_ie, report_changes,
780
"Record the new inventory entry for a path if any."
781
# mutter('check %s {%s}', path, file_id)
782
# mutter('%s selected for commit', path)
783
if definitely_changed or existing_ie is None:
784
ie = inventory.make_entry(kind, name, parent_id, file_id)
786
ie = existing_ie.copy()
788
delta, version_recorded = self.builder.record_entry_contents(ie,
789
self.parent_invs, path, self.work_tree, content_summary)
791
self.any_entries_changed = True
793
self._report_change(ie, path)
796
def _report_change(self, ie, path):
797
"""Report a change to the user.
799
The change that has occurred is described relative to the basis
802
if (self.basis_inv.has_id(ie.file_id)):
803
basis_ie = self.basis_inv[ie.file_id]
806
change = ie.describe_change(basis_ie, ie)
807
if change in (InventoryEntry.RENAMED,
808
InventoryEntry.MODIFIED_AND_RENAMED):
809
old_path = self.basis_inv.id2path(ie.file_id)
810
self.reporter.renamed(change, old_path, path)
812
self.reporter.snapshot_change(change, path)
814
def _set_progress_stage(self, name, entries_title=None):
815
"""Set the progress stage and emit an update to the progress bar."""
816
self.pb_stage_name = name
817
self.pb_stage_count += 1
818
self.pb_entries_title = entries_title
819
if entries_title is not None:
820
self.pb_entries_count = 0
821
self.pb_entries_total = '?'
822
self._emit_progress()
824
def _next_progress_entry(self):
825
"""Emit an update to the progress bar and increment the entry count."""
826
self.pb_entries_count += 1
827
self._emit_progress()
829
def _emit_progress(self):
830
if self.pb_entries_title:
831
if self.pb_entries_total == '?':
832
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
833
self.pb_entries_title, self.pb_entries_count)
835
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
836
self.pb_entries_title, self.pb_entries_count,
837
str(self.pb_entries_total))
839
text = "%s - Stage" % (self.pb_stage_name)
840
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
