1
# Copyright (C) 2005-2010 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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.
59
from bzrlib.branch import Branch
60
from bzrlib.cleanup import OperationWithCleanups
62
from bzrlib.errors import (BzrError, PointlessCommit,
66
from bzrlib.osutils import (get_user_encoding,
68
minimum_path_selection,
71
from bzrlib.trace import mutter, note, is_quiet
72
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
73
from bzrlib import symbol_versioning
74
from bzrlib.urlutils import unescape_for_display
78
class NullCommitReporter(object):
79
"""I report on progress of a commit."""
81
def started(self, revno, revid, location=None):
83
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
84
"to started.", DeprecationWarning,
88
def snapshot_change(self, change, path):
91
def completed(self, revno, rev_id):
94
def deleted(self, path):
97
def missing(self, path):
100
def renamed(self, change, old_path, new_path):
103
def is_verbose(self):
107
class ReportCommitToLog(NullCommitReporter):
109
def _note(self, format, *args):
112
Subclasses may choose to override this method.
116
def snapshot_change(self, change, path):
117
if path == '' and change in ('added', 'modified'):
119
self._note("%s %s", change, path)
121
def started(self, revno, rev_id, location=None):
122
if location is not None:
123
location = ' to: ' + unescape_for_display(location, 'utf-8')
125
# When started was added, location was only made optional by
126
# accident. Matt Nordhoff 20071129
127
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
128
"to started.", DeprecationWarning,
131
self._note('Committing%s', location)
133
def completed(self, revno, rev_id):
134
self._note('Committed revision %d.', revno)
136
def deleted(self, path):
137
self._note('deleted %s', path)
139
def missing(self, path):
140
self._note('missing %s', path)
142
def renamed(self, change, old_path, new_path):
143
self._note('%s %s => %s', change, old_path, new_path)
145
def is_verbose(self):
149
class Commit(object):
150
"""Task of committing a new revision.
152
This is a MethodObject: it accumulates state as the commit is
153
prepared, and then it is discarded. It doesn't represent
154
historical revisions, just the act of recording a new one.
157
Modified to hold a list of files that have been deleted from
158
the working directory; these should be removed from the
164
"""Create a Commit object.
166
:param reporter: the default reporter to use or None to decide later
168
self.reporter = reporter
178
allow_pointless=True,
186
message_callback=None,
189
possible_master_transports=None):
190
"""Commit working copy as a new revision.
192
:param message: the commit message (it or message_callback is required)
193
:param message_callback: A callback: message = message_callback(cmt_obj)
195
:param timestamp: if not None, seconds-since-epoch for a
196
postdated/predated commit.
198
:param specific_files: If not None, commit only those files. An empty
199
list means 'commit no files'.
201
:param rev_id: If set, use this as the new revision id.
202
Useful for test or import commands that need to tightly
203
control what revisions are assigned. If you duplicate
204
a revision id that exists elsewhere it is your own fault.
205
If null (default), a time/random revision id is generated.
207
:param allow_pointless: If true (default), commit even if nothing
208
has changed and no merges are recorded.
210
:param strict: If true, don't allow a commit if the working tree
211
contains unknown files.
213
:param revprops: Properties for new revision
214
:param local: Perform a local only commit.
215
:param reporter: the reporter to use or None for the default
216
:param verbose: if True and the reporter is not None, report everything
217
:param recursive: If set to 'down', commit in any subtrees that have
218
pending changes of any sort during this commit.
219
:param exclude: None or a list of relative paths to exclude from the
220
commit. Pending changes to excluded files will be ignored by the
223
operation = OperationWithCleanups(self._commit)
224
return operation.run(
229
specific_files=specific_files,
231
allow_pointless=allow_pointless,
235
working_tree=working_tree,
239
message_callback=message_callback,
242
possible_master_transports=possible_master_transports)
244
def _commit(self, operation, message, timestamp, timezone, committer,
245
specific_files, rev_id, allow_pointless, strict, verbose, revprops,
246
working_tree, local, reporter, config, message_callback, recursive,
247
exclude, possible_master_transports):
248
mutter('preparing to commit')
250
if working_tree is None:
251
raise BzrError("working_tree must be passed into commit().")
253
self.work_tree = working_tree
254
self.branch = self.work_tree.branch
255
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
256
if not self.branch.repository.supports_rich_root():
257
raise errors.RootNotRich()
258
if message_callback is None:
259
if message is not None:
260
if isinstance(message, str):
261
message = message.decode(get_user_encoding())
262
message_callback = lambda x: message
264
raise BzrError("The message or message_callback keyword"
265
" parameter is required for commit().")
267
self.bound_branch = None
268
self.any_entries_deleted = False
269
if exclude is not None:
270
self.exclude = sorted(
271
minimum_path_selection(exclude))
275
self.master_branch = None
276
self.recursive = recursive
278
# self.specific_files is None to indicate no filter, or any iterable to
279
# indicate a filter - [] means no files at all, as per iter_changes.
280
if specific_files is not None:
281
self.specific_files = sorted(
282
minimum_path_selection(specific_files))
284
self.specific_files = None
286
self.allow_pointless = allow_pointless
287
self.revprops = revprops
288
self.message_callback = message_callback
289
self.timestamp = timestamp
290
self.timezone = timezone
291
self.committer = committer
293
self.verbose = verbose
295
self.work_tree.lock_write()
296
operation.add_cleanup(self.work_tree.unlock)
297
self.parents = self.work_tree.get_parent_ids()
298
# We can use record_iter_changes IFF iter_changes is compatible with
299
# the command line parameters, and the repository has fast delta
300
# generation. See bug 347649.
301
self.use_record_iter_changes = (
303
not self.branch.repository._format.supports_tree_reference and
304
(self.branch.repository._format.fast_deltas or
305
len(self.parents) < 2))
306
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
307
operation.add_cleanup(self.pb.finished)
308
self.basis_revid = self.work_tree.last_revision()
309
self.basis_tree = self.work_tree.basis_tree()
310
self.basis_tree.lock_read()
311
operation.add_cleanup(self.basis_tree.unlock)
312
# Cannot commit with conflicts present.
313
if len(self.work_tree.conflicts()) > 0:
314
raise ConflictsInTree
316
# Setup the bound branch variables as needed.
317
self._check_bound_branch(operation, possible_master_transports)
319
# Check that the working tree is up to date
320
old_revno, new_revno = self._check_out_of_date_tree()
322
# Complete configuration setup
323
if reporter is not None:
324
self.reporter = reporter
325
elif self.reporter is None:
326
self.reporter = self._select_reporter()
327
if self.config is None:
328
self.config = self.branch.get_config()
330
self._set_specific_file_ids()
332
# Setup the progress bar. As the number of files that need to be
333
# committed in unknown, progress is reported as stages.
334
# We keep track of entries separately though and include that
335
# information in the progress bar during the relevant stages.
336
self.pb_stage_name = ""
337
self.pb_stage_count = 0
338
self.pb_stage_total = 5
339
if self.bound_branch:
340
self.pb_stage_total += 1
341
self.pb.show_pct = False
342
self.pb.show_spinner = False
343
self.pb.show_eta = False
344
self.pb.show_count = True
345
self.pb.show_bar = True
347
self._gather_parents()
348
# After a merge, a selected file commit is not supported.
349
# See 'bzr help merge' for an explanation as to why.
350
if len(self.parents) > 1 and self.specific_files is not None:
351
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
352
# Excludes are a form of selected file commit.
353
if len(self.parents) > 1 and self.exclude:
354
raise errors.CannotCommitSelectedFileMerge(self.exclude)
356
# Collect the changes
357
self._set_progress_stage("Collecting changes", counter=True)
358
self.builder = self.branch.get_commit_builder(self.parents,
359
self.config, timestamp, timezone, committer, revprops, rev_id)
362
self.builder.will_record_deletes()
363
# find the location being committed to
364
if self.bound_branch:
365
master_location = self.master_branch.base
367
master_location = self.branch.base
369
# report the start of the commit
370
self.reporter.started(new_revno, self.rev_id, master_location)
372
self._update_builder_with_changes()
373
self._check_pointless()
375
# TODO: Now the new inventory is known, check for conflicts.
376
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
377
# weave lines, because nothing should be recorded until it is known
378
# that commit will succeed.
379
self._set_progress_stage("Saving data locally")
380
self.builder.finish_inventory()
382
# Prompt the user for a commit message if none provided
383
message = message_callback(self)
384
self.message = message
386
# Add revision data to the local branch
387
self.rev_id = self.builder.commit(self.message)
390
mutter("aborting commit write group because of exception:")
391
trace.log_exception_quietly()
392
note("aborting commit write group: %r" % (e,))
396
self._process_pre_hooks(old_revno, new_revno)
398
# Upload revision data to the master.
399
# this will propagate merged revisions too if needed.
400
if self.bound_branch:
401
self._set_progress_stage("Uploading data to master branch")
402
# 'commit' to the master first so a timeout here causes the
403
# local branch to be out of date
404
self.master_branch.import_last_revision_info(
405
self.branch.repository, new_revno, self.rev_id)
407
# and now do the commit locally.
408
self.branch.set_last_revision_info(new_revno, self.rev_id)
410
# Make the working tree be up to date with the branch. This
411
# includes automatic changes scheduled to be made to the tree, such
412
# as updating its basis and unversioning paths that were missing.
413
self.work_tree.unversion(self.deleted_ids)
414
self._set_progress_stage("Updating the working tree")
415
self.work_tree.update_basis_by_delta(self.rev_id,
416
self.builder.get_basis_delta())
417
self.reporter.completed(new_revno, self.rev_id)
418
self._process_post_hooks(old_revno, new_revno)
421
def _select_reporter(self):
422
"""Select the CommitReporter to use."""
424
return NullCommitReporter()
425
return ReportCommitToLog()
427
def _check_pointless(self):
428
if self.allow_pointless:
430
# A merge with no effect on files
431
if len(self.parents) > 1:
433
# TODO: we could simplify this by using self.builder.basis_delta.
435
# The initial commit adds a root directory, but this in itself is not
436
# a worthwhile commit.
437
if (self.basis_revid == revision.NULL_REVISION and
438
((self.builder.new_inventory is not None and
439
len(self.builder.new_inventory) == 1) or
440
len(self.builder._basis_delta) == 1)):
441
raise PointlessCommit()
442
if self.builder.any_changes():
444
raise PointlessCommit()
446
def _check_bound_branch(self, operation, possible_master_transports=None):
447
"""Check to see if the local branch is bound.
449
If it is bound, then most of the commit will actually be
450
done using the remote branch as the target branch.
451
Only at the end will the local branch be updated.
453
if self.local and not self.branch.get_bound_location():
454
raise errors.LocalRequiresBoundBranch()
457
self.master_branch = self.branch.get_master_branch(
458
possible_master_transports)
460
if not self.master_branch:
461
# make this branch the reference branch for out of date checks.
462
self.master_branch = self.branch
465
# If the master branch is bound, we must fail
466
master_bound_location = self.master_branch.get_bound_location()
467
if master_bound_location:
468
raise errors.CommitToDoubleBoundBranch(self.branch,
469
self.master_branch, master_bound_location)
471
# TODO: jam 20051230 We could automatically push local
472
# commits to the remote branch if they would fit.
473
# But for now, just require remote to be identical
476
# Make sure the local branch is identical to the master
477
master_info = self.master_branch.last_revision_info()
478
local_info = self.branch.last_revision_info()
479
if local_info != master_info:
480
raise errors.BoundBranchOutOfDate(self.branch,
483
# Now things are ready to change the master branch
485
self.bound_branch = self.branch
486
self.master_branch.lock_write()
487
operation.add_cleanup(self.master_branch.unlock)
489
def _check_out_of_date_tree(self):
490
"""Check that the working tree is up to date.
492
:return: old_revision_number,new_revision_number tuple
495
first_tree_parent = self.work_tree.get_parent_ids()[0]
497
# if there are no parents, treat our parent as 'None'
498
# this is so that we still consider the master branch
499
# - in a checkout scenario the tree may have no
500
# parents but the branch may do.
501
first_tree_parent = bzrlib.revision.NULL_REVISION
502
old_revno, master_last = self.master_branch.last_revision_info()
503
if master_last != first_tree_parent:
504
if master_last != bzrlib.revision.NULL_REVISION:
505
raise errors.OutOfDateTree(self.work_tree)
506
if self.branch.repository.has_revision(first_tree_parent):
507
new_revno = old_revno + 1
509
# ghost parents never appear in revision history.
511
return old_revno,new_revno
513
def _process_pre_hooks(self, old_revno, new_revno):
514
"""Process any registered pre commit hooks."""
515
self._set_progress_stage("Running pre_commit hooks")
516
self._process_hooks("pre_commit", old_revno, new_revno)
518
def _process_post_hooks(self, old_revno, new_revno):
519
"""Process any registered post commit hooks."""
520
# Process the post commit hooks, if any
521
self._set_progress_stage("Running post_commit hooks")
522
# old style commit hooks - should be deprecated ? (obsoleted in
524
if self.config.post_commit() is not None:
525
hooks = self.config.post_commit().split(' ')
526
# this would be nicer with twisted.python.reflect.namedAny
528
result = eval(hook + '(branch, rev_id)',
529
{'branch':self.branch,
531
'rev_id':self.rev_id})
532
# process new style post commit hooks
533
self._process_hooks("post_commit", old_revno, new_revno)
535
def _process_hooks(self, hook_name, old_revno, new_revno):
536
if not Branch.hooks[hook_name]:
539
# new style commit hooks:
540
if not self.bound_branch:
541
hook_master = self.branch
544
hook_master = self.master_branch
545
hook_local = self.branch
546
# With bound branches, when the master is behind the local branch,
547
# the 'old_revno' and old_revid values here are incorrect.
548
# XXX: FIXME ^. RBC 20060206
550
old_revid = self.parents[0]
552
old_revid = bzrlib.revision.NULL_REVISION
554
if hook_name == "pre_commit":
555
future_tree = self.builder.revision_tree()
556
tree_delta = future_tree.changes_from(self.basis_tree,
559
for hook in Branch.hooks[hook_name]:
560
# show the running hook in the progress bar. As hooks may
561
# end up doing nothing (e.g. because they are not configured by
562
# the user) this is still showing progress, not showing overall
563
# actions - its up to each plugin to show a UI if it want's to
564
# (such as 'Emailing diff to foo@example.com').
565
self.pb_stage_name = "Running %s hooks [%s]" % \
566
(hook_name, Branch.hooks.get_hook_name(hook))
567
self._emit_progress()
568
if 'hooks' in debug.debug_flags:
569
mutter("Invoking commit hook: %r", hook)
570
if hook_name == "post_commit":
571
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
573
elif hook_name == "pre_commit":
574
hook(hook_local, hook_master,
575
old_revno, old_revid, new_revno, self.rev_id,
576
tree_delta, future_tree)
578
def _gather_parents(self):
579
"""Record the parents of a merge for merge detection."""
580
# TODO: Make sure that this list doesn't contain duplicate
581
# entries and the order is preserved when doing this.
582
if self.use_record_iter_changes:
584
self.basis_inv = self.basis_tree.inventory
585
self.parent_invs = [self.basis_inv]
586
for revision in self.parents[1:]:
587
if self.branch.repository.has_revision(revision):
588
mutter('commit parent revision {%s}', revision)
589
inventory = self.branch.repository.get_inventory(revision)
590
self.parent_invs.append(inventory)
592
mutter('commit parent ghost revision {%s}', revision)
594
def _update_builder_with_changes(self):
595
"""Update the commit builder with the data about what has changed.
597
exclude = self.exclude
598
specific_files = self.specific_files
599
mutter("Selecting files for commit with filter %s", specific_files)
602
if self.use_record_iter_changes:
603
iter_changes = self.work_tree.iter_changes(self.basis_tree,
604
specific_files=specific_files)
605
iter_changes = self._filter_iter_changes(iter_changes)
606
for file_id, path, fs_hash in self.builder.record_iter_changes(
607
self.work_tree, self.basis_revid, iter_changes):
608
self.work_tree._observed_sha1(file_id, path, fs_hash)
610
# Build the new inventory
611
self._populate_from_inventory()
612
self._record_unselected()
613
self._report_and_accumulate_deletes()
615
def _filter_iter_changes(self, iter_changes):
616
"""Process iter_changes.
618
This method reports on the changes in iter_changes to the user, and
619
converts 'missing' entries in the iter_changes iterator to 'deleted'
620
entries. 'missing' entries have their
622
:param iter_changes: An iter_changes to process.
623
:return: A generator of changes.
625
reporter = self.reporter
626
report_changes = reporter.is_verbose()
628
for change in iter_changes:
630
old_path = change[1][0]
631
new_path = change[1][1]
632
versioned = change[3][1]
634
versioned = change[3][1]
635
if kind is None and versioned:
638
reporter.missing(new_path)
639
deleted_ids.append(change[0])
640
# Reset the new path (None) and new versioned flag (False)
641
change = (change[0], (change[1][0], None), change[2],
642
(change[3][0], False)) + change[4:]
643
elif kind == 'tree-reference':
644
if self.recursive == 'down':
645
self._commit_nested_tree(change[0], change[1][1])
646
if change[3][0] or change[3][1]:
650
reporter.deleted(old_path)
651
elif old_path is None:
652
reporter.snapshot_change('added', new_path)
653
elif old_path != new_path:
654
reporter.renamed('renamed', old_path, new_path)
657
self.work_tree.branch.repository._format.rich_root_data):
658
# Don't report on changes to '' in non rich root
660
reporter.snapshot_change('modified', new_path)
661
self._next_progress_entry()
662
# Unversion IDs that were found to be deleted
663
self.deleted_ids = deleted_ids
665
def _record_unselected(self):
666
# If specific files are selected, then all un-selected files must be
667
# recorded in their previous state. For more details, see
668
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
669
if self.specific_files or self.exclude:
670
specific_files = self.specific_files or []
671
for path, old_ie in self.basis_inv.iter_entries():
672
if old_ie.file_id in self.builder.new_inventory:
673
# already added - skip.
675
if (is_inside_any(specific_files, path)
676
and not is_inside_any(self.exclude, path)):
677
# was inside the selected path, and not excluded - if not
678
# present it has been deleted so skip.
680
# From here down it was either not selected, or was excluded:
681
# We preserve the entry unaltered.
683
# Note: specific file commits after a merge are currently
684
# prohibited. This test is for sanity/safety in case it's
685
# required after that changes.
686
if len(self.parents) > 1:
688
self.builder.record_entry_contents(ie, self.parent_invs, path,
689
self.basis_tree, None)
691
def _report_and_accumulate_deletes(self):
692
if (isinstance(self.basis_inv, Inventory)
693
and isinstance(self.builder.new_inventory, Inventory)):
694
# the older Inventory classes provide a _byid dict, and building a
695
# set from the keys of this dict is substantially faster than even
696
# getting a set of ids from the inventory
698
# <lifeless> set(dict) is roughly the same speed as
699
# set(iter(dict)) and both are significantly slower than
701
deleted_ids = set(self.basis_inv._byid.keys()) - \
702
set(self.builder.new_inventory._byid.keys())
704
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
706
self.any_entries_deleted = True
707
deleted = [(self.basis_tree.id2path(file_id), file_id)
708
for file_id in deleted_ids]
710
# XXX: this is not quite directory-order sorting
711
for path, file_id in deleted:
712
self.builder.record_delete(path, file_id)
713
self.reporter.deleted(path)
715
def _check_strict(self):
716
# XXX: when we use iter_changes this would likely be faster if
717
# iter_changes would check for us (even in the presence of
720
# raise an exception as soon as we find a single unknown.
721
for unknown in self.work_tree.unknowns():
722
raise StrictCommitFailed()
724
def _populate_from_inventory(self):
725
"""Populate the CommitBuilder by walking the working tree inventory."""
726
# Build the revision inventory.
728
# This starts by creating a new empty inventory. Depending on
729
# which files are selected for commit, and what is present in the
730
# current tree, the new inventory is populated. inventory entries
731
# which are candidates for modification have their revision set to
732
# None; inventory entries that are carried over untouched have their
733
# revision set to their prior value.
735
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
736
# results to create a new inventory at the same time, which results
737
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
740
specific_files = self.specific_files
741
exclude = self.exclude
742
report_changes = self.reporter.is_verbose()
744
# A tree of paths that have been deleted. E.g. if foo/bar has been
745
# deleted, then we have {'foo':{'bar':{}}}
747
# XXX: Note that entries may have the wrong kind because the entry does
748
# not reflect the status on disk.
749
work_inv = self.work_tree.inventory
750
# NB: entries will include entries within the excluded ids/paths
751
# because iter_entries_by_dir has no 'exclude' facility today.
752
entries = work_inv.iter_entries_by_dir(
753
specific_file_ids=self.specific_file_ids, yield_parents=True)
754
for path, existing_ie in entries:
755
file_id = existing_ie.file_id
756
name = existing_ie.name
757
parent_id = existing_ie.parent_id
758
kind = existing_ie.kind
759
# Skip files that have been deleted from the working tree.
760
# The deleted path ids are also recorded so they can be explicitly
763
path_segments = splitpath(path)
764
deleted_dict = deleted_paths
765
for segment in path_segments:
766
deleted_dict = deleted_dict.get(segment, None)
768
# We either took a path not present in the dict
769
# (deleted_dict was None), or we've reached an empty
770
# child dir in the dict, so are now a sub-path.
774
if deleted_dict is not None:
775
# the path has a deleted parent, do not add it.
777
if exclude and is_inside_any(exclude, path):
778
# Skip excluded paths. Excluded paths are processed by
779
# _update_builder_with_changes.
781
content_summary = self.work_tree.path_content_summary(path)
782
kind = content_summary[0]
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 kind == '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
self._next_progress_entry()
795
deleted_ids.append(file_id)
797
# TODO: have the builder do the nested commit just-in-time IF and
799
if kind == 'tree-reference':
800
# enforce repository nested tree policy.
801
if (not self.work_tree.supports_tree_reference() or
802
# repository does not support it either.
803
not self.branch.repository._format.supports_tree_reference):
805
content_summary = (kind, None, None, None)
806
elif self.recursive == 'down':
807
nested_revision_id = self._commit_nested_tree(
809
content_summary = (kind, None, None, nested_revision_id)
811
nested_revision_id = self.work_tree.get_reference_revision(file_id)
812
content_summary = (kind, None, None, nested_revision_id)
814
# Record an entry for this item
815
# Note: I don't particularly want to have the existing_ie
816
# parameter but the test suite currently (28-Jun-07) breaks
817
# without it thanks to a unicode normalisation issue. :-(
818
definitely_changed = kind != existing_ie.kind
819
self._record_entry(path, file_id, specific_files, kind, name,
820
parent_id, definitely_changed, existing_ie, report_changes,
823
# Unversion IDs that were found to be deleted
824
self.deleted_ids = deleted_ids
826
def _commit_nested_tree(self, file_id, path):
827
"Commit a nested tree."
828
sub_tree = self.work_tree.get_nested_tree(file_id, path)
829
# FIXME: be more comprehensive here:
830
# this works when both trees are in --trees repository,
831
# but when both are bound to a different repository,
832
# it fails; a better way of approaching this is to
833
# finally implement the explicit-caches approach design
834
# a while back - RBC 20070306.
835
if sub_tree.branch.repository.has_same_location(
836
self.work_tree.branch.repository):
837
sub_tree.branch.repository = \
838
self.work_tree.branch.repository
840
return sub_tree.commit(message=None, revprops=self.revprops,
841
recursive=self.recursive,
842
message_callback=self.message_callback,
843
timestamp=self.timestamp, timezone=self.timezone,
844
committer=self.committer,
845
allow_pointless=self.allow_pointless,
846
strict=self.strict, verbose=self.verbose,
847
local=self.local, reporter=self.reporter)
848
except errors.PointlessCommit:
849
return self.work_tree.get_reference_revision(file_id)
851
def _record_entry(self, path, file_id, specific_files, kind, name,
852
parent_id, definitely_changed, existing_ie, report_changes,
854
"Record the new inventory entry for a path if any."
855
# mutter('check %s {%s}', path, file_id)
856
# mutter('%s selected for commit', path)
857
if definitely_changed or existing_ie is None:
858
ie = make_entry(kind, name, parent_id, file_id)
860
ie = existing_ie.copy()
862
# For carried over entries we don't care about the fs hash - the repo
863
# isn't generating a sha, so we're not saving computation time.
864
_, _, fs_hash = self.builder.record_entry_contents(
865
ie, self.parent_invs, path, self.work_tree, content_summary)
867
self._report_change(ie, path)
869
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
872
def _report_change(self, ie, path):
873
"""Report a change to the user.
875
The change that has occurred is described relative to the basis
878
if (self.basis_inv.has_id(ie.file_id)):
879
basis_ie = self.basis_inv[ie.file_id]
882
change = ie.describe_change(basis_ie, ie)
883
if change in (InventoryEntry.RENAMED,
884
InventoryEntry.MODIFIED_AND_RENAMED):
885
old_path = self.basis_inv.id2path(ie.file_id)
886
self.reporter.renamed(change, old_path, path)
887
self._next_progress_entry()
889
if change == 'unchanged':
891
self.reporter.snapshot_change(change, path)
892
self._next_progress_entry()
894
def _set_progress_stage(self, name, counter=False):
895
"""Set the progress stage and emit an update to the progress bar."""
896
self.pb_stage_name = name
897
self.pb_stage_count += 1
899
self.pb_entries_count = 0
901
self.pb_entries_count = None
902
self._emit_progress()
904
def _next_progress_entry(self):
905
"""Emit an update to the progress bar and increment the entry count."""
906
self.pb_entries_count += 1
907
self._emit_progress()
909
def _emit_progress(self):
910
if self.pb_entries_count is not None:
911
text = "%s [%d] - Stage" % (self.pb_stage_name,
912
self.pb_entries_count)
914
text = "%s - Stage" % (self.pb_stage_name, )
915
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
917
def _set_specific_file_ids(self):
918
"""populate self.specific_file_ids if we will use it."""
919
if not self.use_record_iter_changes:
920
# If provided, ensure the specified files are versioned
921
if self.specific_files is not None:
922
# Note: This routine is being called because it raises
923
# PathNotVersionedError as a side effect of finding the IDs. We
924
# later use the ids we found as input to the working tree
925
# inventory iterator, so we only consider those ids rather than
926
# examining the whole tree again.
927
# XXX: Dont we have filter_unversioned to do this more
929
self.specific_file_ids = tree.find_ids_across_trees(
930
self.specific_files, [self.basis_tree, self.work_tree])
932
self.specific_file_ids = None
added
removed
bzrlib/commit.py
