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
266
# accumulates an inventory delta to the basis entry, so we can make
267
# just the necessary updates to the workingtree's cached basis.
268
self.basis_delta = []
270
self.work_tree.lock_write()
271
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
272
self.basis_tree = self.work_tree.basis_tree()
273
self.basis_tree.lock_read()
275
# Cannot commit with conflicts present.
276
if len(self.work_tree.conflicts()) > 0:
277
raise ConflictsInTree
279
# Setup the bound branch variables as needed.
280
self._check_bound_branch()
282
# Check that the working tree is up to date
283
old_revno, new_revno = self._check_out_of_date_tree()
285
# Complete configuration setup
286
if reporter is not None:
287
self.reporter = reporter
288
elif self.reporter is None:
289
self.reporter = self._select_reporter()
290
if self.config is None:
291
self.config = self.branch.get_config()
293
# If provided, ensure the specified files are versioned
294
if self.specific_files is not None:
295
# Note: This routine is being called because it raises
296
# PathNotVersionedError as a side effect of finding the IDs. We
297
# later use the ids we found as input to the working tree
298
# inventory iterator, so we only consider those ids rather than
299
# examining the whole tree again.
300
# XXX: Dont we have filter_unversioned to do this more
302
self.specific_file_ids = tree.find_ids_across_trees(
303
specific_files, [self.basis_tree, self.work_tree])
305
# Setup the progress bar. As the number of files that need to be
306
# committed in unknown, progress is reported as stages.
307
# We keep track of entries separately though and include that
308
# information in the progress bar during the relevant stages.
309
self.pb_stage_name = ""
310
self.pb_stage_count = 0
311
self.pb_stage_total = 5
312
if self.bound_branch:
313
self.pb_stage_total += 1
314
self.pb.show_pct = False
315
self.pb.show_spinner = False
316
self.pb.show_eta = False
317
self.pb.show_count = True
318
self.pb.show_bar = True
320
# After a merge, a selected file commit is not supported.
321
# See 'bzr help merge' for an explanation as to why.
322
self.basis_inv = self.basis_tree.inventory
323
self._gather_parents()
324
if len(self.parents) > 1 and self.specific_files:
325
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
327
# Collect the changes
328
self._set_progress_stage("Collecting changes",
329
entries_title="Directory")
330
self.builder = self.branch.get_commit_builder(self.parents,
331
self.config, timestamp, timezone, committer, revprops, rev_id)
334
# find the location being committed to
335
if self.bound_branch:
336
master_location = self.master_branch.base
338
master_location = self.branch.base
340
# report the start of the commit
341
self.reporter.started(new_revno, self.rev_id, master_location)
343
self._update_builder_with_changes()
344
self._report_and_accumulate_deletes()
345
self._check_pointless()
347
# TODO: Now the new inventory is known, check for conflicts.
348
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
349
# weave lines, because nothing should be recorded until it is known
350
# that commit will succeed.
351
self._set_progress_stage("Saving data locally")
352
self.builder.finish_inventory()
354
# Prompt the user for a commit message if none provided
355
message = message_callback(self)
356
assert isinstance(message, unicode), type(message)
357
self.message = message
358
self._escape_commit_message()
360
# Add revision data to the local branch
361
self.rev_id = self.builder.commit(self.message)
367
self._process_pre_hooks(old_revno, new_revno)
369
# Upload revision data to the master.
370
# this will propagate merged revisions too if needed.
371
if self.bound_branch:
372
self._set_progress_stage("Uploading data to master branch")
373
self.master_branch.repository.fetch(self.branch.repository,
374
revision_id=self.rev_id)
375
# now the master has the revision data
376
# 'commit' to the master first so a timeout here causes the
377
# local branch to be out of date
378
self.master_branch.set_last_revision_info(new_revno,
381
# and now do the commit locally.
382
self.branch.set_last_revision_info(new_revno, self.rev_id)
384
# Make the working tree up to date with the branch
385
self._set_progress_stage("Updating the working tree")
386
rev_tree = self.builder.revision_tree()
387
# XXX: This will need to be changed if we support doing a
388
# selective commit while a merge is still pending - then we'd
389
# still have multiple parents after the commit.
390
self.work_tree.update_basis_by_delta(self.rev_id,
392
self.reporter.completed(new_revno, self.rev_id)
393
self._process_post_hooks(old_revno, new_revno)
398
def _select_reporter(self):
399
"""Select the CommitReporter to use."""
401
return NullCommitReporter()
402
return ReportCommitToLog()
404
def _check_pointless(self):
405
if self.allow_pointless:
407
# A merge with no effect on files
408
if len(self.parents) > 1:
410
# TODO: we could simplify this by using self.basis_delta.
412
# The inital commit adds a root directory, but this in itself is not
413
# a worthwhile commit.
414
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
415
raise PointlessCommit()
416
# Shortcut, if the number of entries changes, then we obviously have
418
if len(self.builder.new_inventory) != len(self.basis_inv):
420
# If length == 1, then we only have the root entry. Which means
421
# that there is no real difference (only the root could be different)
422
if len(self.builder.new_inventory) != 1 and (self.any_entries_changed
423
or self.any_entries_deleted):
425
raise PointlessCommit()
427
def _check_bound_branch(self):
428
"""Check to see if the local branch is bound.
430
If it is bound, then most of the commit will actually be
431
done using the remote branch as the target branch.
432
Only at the end will the local branch be updated.
434
if self.local and not self.branch.get_bound_location():
435
raise errors.LocalRequiresBoundBranch()
438
self.master_branch = self.branch.get_master_branch()
440
if not self.master_branch:
441
# make this branch the reference branch for out of date checks.
442
self.master_branch = self.branch
445
# If the master branch is bound, we must fail
446
master_bound_location = self.master_branch.get_bound_location()
447
if master_bound_location:
448
raise errors.CommitToDoubleBoundBranch(self.branch,
449
self.master_branch, master_bound_location)
451
# TODO: jam 20051230 We could automatically push local
452
# commits to the remote branch if they would fit.
453
# But for now, just require remote to be identical
456
# Make sure the local branch is identical to the master
457
master_info = self.master_branch.last_revision_info()
458
local_info = self.branch.last_revision_info()
459
if local_info != master_info:
460
raise errors.BoundBranchOutOfDate(self.branch,
463
# Now things are ready to change the master branch
465
self.bound_branch = self.branch
466
self.master_branch.lock_write()
467
self.master_locked = True
469
def _check_out_of_date_tree(self):
470
"""Check that the working tree is up to date.
472
:return: old_revision_number,new_revision_number tuple
475
first_tree_parent = self.work_tree.get_parent_ids()[0]
477
# if there are no parents, treat our parent as 'None'
478
# this is so that we still consider the master branch
479
# - in a checkout scenario the tree may have no
480
# parents but the branch may do.
481
first_tree_parent = bzrlib.revision.NULL_REVISION
482
old_revno, master_last = self.master_branch.last_revision_info()
483
if master_last != first_tree_parent:
484
if master_last != bzrlib.revision.NULL_REVISION:
485
raise errors.OutOfDateTree(self.work_tree)
486
if self.branch.repository.has_revision(first_tree_parent):
487
new_revno = old_revno + 1
489
# ghost parents never appear in revision history.
491
return old_revno,new_revno
493
def _process_pre_hooks(self, old_revno, new_revno):
494
"""Process any registered pre commit hooks."""
495
self._set_progress_stage("Running pre_commit hooks")
496
self._process_hooks("pre_commit", old_revno, new_revno)
498
def _process_post_hooks(self, old_revno, new_revno):
499
"""Process any registered post commit hooks."""
500
# Process the post commit hooks, if any
501
self._set_progress_stage("Running post_commit hooks")
502
# old style commit hooks - should be deprecated ? (obsoleted in
504
if self.config.post_commit() is not None:
505
hooks = self.config.post_commit().split(' ')
506
# this would be nicer with twisted.python.reflect.namedAny
508
result = eval(hook + '(branch, rev_id)',
509
{'branch':self.branch,
511
'rev_id':self.rev_id})
512
# process new style post commit hooks
513
self._process_hooks("post_commit", old_revno, new_revno)
515
def _process_hooks(self, hook_name, old_revno, new_revno):
516
if not Branch.hooks[hook_name]:
519
# new style commit hooks:
520
if not self.bound_branch:
521
hook_master = self.branch
524
hook_master = self.master_branch
525
hook_local = self.branch
526
# With bound branches, when the master is behind the local branch,
527
# the 'old_revno' and old_revid values here are incorrect.
528
# XXX: FIXME ^. RBC 20060206
530
old_revid = self.parents[0]
532
old_revid = bzrlib.revision.NULL_REVISION
534
if hook_name == "pre_commit":
535
future_tree = self.builder.revision_tree()
536
tree_delta = future_tree.changes_from(self.basis_tree,
539
for hook in Branch.hooks[hook_name]:
540
# show the running hook in the progress bar. As hooks may
541
# end up doing nothing (e.g. because they are not configured by
542
# the user) this is still showing progress, not showing overall
543
# actions - its up to each plugin to show a UI if it want's to
544
# (such as 'Emailing diff to foo@example.com').
545
self.pb_stage_name = "Running %s hooks [%s]" % \
546
(hook_name, Branch.hooks.get_hook_name(hook))
547
self._emit_progress()
548
if 'hooks' in debug.debug_flags:
549
mutter("Invoking commit hook: %r", hook)
550
if hook_name == "post_commit":
551
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
553
elif hook_name == "pre_commit":
554
hook(hook_local, hook_master,
555
old_revno, old_revid, new_revno, self.rev_id,
556
tree_delta, future_tree)
559
"""Cleanup any open locks, progress bars etc."""
560
cleanups = [self._cleanup_bound_branch,
561
self.basis_tree.unlock,
562
self.work_tree.unlock,
564
found_exception = None
565
for cleanup in cleanups:
568
# we want every cleanup to run no matter what.
569
# so we have a catchall here, but we will raise the
570
# last encountered exception up the stack: and
571
# typically this will be useful enough.
574
if found_exception is not None:
575
# don't do a plan raise, because the last exception may have been
576
# trashed, e is our sure-to-work exception even though it loses the
577
# full traceback. XXX: RBC 20060421 perhaps we could check the
578
# exc_info and if its the same one do a plain raise otherwise
579
# 'raise e' as we do now.
582
def _cleanup_bound_branch(self):
583
"""Executed at the end of a try/finally to cleanup a bound branch.
585
If the branch wasn't bound, this is a no-op.
586
If it was, it resents self.branch to the local branch, instead
589
if not self.bound_branch:
591
if self.master_locked:
592
self.master_branch.unlock()
594
def _escape_commit_message(self):
595
"""Replace xml-incompatible control characters."""
596
# FIXME: RBC 20060419 this should be done by the revision
597
# serialiser not by commit. Then we can also add an unescaper
598
# in the deserializer and start roundtripping revision messages
599
# precisely. See repository_implementations/test_repository.py
601
# Python strings can include characters that can't be
602
# represented in well-formed XML; escape characters that
603
# aren't listed in the XML specification
604
# (http://www.w3.org/TR/REC-xml/#NT-Char).
605
self.message, escape_count = re.subn(
606
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
607
lambda match: match.group(0).encode('unicode_escape'),
610
self.reporter.escaped(escape_count, self.message)
612
def _gather_parents(self):
613
"""Record the parents of a merge for merge detection."""
614
# TODO: Make sure that this list doesn't contain duplicate
615
# entries and the order is preserved when doing this.
616
self.parents = self.work_tree.get_parent_ids()
617
self.parent_invs = [self.basis_inv]
618
for revision in self.parents[1:]:
619
if self.branch.repository.has_revision(revision):
620
mutter('commit parent revision {%s}', revision)
621
inventory = self.branch.repository.get_inventory(revision)
622
self.parent_invs.append(inventory)
624
mutter('commit parent ghost revision {%s}', revision)
626
def _update_builder_with_changes(self):
627
"""Update the commit builder with the data about what has changed.
629
# Build the revision inventory.
631
# This starts by creating a new empty inventory. Depending on
632
# which files are selected for commit, and what is present in the
633
# current tree, the new inventory is populated. inventory entries
634
# which are candidates for modification have their revision set to
635
# None; inventory entries that are carried over untouched have their
636
# revision set to their prior value.
638
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
639
# results to create a new inventory at the same time, which results
640
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
643
specific_files = self.specific_files
644
mutter("Selecting files for commit with filter %s", specific_files)
646
# Build the new inventory
647
self._populate_from_inventory(specific_files)
649
# If specific files are selected, then all un-selected files must be
650
# recorded in their previous state. For more details, see
651
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
653
for path, old_ie in self.basis_inv.iter_entries():
654
if old_ie.file_id in self.builder.new_inventory:
655
# already added - skip.
657
if is_inside_any(specific_files, path):
658
# was inside the selected path, if not present it has been
661
if old_ie.kind == 'directory':
662
self._next_progress_entry()
663
# not in final inv yet, was not in the selected files, so is an
664
# entry to be preserved unaltered.
666
# Note: specific file commits after a merge are currently
667
# prohibited. This test is for sanity/safety in case it's
668
# required after that changes.
669
if len(self.parents) > 1:
671
delta, version_recorded = self.builder.record_entry_contents(
672
ie, self.parent_invs, path, self.basis_tree, None)
674
self.any_entries_changed = True
675
if delta: self.basis_delta.append(delta)
677
def _report_and_accumulate_deletes(self):
678
# XXX: Could the list of deleted paths and ids be instead taken from
679
# _populate_from_inventory?
680
deleted_ids = set(self.basis_inv._byid.keys()) - \
681
set(self.builder.new_inventory._byid.keys())
683
self.any_entries_deleted = True
684
deleted = [(self.basis_inv.id2path(file_id), file_id)
685
for file_id in deleted_ids]
687
# XXX: this is not quite directory-order sorting
688
for path, file_id in deleted:
689
self.basis_delta.append((path, None, file_id, None))
690
self.reporter.deleted(path)
692
def _populate_from_inventory(self, specific_files):
693
"""Populate the CommitBuilder by walking the working tree inventory."""
695
# raise an exception as soon as we find a single unknown.
696
for unknown in self.work_tree.unknowns():
697
raise StrictCommitFailed()
699
report_changes = self.reporter.is_verbose()
701
deleted_paths = set()
702
work_inv = self.work_tree.inventory
703
assert work_inv.root is not None
704
# XXX: Note that entries may have the wrong kind.
705
entries = work_inv.iter_entries_by_dir(
706
specific_file_ids=self.specific_file_ids, yield_parents=True)
707
for path, existing_ie in entries:
708
file_id = existing_ie.file_id
709
name = existing_ie.name
710
parent_id = existing_ie.parent_id
711
kind = existing_ie.kind
712
if kind == 'directory':
713
self._next_progress_entry()
714
# Skip files that have been deleted from the working tree.
715
# The deleted files/directories are also recorded so they
716
# can be explicitly unversioned later. Note that when a
717
# filter of specific files is given, we must only skip/record
718
# deleted files matching that filter.
719
if is_inside_any(deleted_paths, path):
721
content_summary = self.work_tree.path_content_summary(path)
722
if not specific_files or is_inside_any(specific_files, path):
723
if content_summary[0] == 'missing':
724
deleted_paths.add(path)
725
self.reporter.missing(path)
726
deleted_ids.append(file_id)
728
# TODO: have the builder do the nested commit just-in-time IF and
730
if content_summary[0] == 'tree-reference':
731
# enforce repository nested tree policy.
732
if (not self.work_tree.supports_tree_reference() or
733
# repository does not support it either.
734
not self.branch.repository._format.supports_tree_reference):
735
content_summary = ('directory',) + content_summary[1:]
736
kind = content_summary[0]
737
# TODO: specific_files filtering before nested tree processing
738
if kind == 'tree-reference':
739
if self.recursive == 'down':
740
nested_revision_id = self._commit_nested_tree(
742
content_summary = content_summary[:3] + (
745
content_summary = content_summary[:3] + (
746
self.work_tree.get_reference_revision(file_id),)
748
# Record an entry for this item
749
# Note: I don't particularly want to have the existing_ie
750
# parameter but the test suite currently (28-Jun-07) breaks
751
# without it thanks to a unicode normalisation issue. :-(
752
definitely_changed = kind != existing_ie.kind
753
self._record_entry(path, file_id, specific_files, kind, name,
754
parent_id, definitely_changed, existing_ie, report_changes,
757
# Unversion IDs that were found to be deleted
758
self.work_tree.unversion(deleted_ids)
760
def _commit_nested_tree(self, file_id, path):
761
"Commit a nested tree."
762
sub_tree = self.work_tree.get_nested_tree(file_id, path)
763
# FIXME: be more comprehensive here:
764
# this works when both trees are in --trees repository,
765
# but when both are bound to a different repository,
766
# it fails; a better way of approaching this is to
767
# finally implement the explicit-caches approach design
768
# a while back - RBC 20070306.
769
if sub_tree.branch.repository.has_same_location(
770
self.work_tree.branch.repository):
771
sub_tree.branch.repository = \
772
self.work_tree.branch.repository
774
return sub_tree.commit(message=None, revprops=self.revprops,
775
recursive=self.recursive,
776
message_callback=self.message_callback,
777
timestamp=self.timestamp, timezone=self.timezone,
778
committer=self.committer,
779
allow_pointless=self.allow_pointless,
780
strict=self.strict, verbose=self.verbose,
781
local=self.local, reporter=self.reporter)
782
except errors.PointlessCommit:
783
return self.work_tree.get_reference_revision(file_id)
785
def _record_entry(self, path, file_id, specific_files, kind, name,
786
parent_id, definitely_changed, existing_ie, report_changes,
788
"Record the new inventory entry for a path if any."
789
# mutter('check %s {%s}', path, file_id)
790
# mutter('%s selected for commit', path)
791
if definitely_changed or existing_ie is None:
792
ie = inventory.make_entry(kind, name, parent_id, file_id)
794
ie = existing_ie.copy()
796
delta, version_recorded = self.builder.record_entry_contents(ie,
797
self.parent_invs, path, self.work_tree, content_summary)
799
self.basis_delta.append(delta)
801
self.any_entries_changed = True
803
self._report_change(ie, path)
806
def _report_change(self, ie, path):
807
"""Report a change to the user.
809
The change that has occurred is described relative to the basis
812
if (self.basis_inv.has_id(ie.file_id)):
813
basis_ie = self.basis_inv[ie.file_id]
816
change = ie.describe_change(basis_ie, ie)
817
if change in (InventoryEntry.RENAMED,
818
InventoryEntry.MODIFIED_AND_RENAMED):
819
old_path = self.basis_inv.id2path(ie.file_id)
820
self.reporter.renamed(change, old_path, path)
822
self.reporter.snapshot_change(change, path)
824
def _set_progress_stage(self, name, entries_title=None):
825
"""Set the progress stage and emit an update to the progress bar."""
826
self.pb_stage_name = name
827
self.pb_stage_count += 1
828
self.pb_entries_title = entries_title
829
if entries_title is not None:
830
self.pb_entries_count = 0
831
self.pb_entries_total = '?'
832
self._emit_progress()
834
def _next_progress_entry(self):
835
"""Emit an update to the progress bar and increment the entry count."""
836
self.pb_entries_count += 1
837
self._emit_progress()
839
def _emit_progress(self):
840
if self.pb_entries_title:
841
if self.pb_entries_total == '?':
842
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
843
self.pb_entries_title, self.pb_entries_count)
845
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
846
self.pb_entries_title, self.pb_entries_count,
847
str(self.pb_entries_total))
849
text = "%s - Stage" % (self.pb_stage_name)
850
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
