1
# Copyright (C) 2005, 2006, 2007, 2008 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 tree. 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 tree, 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
66
from bzrlib.branch import Branch
68
from bzrlib.errors import (BzrError, PointlessCommit,
72
from bzrlib.osutils import (get_user_encoding,
73
kind_marker, isdir,isfile, is_inside_any,
74
is_inside_or_parent_of_any,
75
minimum_path_selection,
76
quotefn, sha_file, split_lines,
79
from bzrlib.testament import Testament
80
from bzrlib.trace import mutter, note, warning, is_quiet
81
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
82
from bzrlib import symbol_versioning
83
from bzrlib.symbol_versioning import (deprecated_passed,
86
from bzrlib.workingtree import WorkingTree
87
from bzrlib.urlutils import unescape_for_display
91
class NullCommitReporter(object):
92
"""I report on progress of a commit."""
94
def started(self, revno, revid, location=None):
96
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
97
"to started.", DeprecationWarning,
101
def snapshot_change(self, change, path):
104
def completed(self, revno, rev_id):
107
def deleted(self, file_id):
110
def escaped(self, escape_count, message):
113
def missing(self, path):
116
def renamed(self, change, old_path, new_path):
119
def is_verbose(self):
123
class ReportCommitToLog(NullCommitReporter):
125
def _note(self, format, *args):
128
Subclasses may choose to override this method.
132
def snapshot_change(self, change, path):
133
if change == 'unchanged':
135
if change == 'added' and path == '':
137
self._note("%s %s", change, path)
139
def started(self, revno, rev_id, location=None):
140
if location is not None:
141
location = ' to: ' + unescape_for_display(location, 'utf-8')
143
# When started was added, location was only made optional by
144
# accident. Matt Nordhoff 20071129
145
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
146
"to started.", DeprecationWarning,
149
self._note('Committing%s', location)
151
def completed(self, revno, rev_id):
152
self._note('Committed revision %d.', revno)
154
def deleted(self, file_id):
155
self._note('deleted %s', file_id)
157
def escaped(self, escape_count, message):
158
self._note("replaced %d control characters in message", escape_count)
160
def missing(self, path):
161
self._note('missing %s', path)
163
def renamed(self, change, old_path, new_path):
164
self._note('%s %s => %s', change, old_path, new_path)
166
def is_verbose(self):
170
class Commit(object):
171
"""Task of committing a new revision.
173
This is a MethodObject: it accumulates state as the commit is
174
prepared, and then it is discarded. It doesn't represent
175
historical revisions, just the act of recording a new one.
178
Modified to hold a list of files that have been deleted from
179
the working directory; these should be removed from the
185
"""Create a Commit object.
187
:param reporter: the default reporter to use or None to decide later
189
self.reporter = reporter
199
allow_pointless=True,
207
message_callback=None,
210
possible_master_transports=None):
211
"""Commit working copy as a new revision.
213
:param message: the commit message (it or message_callback is required)
215
:param timestamp: if not None, seconds-since-epoch for a
216
postdated/predated commit.
218
:param specific_files: If true, commit only those files.
220
:param rev_id: If set, use this as the new revision id.
221
Useful for test or import commands that need to tightly
222
control what revisions are assigned. If you duplicate
223
a revision id that exists elsewhere it is your own fault.
224
If null (default), a time/random revision id is generated.
226
:param allow_pointless: If true (default), commit even if nothing
227
has changed and no merges are recorded.
229
:param strict: If true, don't allow a commit if the working tree
230
contains unknown files.
232
:param revprops: Properties for new revision
233
:param local: Perform a local only commit.
234
:param reporter: the reporter to use or None for the default
235
:param verbose: if True and the reporter is not None, report everything
236
:param recursive: If set to 'down', commit in any subtrees that have
237
pending changes of any sort during this commit.
238
:param exclude: None or a list of relative paths to exclude from the
239
commit. Pending changes to excluded files will be ignored by the
242
mutter('preparing to commit')
244
if working_tree is None:
245
raise BzrError("working_tree must be passed into commit().")
247
self.work_tree = working_tree
248
self.branch = self.work_tree.branch
249
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
250
if not self.branch.repository.supports_rich_root():
251
raise errors.RootNotRich()
252
if message_callback is None:
253
if message is not None:
254
if isinstance(message, str):
255
message = message.decode(get_user_encoding())
256
message_callback = lambda x: message
258
raise BzrError("The message or message_callback keyword"
259
" parameter is required for commit().")
261
self.bound_branch = None
262
self.any_entries_changed = False
263
self.any_entries_deleted = False
264
if exclude is not None:
265
self.exclude = sorted(
266
minimum_path_selection(exclude))
270
self.master_branch = None
271
self.master_locked = False
272
self.recursive = recursive
274
if specific_files is not None:
275
self.specific_files = sorted(
276
minimum_path_selection(specific_files))
278
self.specific_files = None
279
self.specific_file_ids = None
280
self.allow_pointless = allow_pointless
281
self.revprops = revprops
282
self.message_callback = message_callback
283
self.timestamp = timestamp
284
self.timezone = timezone
285
self.committer = committer
287
self.verbose = verbose
288
# accumulates an inventory delta to the basis entry, so we can make
289
# just the necessary updates to the workingtree's cached basis.
290
self._basis_delta = []
292
self.work_tree.lock_write()
293
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
294
self.basis_revid = self.work_tree.last_revision()
295
self.basis_tree = self.work_tree.basis_tree()
296
self.basis_tree.lock_read()
298
# Cannot commit with conflicts present.
299
if len(self.work_tree.conflicts()) > 0:
300
raise ConflictsInTree
302
# Setup the bound branch variables as needed.
303
self._check_bound_branch(possible_master_transports)
305
# Check that the working tree is up to date
306
old_revno, new_revno = self._check_out_of_date_tree()
308
# Complete configuration setup
309
if reporter is not None:
310
self.reporter = reporter
311
elif self.reporter is None:
312
self.reporter = self._select_reporter()
313
if self.config is None:
314
self.config = self.branch.get_config()
316
# If provided, ensure the specified files are versioned
317
if self.specific_files is not None:
318
# Note: This routine is being called because it raises
319
# PathNotVersionedError as a side effect of finding the IDs. We
320
# later use the ids we found as input to the working tree
321
# inventory iterator, so we only consider those ids rather than
322
# examining the whole tree again.
323
# XXX: Dont we have filter_unversioned to do this more
325
self.specific_file_ids = tree.find_ids_across_trees(
326
specific_files, [self.basis_tree, self.work_tree])
328
# Setup the progress bar. As the number of files that need to be
329
# committed in unknown, progress is reported as stages.
330
# We keep track of entries separately though and include that
331
# information in the progress bar during the relevant stages.
332
self.pb_stage_name = ""
333
self.pb_stage_count = 0
334
self.pb_stage_total = 5
335
if self.bound_branch:
336
self.pb_stage_total += 1
337
self.pb.show_pct = False
338
self.pb.show_spinner = False
339
self.pb.show_eta = False
340
self.pb.show_count = True
341
self.pb.show_bar = True
343
self.basis_inv = self.basis_tree.inventory
344
self._gather_parents()
345
# After a merge, a selected file commit is not supported.
346
# See 'bzr help merge' for an explanation as to why.
347
if len(self.parents) > 1 and self.specific_files:
348
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
349
# Excludes are a form of selected file commit.
350
if len(self.parents) > 1 and self.exclude:
351
raise errors.CannotCommitSelectedFileMerge(self.exclude)
353
# Collect the changes
354
self._set_progress_stage("Collecting changes",
355
entries_title="Directory")
356
self.builder = self.branch.get_commit_builder(self.parents,
357
self.config, timestamp, timezone, committer, revprops, rev_id)
360
# find the location being committed to
361
if self.bound_branch:
362
master_location = self.master_branch.base
364
master_location = self.branch.base
366
# report the start of the commit
367
self.reporter.started(new_revno, self.rev_id, master_location)
369
self._update_builder_with_changes()
370
self._report_and_accumulate_deletes()
371
self._check_pointless()
373
# TODO: Now the new inventory is known, check for conflicts.
374
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
375
# weave lines, because nothing should be recorded until it is known
376
# that commit will succeed.
377
self._set_progress_stage("Saving data locally")
378
self.builder.finish_inventory()
380
# Prompt the user for a commit message if none provided
381
message = message_callback(self)
382
self.message = message
383
self._escape_commit_message()
385
# Add revision data to the local branch
386
self.rev_id = self.builder.commit(self.message)
389
mutter("aborting commit write group because of exception:")
390
trace.log_exception_quietly()
391
note("aborting commit write group: %r" % (e,))
395
self._process_pre_hooks(old_revno, new_revno)
397
# Upload revision data to the master.
398
# this will propagate merged revisions too if needed.
399
if self.bound_branch:
400
if not self.master_branch.repository.has_same_location(
401
self.branch.repository):
402
self._set_progress_stage("Uploading data to master branch")
403
self.master_branch.repository.fetch(self.branch.repository,
404
revision_id=self.rev_id)
405
# now the master has the revision data
406
# 'commit' to the master first so a timeout here causes the
407
# local branch to be out of date
408
self.master_branch.set_last_revision_info(new_revno,
411
# and now do the commit locally.
412
self.branch.set_last_revision_info(new_revno, self.rev_id)
414
# Make the working tree up to date with the branch
415
self._set_progress_stage("Updating the working tree")
416
self.work_tree.update_basis_by_delta(self.rev_id,
418
self.reporter.completed(new_revno, self.rev_id)
419
self._process_post_hooks(old_revno, new_revno)
424
def _select_reporter(self):
425
"""Select the CommitReporter to use."""
427
return NullCommitReporter()
428
return ReportCommitToLog()
430
def _check_pointless(self):
431
if self.allow_pointless:
433
# A merge with no effect on files
434
if len(self.parents) > 1:
436
# TODO: we could simplify this by using self._basis_delta.
438
# The initial commit adds a root directory, but this in itself is not
439
# a worthwhile commit.
440
if (self.basis_revid == revision.NULL_REVISION and
441
len(self.builder.new_inventory) == 1):
442
raise PointlessCommit()
443
# If length == 1, then we only have the root entry. Which means
444
# that there is no real difference (only the root could be different)
445
# unless deletes occured, in which case the length is irrelevant.
446
if (self.any_entries_deleted or
447
(len(self.builder.new_inventory) != 1 and
448
self.any_entries_changed)):
450
raise PointlessCommit()
452
def _check_bound_branch(self, possible_master_transports=None):
453
"""Check to see if the local branch is bound.
455
If it is bound, then most of the commit will actually be
456
done using the remote branch as the target branch.
457
Only at the end will the local branch be updated.
459
if self.local and not self.branch.get_bound_location():
460
raise errors.LocalRequiresBoundBranch()
463
self.master_branch = self.branch.get_master_branch(
464
possible_master_transports)
466
if not self.master_branch:
467
# make this branch the reference branch for out of date checks.
468
self.master_branch = self.branch
471
# If the master branch is bound, we must fail
472
master_bound_location = self.master_branch.get_bound_location()
473
if master_bound_location:
474
raise errors.CommitToDoubleBoundBranch(self.branch,
475
self.master_branch, master_bound_location)
477
# TODO: jam 20051230 We could automatically push local
478
# commits to the remote branch if they would fit.
479
# But for now, just require remote to be identical
482
# Make sure the local branch is identical to the master
483
master_info = self.master_branch.last_revision_info()
484
local_info = self.branch.last_revision_info()
485
if local_info != master_info:
486
raise errors.BoundBranchOutOfDate(self.branch,
489
# Now things are ready to change the master branch
491
self.bound_branch = self.branch
492
self.master_branch.lock_write()
493
self.master_locked = True
495
def _check_out_of_date_tree(self):
496
"""Check that the working tree is up to date.
498
:return: old_revision_number,new_revision_number tuple
501
first_tree_parent = self.work_tree.get_parent_ids()[0]
503
# if there are no parents, treat our parent as 'None'
504
# this is so that we still consider the master branch
505
# - in a checkout scenario the tree may have no
506
# parents but the branch may do.
507
first_tree_parent = bzrlib.revision.NULL_REVISION
508
old_revno, master_last = self.master_branch.last_revision_info()
509
if master_last != first_tree_parent:
510
if master_last != bzrlib.revision.NULL_REVISION:
511
raise errors.OutOfDateTree(self.work_tree)
512
if self.branch.repository.has_revision(first_tree_parent):
513
new_revno = old_revno + 1
515
# ghost parents never appear in revision history.
517
return old_revno,new_revno
519
def _process_pre_hooks(self, old_revno, new_revno):
520
"""Process any registered pre commit hooks."""
521
self._set_progress_stage("Running pre_commit hooks")
522
self._process_hooks("pre_commit", old_revno, new_revno)
524
def _process_post_hooks(self, old_revno, new_revno):
525
"""Process any registered post commit hooks."""
526
# Process the post commit hooks, if any
527
self._set_progress_stage("Running post_commit hooks")
528
# old style commit hooks - should be deprecated ? (obsoleted in
530
if self.config.post_commit() is not None:
531
hooks = self.config.post_commit().split(' ')
532
# this would be nicer with twisted.python.reflect.namedAny
534
result = eval(hook + '(branch, rev_id)',
535
{'branch':self.branch,
537
'rev_id':self.rev_id})
538
# process new style post commit hooks
539
self._process_hooks("post_commit", old_revno, new_revno)
541
def _process_hooks(self, hook_name, old_revno, new_revno):
542
if not Branch.hooks[hook_name]:
545
# new style commit hooks:
546
if not self.bound_branch:
547
hook_master = self.branch
550
hook_master = self.master_branch
551
hook_local = self.branch
552
# With bound branches, when the master is behind the local branch,
553
# the 'old_revno' and old_revid values here are incorrect.
554
# XXX: FIXME ^. RBC 20060206
556
old_revid = self.parents[0]
558
old_revid = bzrlib.revision.NULL_REVISION
560
if hook_name == "pre_commit":
561
future_tree = self.builder.revision_tree()
562
tree_delta = future_tree.changes_from(self.basis_tree,
565
for hook in Branch.hooks[hook_name]:
566
# show the running hook in the progress bar. As hooks may
567
# end up doing nothing (e.g. because they are not configured by
568
# the user) this is still showing progress, not showing overall
569
# actions - its up to each plugin to show a UI if it want's to
570
# (such as 'Emailing diff to foo@example.com').
571
self.pb_stage_name = "Running %s hooks [%s]" % \
572
(hook_name, Branch.hooks.get_hook_name(hook))
573
self._emit_progress()
574
if 'hooks' in debug.debug_flags:
575
mutter("Invoking commit hook: %r", hook)
576
if hook_name == "post_commit":
577
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
579
elif hook_name == "pre_commit":
580
hook(hook_local, hook_master,
581
old_revno, old_revid, new_revno, self.rev_id,
582
tree_delta, future_tree)
585
"""Cleanup any open locks, progress bars etc."""
586
cleanups = [self._cleanup_bound_branch,
587
self.basis_tree.unlock,
588
self.work_tree.unlock,
590
found_exception = None
591
for cleanup in cleanups:
594
# we want every cleanup to run no matter what.
595
# so we have a catchall here, but we will raise the
596
# last encountered exception up the stack: and
597
# typically this will be useful enough.
600
if found_exception is not None:
601
# don't do a plan raise, because the last exception may have been
602
# trashed, e is our sure-to-work exception even though it loses the
603
# full traceback. XXX: RBC 20060421 perhaps we could check the
604
# exc_info and if its the same one do a plain raise otherwise
605
# 'raise e' as we do now.
608
def _cleanup_bound_branch(self):
609
"""Executed at the end of a try/finally to cleanup a bound branch.
611
If the branch wasn't bound, this is a no-op.
612
If it was, it resents self.branch to the local branch, instead
615
if not self.bound_branch:
617
if self.master_locked:
618
self.master_branch.unlock()
620
def _escape_commit_message(self):
621
"""Replace xml-incompatible control characters."""
622
# FIXME: RBC 20060419 this should be done by the revision
623
# serialiser not by commit. Then we can also add an unescaper
624
# in the deserializer and start roundtripping revision messages
625
# precisely. See repository_implementations/test_repository.py
627
# Python strings can include characters that can't be
628
# represented in well-formed XML; escape characters that
629
# aren't listed in the XML specification
630
# (http://www.w3.org/TR/REC-xml/#NT-Char).
631
self.message, escape_count = re.subn(
632
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
633
lambda match: match.group(0).encode('unicode_escape'),
636
self.reporter.escaped(escape_count, self.message)
638
def _gather_parents(self):
639
"""Record the parents of a merge for merge detection."""
640
# TODO: Make sure that this list doesn't contain duplicate
641
# entries and the order is preserved when doing this.
642
self.parents = self.work_tree.get_parent_ids()
643
self.parent_invs = [self.basis_inv]
644
for revision in self.parents[1:]:
645
if self.branch.repository.has_revision(revision):
646
mutter('commit parent revision {%s}', revision)
647
inventory = self.branch.repository.get_inventory(revision)
648
self.parent_invs.append(inventory)
650
mutter('commit parent ghost revision {%s}', revision)
652
def _update_builder_with_changes(self):
653
"""Update the commit builder with the data about what has changed.
655
# Build the revision inventory.
657
# This starts by creating a new empty inventory. Depending on
658
# which files are selected for commit, and what is present in the
659
# current tree, the new inventory is populated. inventory entries
660
# which are candidates for modification have their revision set to
661
# None; inventory entries that are carried over untouched have their
662
# revision set to their prior value.
664
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
665
# results to create a new inventory at the same time, which results
666
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
669
exclude = self.exclude
670
specific_files = self.specific_files or []
671
mutter("Selecting files for commit with filter %s", specific_files)
673
# Build the new inventory
674
self._populate_from_inventory()
676
# If specific files are selected, then all un-selected files must be
677
# recorded in their previous state. For more details, see
678
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
679
if specific_files or exclude:
680
for path, old_ie in self.basis_inv.iter_entries():
681
if old_ie.file_id in self.builder.new_inventory:
682
# already added - skip.
684
if (is_inside_any(specific_files, path)
685
and not is_inside_any(exclude, path)):
686
# was inside the selected path, and not excluded - if not
687
# present it has been deleted so skip.
689
# From here down it was either not selected, or was excluded:
690
if old_ie.kind == 'directory':
691
self._next_progress_entry()
692
# We preserve the entry unaltered.
694
# Note: specific file commits after a merge are currently
695
# prohibited. This test is for sanity/safety in case it's
696
# required after that changes.
697
if len(self.parents) > 1:
699
delta, version_recorded, _ = self.builder.record_entry_contents(
700
ie, self.parent_invs, path, self.basis_tree, None)
702
self.any_entries_changed = True
704
self._basis_delta.append(delta)
706
def _report_and_accumulate_deletes(self):
707
# XXX: Could the list of deleted paths and ids be instead taken from
708
# _populate_from_inventory?
709
if (isinstance(self.basis_inv, Inventory)
710
and isinstance(self.builder.new_inventory, Inventory)):
711
# the older Inventory classes provide a _byid dict, and building a
712
# set from the keys of this dict is substantially faster than even
713
# getting a set of ids from the inventory
715
# <lifeless> set(dict) is roughly the same speed as
716
# set(iter(dict)) and both are significantly slower than
718
deleted_ids = set(self.basis_inv._byid.keys()) - \
719
set(self.builder.new_inventory._byid.keys())
721
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
723
self.any_entries_deleted = True
724
deleted = [(self.basis_tree.id2path(file_id), file_id)
725
for file_id in deleted_ids]
727
# XXX: this is not quite directory-order sorting
728
for path, file_id in deleted:
729
self._basis_delta.append((path, None, file_id, None))
730
self.reporter.deleted(path)
732
def _populate_from_inventory(self):
733
"""Populate the CommitBuilder by walking the working tree inventory."""
735
# raise an exception as soon as we find a single unknown.
736
for unknown in self.work_tree.unknowns():
737
raise StrictCommitFailed()
739
specific_files = self.specific_files
740
exclude = self.exclude
741
report_changes = self.reporter.is_verbose()
743
# A tree of paths that have been deleted. E.g. if foo/bar has been
744
# deleted, then we have {'foo':{'bar':{}}}
746
# XXX: Note that entries may have the wrong kind because the entry does
747
# not reflect the status on disk.
748
work_inv = self.work_tree.inventory
749
# NB: entries will include entries within the excluded ids/paths
750
# because iter_entries_by_dir has no 'exclude' facility today.
751
entries = work_inv.iter_entries_by_dir(
752
specific_file_ids=self.specific_file_ids, yield_parents=True)
753
for path, existing_ie in entries:
754
file_id = existing_ie.file_id
755
name = existing_ie.name
756
parent_id = existing_ie.parent_id
757
kind = existing_ie.kind
758
if kind == 'directory':
759
self._next_progress_entry()
760
# Skip files that have been deleted from the working tree.
761
# The deleted path ids are also recorded so they can be explicitly
764
path_segments = splitpath(path)
765
deleted_dict = deleted_paths
766
for segment in path_segments:
767
deleted_dict = deleted_dict.get(segment, None)
769
# We either took a path not present in the dict
770
# (deleted_dict was None), or we've reached an empty
771
# child dir in the dict, so are now a sub-path.
775
if deleted_dict is not None:
776
# the path has a deleted parent, do not add it.
778
if exclude and is_inside_any(exclude, path):
779
# Skip excluded paths. Excluded paths are processed by
780
# _update_builder_with_changes.
782
content_summary = self.work_tree.path_content_summary(path)
783
# Note that when a filter of specific files is given, we must only
784
# skip/record deleted files matching that filter.
785
if not specific_files or is_inside_any(specific_files, path):
786
if content_summary[0] == 'missing':
787
if not deleted_paths:
788
# path won't have been split yet.
789
path_segments = splitpath(path)
790
deleted_dict = deleted_paths
791
for segment in path_segments:
792
deleted_dict = deleted_dict.setdefault(segment, {})
793
self.reporter.missing(path)
794
deleted_ids.append(file_id)
796
# TODO: have the builder do the nested commit just-in-time IF and
798
if content_summary[0] == 'tree-reference':
799
# enforce repository nested tree policy.
800
if (not self.work_tree.supports_tree_reference() or
801
# repository does not support it either.
802
not self.branch.repository._format.supports_tree_reference):
803
content_summary = ('directory',) + content_summary[1:]
804
kind = content_summary[0]
805
# TODO: specific_files filtering before nested tree processing
806
if kind == 'tree-reference':
807
if self.recursive == 'down':
808
nested_revision_id = self._commit_nested_tree(
810
content_summary = content_summary[:3] + (
813
content_summary = content_summary[:3] + (
814
self.work_tree.get_reference_revision(file_id),)
816
# Record an entry for this item
817
# Note: I don't particularly want to have the existing_ie
818
# parameter but the test suite currently (28-Jun-07) breaks
819
# without it thanks to a unicode normalisation issue. :-(
820
definitely_changed = kind != existing_ie.kind
821
self._record_entry(path, file_id, specific_files, kind, name,
822
parent_id, definitely_changed, existing_ie, report_changes,
825
# Unversion IDs that were found to be deleted
826
self.work_tree.unversion(deleted_ids)
828
def _commit_nested_tree(self, file_id, path):
829
"Commit a nested tree."
830
sub_tree = self.work_tree.get_nested_tree(file_id, path)
831
# FIXME: be more comprehensive here:
832
# this works when both trees are in --trees repository,
833
# but when both are bound to a different repository,
834
# it fails; a better way of approaching this is to
835
# finally implement the explicit-caches approach design
836
# a while back - RBC 20070306.
837
if sub_tree.branch.repository.has_same_location(
838
self.work_tree.branch.repository):
839
sub_tree.branch.repository = \
840
self.work_tree.branch.repository
842
return sub_tree.commit(message=None, revprops=self.revprops,
843
recursive=self.recursive,
844
message_callback=self.message_callback,
845
timestamp=self.timestamp, timezone=self.timezone,
846
committer=self.committer,
847
allow_pointless=self.allow_pointless,
848
strict=self.strict, verbose=self.verbose,
849
local=self.local, reporter=self.reporter)
850
except errors.PointlessCommit:
851
return self.work_tree.get_reference_revision(file_id)
853
def _record_entry(self, path, file_id, specific_files, kind, name,
854
parent_id, definitely_changed, existing_ie, report_changes,
856
"Record the new inventory entry for a path if any."
857
# mutter('check %s {%s}', path, file_id)
858
# mutter('%s selected for commit', path)
859
if definitely_changed or existing_ie is None:
860
ie = make_entry(kind, name, parent_id, file_id)
862
ie = existing_ie.copy()
864
# For carried over entries we don't care about the fs hash - the repo
865
# isn't generating a sha, so we're not saving computation time.
866
delta, version_recorded, fs_hash = self.builder.record_entry_contents(
867
ie, self.parent_invs, path, self.work_tree, content_summary)
869
self._basis_delta.append(delta)
871
self.any_entries_changed = True
873
self._report_change(ie, path)
875
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
878
def _report_change(self, ie, path):
879
"""Report a change to the user.
881
The change that has occurred is described relative to the basis
884
if (self.basis_inv.has_id(ie.file_id)):
885
basis_ie = self.basis_inv[ie.file_id]
888
change = ie.describe_change(basis_ie, ie)
889
if change in (InventoryEntry.RENAMED,
890
InventoryEntry.MODIFIED_AND_RENAMED):
891
old_path = self.basis_inv.id2path(ie.file_id)
892
self.reporter.renamed(change, old_path, path)
894
self.reporter.snapshot_change(change, path)
896
def _set_progress_stage(self, name, entries_title=None):
897
"""Set the progress stage and emit an update to the progress bar."""
898
self.pb_stage_name = name
899
self.pb_stage_count += 1
900
self.pb_entries_title = entries_title
901
if entries_title is not None:
902
self.pb_entries_count = 0
903
self.pb_entries_total = '?'
904
self._emit_progress()
906
def _next_progress_entry(self):
907
"""Emit an update to the progress bar and increment the entry count."""
908
self.pb_entries_count += 1
909
self._emit_progress()
911
def _emit_progress(self):
912
if self.pb_entries_title:
913
if self.pb_entries_total == '?':
914
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
915
self.pb_entries_title, self.pb_entries_count)
917
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
918
self.pb_entries_title, self.pb_entries_count,
919
str(self.pb_entries_total))
921
text = "%s - Stage" % (self.pb_stage_name)
922
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
