50
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
50
# the rest of the code; add a deprecation of the old name.
57
from cStringIO import StringIO
59
from .branch import Branch
60
from .cleanup import ExitStack
62
from .errors import (BzrError,
66
from .osutils import (get_user_encoding,
69
minimum_path_selection,
71
from .trace import mutter, note, is_quiet
72
from .tree import TreeChange
73
from .urlutils import unescape_for_display
74
from .i18n import gettext
77
class PointlessCommit(BzrError):
79
_fmt = "No changes to commit"
82
class CannotCommitSelectedFileMerge(BzrError):
84
_fmt = 'Selected-file commit of merges is not supported yet:'\
85
' files %(files_str)s'
87
def __init__(self, files):
88
files_str = ', '.join(files)
89
BzrError.__init__(self, files=files, files_str=files_str)
92
def filter_excluded(iter_changes, exclude):
93
"""Filter exclude filenames.
95
:param iter_changes: iter_changes function
96
:param exclude: List of paths to exclude
97
:return: iter_changes function
99
for change in iter_changes:
100
new_excluded = (change.path[1] is not None and
101
is_inside_any(exclude, change.path[1]))
103
old_excluded = (change.path[0] is not None and
104
is_inside_any(exclude, change.path[0]))
106
if old_excluded and new_excluded:
109
if old_excluded or new_excluded:
110
# TODO(jelmer): Perhaps raise an error here instead?
67
from bzrlib.branch import Branch
69
from bzrlib.errors import (BzrError, PointlessCommit,
73
from bzrlib.osutils import (get_user_encoding,
74
kind_marker, isdir,isfile, is_inside_any,
75
is_inside_or_parent_of_any,
76
minimum_path_selection,
77
quotefn, sha_file, split_lines,
80
from bzrlib.testament import Testament
81
from bzrlib.trace import mutter, note, warning, is_quiet
82
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
83
from bzrlib import symbol_versioning
84
from bzrlib.symbol_versioning import (deprecated_passed,
87
from bzrlib.workingtree import WorkingTree
88
from bzrlib.urlutils import unescape_for_display
116
92
class NullCommitReporter(object):
117
93
"""I report on progress of a commit."""
119
def started(self, revno, revid, location):
95
def started(self, revno, revid, location=None):
97
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
98
"to started.", DeprecationWarning,
122
102
def snapshot_change(self, change, path):
148
128
note(format, *args)
150
130
def snapshot_change(self, change, path):
151
if path == '' and change in (gettext('added'), gettext('modified')):
131
if path == '' and change in ('added', 'modified'):
153
133
self._note("%s %s", change, path)
155
def started(self, revno, rev_id, location):
157
gettext('Committing to: %s'),
158
unescape_for_display(location, 'utf-8'))
135
def started(self, revno, rev_id, location=None):
136
if location is not None:
137
location = ' to: ' + unescape_for_display(location, 'utf-8')
139
# When started was added, location was only made optional by
140
# accident. Matt Nordhoff 20071129
141
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
142
"to started.", DeprecationWarning,
145
self._note('Committing%s', location)
160
147
def completed(self, revno, rev_id):
161
if revno is not None:
162
self._note(gettext('Committed revision %d.'), revno)
163
# self._note goes to the console too; so while we want to log the
164
# rev_id, we can't trivially only log it. (See bug 526425). Long
165
# term we should rearrange the reporting structure, but for now
166
# we just mutter seperately. We mutter the revid and revno together
167
# so that concurrent bzr invocations won't lead to confusion.
168
mutter('Committed revid %s as revno %d.', rev_id, revno)
170
self._note(gettext('Committed revid %s.'), rev_id)
148
self._note('Committed revision %d.', revno)
172
150
def deleted(self, path):
173
self._note(gettext('deleted %s'), path)
151
self._note('deleted %s', path)
175
153
def missing(self, path):
176
self._note(gettext('missing %s'), path)
154
self._note('missing %s', path)
178
156
def renamed(self, change, old_path, new_path):
179
157
self._note('%s %s => %s', change, old_path, new_path)
194
172
the working directory; these should be removed from the
195
173
working inventory.
198
175
def __init__(self,
201
178
"""Create a Commit object.
203
180
:param reporter: the default reporter to use or None to decide later
205
182
self.reporter = reporter
206
self.config_stack = config_stack
209
def update_revprops(revprops, branch, authors=None,
210
local=False, possible_master_transports=None):
213
if possible_master_transports is None:
214
possible_master_transports = []
215
if (u'branch-nick' not in revprops and
216
branch.repository._format.supports_storing_branch_nick):
217
revprops[u'branch-nick'] = branch._get_nick(
219
possible_master_transports)
220
if authors is not None:
221
if u'author' in revprops or u'authors' in revprops:
222
# XXX: maybe we should just accept one of them?
223
raise AssertionError('author property given twice')
225
for individual in authors:
226
if '\n' in individual:
227
raise AssertionError('\\n is not a valid character '
228
'in an author identity')
229
revprops[u'authors'] = '\n'.join(authors)
282
231
:param exclude: None or a list of relative paths to exclude from the
283
232
commit. Pending changes to excluded files will be ignored by the
285
:param lossy: When committing to a foreign VCS, ignore any
286
data that can not be natively represented.
288
with ExitStack() as stack:
289
self.revprops = revprops or {}
290
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
291
self.config_stack = config or self.config_stack
292
mutter('preparing to commit')
294
if working_tree is None:
295
raise BzrError("working_tree must be passed into commit().")
297
self.work_tree = working_tree
298
self.branch = self.work_tree.branch
299
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
300
if not self.branch.repository.supports_rich_root():
301
raise errors.RootNotRich()
302
if message_callback is None:
303
if message is not None:
304
if isinstance(message, bytes):
305
message = message.decode(get_user_encoding())
307
def message_callback(x):
310
raise BzrError("The message or message_callback keyword"
311
" parameter is required for commit().")
313
self.bound_branch = None
314
self.any_entries_deleted = False
315
if exclude is not None:
316
self.exclude = sorted(
317
minimum_path_selection(exclude))
321
self.master_branch = None
322
self.recursive = recursive
324
# self.specific_files is None to indicate no filter, or any iterable to
325
# indicate a filter - [] means no files at all, as per iter_changes.
326
if specific_files is not None:
327
self.specific_files = sorted(
328
minimum_path_selection(specific_files))
330
self.specific_files = None
332
self.allow_pointless = allow_pointless
333
self.message_callback = message_callback
334
self.timestamp = timestamp
335
self.timezone = timezone
336
self.committer = committer
338
self.verbose = verbose
340
stack.enter_context(self.work_tree.lock_write())
341
self.parents = self.work_tree.get_parent_ids()
342
self.pb = ui.ui_factory.nested_progress_bar()
343
stack.callback(self.pb.finished)
344
self.basis_revid = self.work_tree.last_revision()
345
self.basis_tree = self.work_tree.basis_tree()
346
stack.enter_context(self.basis_tree.lock_read())
235
mutter('preparing to commit')
237
if working_tree is None:
238
raise BzrError("working_tree must be passed into commit().")
240
self.work_tree = working_tree
241
self.branch = self.work_tree.branch
242
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
243
if not self.branch.repository.supports_rich_root():
244
raise errors.RootNotRich()
245
if message_callback is None:
246
if message is not None:
247
if isinstance(message, str):
248
message = message.decode(get_user_encoding())
249
message_callback = lambda x: message
251
raise BzrError("The message or message_callback keyword"
252
" parameter is required for commit().")
254
self.bound_branch = None
255
self.any_entries_deleted = False
256
if exclude is not None:
257
self.exclude = sorted(
258
minimum_path_selection(exclude))
262
self.master_branch = None
263
self.master_locked = False
264
self.recursive = recursive
266
if specific_files is not None:
267
self.specific_files = sorted(
268
minimum_path_selection(specific_files))
270
self.specific_files = None
272
self.allow_pointless = allow_pointless
273
self.revprops = revprops
274
self.message_callback = message_callback
275
self.timestamp = timestamp
276
self.timezone = timezone
277
self.committer = committer
279
self.verbose = verbose
281
self.work_tree.lock_write()
282
self.parents = self.work_tree.get_parent_ids()
283
# We can use record_iter_changes IFF iter_changes is compatible with
284
# the command line parameters, and the repository has fast delta
285
# generation. See bug 347649.
286
self.use_record_iter_changes = (
287
not self.specific_files and
289
not self.branch.repository._format.supports_tree_reference and
290
(self.branch.repository._format.fast_deltas or
291
len(self.parents) < 2))
292
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
293
self.basis_revid = self.work_tree.last_revision()
294
self.basis_tree = self.work_tree.basis_tree()
295
self.basis_tree.lock_read()
347
297
# Cannot commit with conflicts present.
348
298
if len(self.work_tree.conflicts()) > 0:
349
299
raise ConflictsInTree
351
301
# Setup the bound branch variables as needed.
352
self._check_bound_branch(stack, possible_master_transports)
353
if self.config_stack is None:
354
self.config_stack = self.work_tree.get_config_stack()
302
self._check_bound_branch(possible_master_transports)
356
304
# Check that the working tree is up to date
357
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
305
old_revno, new_revno = self._check_out_of_date_tree()
359
307
# Complete configuration setup
360
308
if reporter is not None:
361
309
self.reporter = reporter
362
310
elif self.reporter is None:
363
311
self.reporter = self._select_reporter()
312
if self.config is None:
313
self.config = self.branch.get_config()
315
self._set_specific_file_ids()
365
317
# Setup the progress bar. As the number of files that need to be
366
318
# committed in unknown, progress is reported as stages.
370
322
self.pb_stage_count = 0
371
323
self.pb_stage_total = 5
372
324
if self.bound_branch:
373
# 2 extra stages: "Uploading data to master branch" and "Merging
374
# tags to master branch"
375
self.pb_stage_total += 2
325
self.pb_stage_total += 1
376
326
self.pb.show_pct = False
377
327
self.pb.show_spinner = False
378
328
self.pb.show_eta = False
379
329
self.pb.show_count = True
380
330
self.pb.show_bar = True
332
self._gather_parents()
382
333
# After a merge, a selected file commit is not supported.
383
334
# See 'bzr help merge' for an explanation as to why.
384
if len(self.parents) > 1 and self.specific_files is not None:
385
raise CannotCommitSelectedFileMerge(self.specific_files)
335
if len(self.parents) > 1 and self.specific_files:
336
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
386
337
# Excludes are a form of selected file commit.
387
338
if len(self.parents) > 1 and self.exclude:
388
raise CannotCommitSelectedFileMerge(self.exclude)
339
raise errors.CannotCommitSelectedFileMerge(self.exclude)
390
341
# Collect the changes
391
342
self._set_progress_stage("Collecting changes", counter=True)
393
self.builder = self.branch.get_commit_builder(
394
self.parents, self.config_stack, timestamp, timezone, committer,
395
self.revprops, rev_id, lossy=lossy)
397
if self.builder.updates_branch and self.bound_branch:
399
raise AssertionError(
400
"bound branches not supported for commit builders "
401
"that update the branch")
343
self.builder = self.branch.get_commit_builder(self.parents,
344
self.config, timestamp, timezone, committer, revprops, rev_id)
347
self.builder.will_record_deletes()
404
348
# find the location being committed to
405
349
if self.bound_branch:
406
350
master_location = self.master_branch.base
427
371
# Add revision data to the local branch
428
372
self.rev_id = self.builder.commit(self.message)
431
375
mutter("aborting commit write group because of exception:")
432
376
trace.log_exception_quietly()
377
note("aborting commit write group: %r" % (e,))
433
378
self.builder.abort()
436
self._update_branches(old_revno, old_revid, new_revno)
438
# Make the working tree be up to date with the branch. This
439
# includes automatic changes scheduled to be made to the tree, such
440
# as updating its basis and unversioning paths that were missing.
441
self.work_tree.unversion(self.deleted_paths)
442
self._set_progress_stage("Updating the working tree")
443
self.work_tree.update_basis_by_delta(self.rev_id,
444
self.builder.get_basis_delta())
445
self.reporter.completed(new_revno, self.rev_id)
446
self._process_post_hooks(old_revno, new_revno)
449
def _update_branches(self, old_revno, old_revid, new_revno):
450
"""Update the master and local branch to the new revision.
452
This will try to make sure that the master branch is updated
453
before the local branch.
455
:param old_revno: Revision number of master branch before the
457
:param old_revid: Tip of master branch before the commit
458
:param new_revno: Revision number of the new commit
460
if not self.builder.updates_branch:
461
381
self._process_pre_hooks(old_revno, new_revno)
463
383
# Upload revision data to the master.
466
386
self._set_progress_stage("Uploading data to master branch")
467
387
# 'commit' to the master first so a timeout here causes the
468
388
# local branch to be out of date
469
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
470
self.branch, new_revno, self.rev_id, lossy=self._lossy)
472
self.branch.fetch(self.master_branch, self.rev_id)
389
self.master_branch.import_last_revision_info(
390
self.branch.repository, new_revno, self.rev_id)
474
392
# and now do the commit locally.
475
if new_revno is None:
476
# Keep existing behaviour around ghosts
478
393
self.branch.set_last_revision_info(new_revno, self.rev_id)
481
self._process_pre_hooks(old_revno, new_revno)
482
except BaseException:
483
# The commit builder will already have updated the branch,
485
self.branch.set_last_revision_info(old_revno, old_revid)
488
# Merge local tags to remote
489
if self.bound_branch:
490
self._set_progress_stage("Merging tags to master branch")
491
tag_updates, tag_conflicts = self.branch.tags.merge_to(
492
self.master_branch.tags)
494
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
495
note(gettext("Conflicting tags in bound branch:\n{0}".format(
496
"\n".join(warning_lines))))
395
# Make the working tree up to date with the branch
396
self._set_progress_stage("Updating the working tree")
397
self.work_tree.update_basis_by_delta(self.rev_id,
398
self.builder.get_basis_delta())
399
self.reporter.completed(new_revno, self.rev_id)
400
self._process_post_hooks(old_revno, new_revno)
498
405
def _select_reporter(self):
499
406
"""Select the CommitReporter to use."""
544
460
# Make sure the local branch is identical to the master
545
master_revid = self.master_branch.last_revision()
546
local_revid = self.branch.last_revision()
547
if local_revid != master_revid:
461
master_info = self.master_branch.last_revision_info()
462
local_info = self.branch.last_revision_info()
463
if local_info != master_info:
548
464
raise errors.BoundBranchOutOfDate(self.branch,
551
467
# Now things are ready to change the master branch
552
468
# so grab the lock
553
469
self.bound_branch = self.branch
554
stack.enter_context(self.master_branch.lock_write())
470
self.master_branch.lock_write()
471
self.master_locked = True
556
473
def _check_out_of_date_tree(self):
557
474
"""Check that the working tree is up to date.
559
:return: old_revision_number, old_revision_id, new_revision_number
476
:return: old_revision_number,new_revision_number tuple
563
479
first_tree_parent = self.work_tree.get_parent_ids()[0]
566
482
# this is so that we still consider the master branch
567
483
# - in a checkout scenario the tree may have no
568
484
# parents but the branch may do.
569
first_tree_parent = breezy.revision.NULL_REVISION
570
if (self.master_branch._format.stores_revno() or
571
self.config_stack.get('calculate_revnos')):
573
old_revno, master_last = self.master_branch.last_revision_info()
574
except errors.UnsupportedOperation:
575
master_last = self.master_branch.last_revision()
576
old_revno = self.branch.revision_id_to_revno(master_last)
578
master_last = self.master_branch.last_revision()
485
first_tree_parent = bzrlib.revision.NULL_REVISION
486
old_revno, master_last = self.master_branch.last_revision_info()
580
487
if master_last != first_tree_parent:
581
if master_last != breezy.revision.NULL_REVISION:
488
if master_last != bzrlib.revision.NULL_REVISION:
582
489
raise errors.OutOfDateTree(self.work_tree)
583
if (old_revno is not None and
584
self.branch.repository.has_revision(first_tree_parent)):
490
if self.branch.repository.has_revision(first_tree_parent):
585
491
new_revno = old_revno + 1
587
493
# ghost parents never appear in revision history.
589
return old_revno, master_last, new_revno
495
return old_revno,new_revno
591
497
def _process_pre_hooks(self, old_revno, new_revno):
592
498
"""Process any registered pre commit hooks."""
654
559
old_revno, old_revid, new_revno, self.rev_id,
655
560
tree_delta, future_tree)
563
"""Cleanup any open locks, progress bars etc."""
564
cleanups = [self._cleanup_bound_branch,
565
self.basis_tree.unlock,
566
self.work_tree.unlock,
568
found_exception = None
569
for cleanup in cleanups:
572
# we want every cleanup to run no matter what.
573
# so we have a catchall here, but we will raise the
574
# last encountered exception up the stack: and
575
# typically this will be useful enough.
578
if found_exception is not None:
579
# don't do a plan raise, because the last exception may have been
580
# trashed, e is our sure-to-work exception even though it loses the
581
# full traceback. XXX: RBC 20060421 perhaps we could check the
582
# exc_info and if its the same one do a plain raise otherwise
583
# 'raise e' as we do now.
586
def _cleanup_bound_branch(self):
587
"""Executed at the end of a try/finally to cleanup a bound branch.
589
If the branch wasn't bound, this is a no-op.
590
If it was, it resents self.branch to the local branch, instead
593
if not self.bound_branch:
595
if self.master_locked:
596
self.master_branch.unlock()
598
def _gather_parents(self):
599
"""Record the parents of a merge for merge detection."""
600
# TODO: Make sure that this list doesn't contain duplicate
601
# entries and the order is preserved when doing this.
602
if self.use_record_iter_changes:
604
self.basis_inv = self.basis_tree.inventory
605
self.parent_invs = [self.basis_inv]
606
for revision in self.parents[1:]:
607
if self.branch.repository.has_revision(revision):
608
mutter('commit parent revision {%s}', revision)
609
inventory = self.branch.repository.get_inventory(revision)
610
self.parent_invs.append(inventory)
612
mutter('commit parent ghost revision {%s}', revision)
657
614
def _update_builder_with_changes(self):
658
615
"""Update the commit builder with the data about what has changed.
660
specific_files = self.specific_files
661
mutter("Selecting files for commit with filter %r", specific_files)
617
exclude = self.exclude
618
specific_files = self.specific_files or []
619
mutter("Selecting files for commit with filter %s", specific_files)
663
621
self._check_strict()
664
iter_changes = self.work_tree.iter_changes(
665
self.basis_tree, specific_files=specific_files)
667
iter_changes = filter_excluded(iter_changes, self.exclude)
668
iter_changes = self._filter_iter_changes(iter_changes)
669
for path, fs_hash in self.builder.record_iter_changes(
622
if self.use_record_iter_changes:
623
iter_changes = self.work_tree.iter_changes(self.basis_tree)
624
iter_changes = self._filter_iter_changes(iter_changes)
625
for file_id, path, fs_hash in self.builder.record_iter_changes(
670
626
self.work_tree, self.basis_revid, iter_changes):
671
self.work_tree._observed_sha1(path, fs_hash)
627
self.work_tree._observed_sha1(file_id, path, fs_hash)
629
# Build the new inventory
630
self._populate_from_inventory()
631
self._record_unselected()
632
self._report_and_accumulate_deletes()
673
634
def _filter_iter_changes(self, iter_changes):
674
635
"""Process iter_changes.
676
This method reports on the changes in iter_changes to the user, and
637
This method reports on the changes in iter_changes to the user, and
677
638
converts 'missing' entries in the iter_changes iterator to 'deleted'
678
639
entries. 'missing' entries have their
683
644
reporter = self.reporter
684
645
report_changes = reporter.is_verbose()
686
647
for change in iter_changes:
687
648
if report_changes:
688
old_path = change.path[0]
689
new_path = change.path[1]
690
versioned = change.versioned[1]
691
kind = change.kind[1]
692
versioned = change.versioned[1]
649
old_path = change[1][0]
650
new_path = change[1][1]
651
versioned = change[3][1]
653
versioned = change[3][1]
693
654
if kind is None and versioned:
695
656
if report_changes:
696
657
reporter.missing(new_path)
697
if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
698
trace.warning('Ignoring "%s" as symlinks are not '
699
'supported on this filesystem.' % (change.path[0],))
701
deleted_paths.append(change.path[1])
658
deleted_ids.append(change[0])
702
659
# Reset the new path (None) and new versioned flag (False)
703
change = change.discard_new()
704
new_path = change.path[1]
660
change = (change[0], (change[1][0], None), change[2],
661
(change[3][0], False)) + change[4:]
706
662
elif kind == 'tree-reference':
707
663
if self.recursive == 'down':
708
self._commit_nested_tree(change.path[1])
709
if change.versioned[0] or change.versioned[1]:
664
self._commit_nested_tree(change[0], change[1][1])
665
if change[3][0] or change[3][1]:
711
667
if report_changes:
712
668
if new_path is None:
713
669
reporter.deleted(old_path)
714
670
elif old_path is None:
715
reporter.snapshot_change(gettext('added'), new_path)
671
reporter.snapshot_change('added', new_path)
716
672
elif old_path != new_path:
717
reporter.renamed(gettext('renamed'),
673
reporter.renamed('renamed', old_path, new_path)
721
or self.work_tree.branch.repository._format.rich_root_data):
676
self.work_tree.branch.repository._format.rich_root_data):
722
677
# Don't report on changes to '' in non rich root
724
reporter.snapshot_change(
725
gettext('modified'), new_path)
679
reporter.snapshot_change('modified', new_path)
726
680
self._next_progress_entry()
727
# Unversion files that were found to be deleted
728
self.deleted_paths = deleted_paths
681
# Unversion IDs that were found to be deleted
682
self.work_tree.unversion(deleted_ids)
684
def _record_unselected(self):
685
# If specific files are selected, then all un-selected files must be
686
# recorded in their previous state. For more details, see
687
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
688
if self.specific_files or self.exclude:
689
specific_files = self.specific_files or []
690
for path, old_ie in self.basis_inv.iter_entries():
691
if old_ie.file_id in self.builder.new_inventory:
692
# already added - skip.
694
if (is_inside_any(specific_files, path)
695
and not is_inside_any(self.exclude, path)):
696
# was inside the selected path, and not excluded - if not
697
# present it has been deleted so skip.
699
# From here down it was either not selected, or was excluded:
700
# We preserve the entry unaltered.
702
# Note: specific file commits after a merge are currently
703
# prohibited. This test is for sanity/safety in case it's
704
# required after that changes.
705
if len(self.parents) > 1:
707
self.builder.record_entry_contents(ie, self.parent_invs, path,
708
self.basis_tree, None)
710
def _report_and_accumulate_deletes(self):
711
if (isinstance(self.basis_inv, Inventory)
712
and isinstance(self.builder.new_inventory, Inventory)):
713
# the older Inventory classes provide a _byid dict, and building a
714
# set from the keys of this dict is substantially faster than even
715
# getting a set of ids from the inventory
717
# <lifeless> set(dict) is roughly the same speed as
718
# set(iter(dict)) and both are significantly slower than
720
deleted_ids = set(self.basis_inv._byid.keys()) - \
721
set(self.builder.new_inventory._byid.keys())
723
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
725
self.any_entries_deleted = True
726
deleted = [(self.basis_tree.id2path(file_id), file_id)
727
for file_id in deleted_ids]
729
# XXX: this is not quite directory-order sorting
730
for path, file_id in deleted:
731
self.builder.record_delete(path, file_id)
732
self.reporter.deleted(path)
730
734
def _check_strict(self):
731
735
# XXX: when we use iter_changes this would likely be faster if
736
740
for unknown in self.work_tree.unknowns():
737
741
raise StrictCommitFailed()
739
def _commit_nested_tree(self, path):
743
def _populate_from_inventory(self):
744
"""Populate the CommitBuilder by walking the working tree inventory."""
745
# Build the revision inventory.
747
# This starts by creating a new empty inventory. Depending on
748
# which files are selected for commit, and what is present in the
749
# current tree, the new inventory is populated. inventory entries
750
# which are candidates for modification have their revision set to
751
# None; inventory entries that are carried over untouched have their
752
# revision set to their prior value.
754
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
755
# results to create a new inventory at the same time, which results
756
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
759
specific_files = self.specific_files
760
exclude = self.exclude
761
report_changes = self.reporter.is_verbose()
763
# A tree of paths that have been deleted. E.g. if foo/bar has been
764
# deleted, then we have {'foo':{'bar':{}}}
766
# XXX: Note that entries may have the wrong kind because the entry does
767
# not reflect the status on disk.
768
work_inv = self.work_tree.inventory
769
# NB: entries will include entries within the excluded ids/paths
770
# because iter_entries_by_dir has no 'exclude' facility today.
771
entries = work_inv.iter_entries_by_dir(
772
specific_file_ids=self.specific_file_ids, yield_parents=True)
773
for path, existing_ie in entries:
774
file_id = existing_ie.file_id
775
name = existing_ie.name
776
parent_id = existing_ie.parent_id
777
kind = existing_ie.kind
778
# Skip files that have been deleted from the working tree.
779
# The deleted path ids are also recorded so they can be explicitly
782
path_segments = splitpath(path)
783
deleted_dict = deleted_paths
784
for segment in path_segments:
785
deleted_dict = deleted_dict.get(segment, None)
787
# We either took a path not present in the dict
788
# (deleted_dict was None), or we've reached an empty
789
# child dir in the dict, so are now a sub-path.
793
if deleted_dict is not None:
794
# the path has a deleted parent, do not add it.
796
if exclude and is_inside_any(exclude, path):
797
# Skip excluded paths. Excluded paths are processed by
798
# _update_builder_with_changes.
800
content_summary = self.work_tree.path_content_summary(path)
801
# Note that when a filter of specific files is given, we must only
802
# skip/record deleted files matching that filter.
803
if not specific_files or is_inside_any(specific_files, path):
804
if content_summary[0] == 'missing':
805
if not deleted_paths:
806
# path won't have been split yet.
807
path_segments = splitpath(path)
808
deleted_dict = deleted_paths
809
for segment in path_segments:
810
deleted_dict = deleted_dict.setdefault(segment, {})
811
self.reporter.missing(path)
812
self._next_progress_entry()
813
deleted_ids.append(file_id)
815
# TODO: have the builder do the nested commit just-in-time IF and
817
if content_summary[0] == 'tree-reference':
818
# enforce repository nested tree policy.
819
if (not self.work_tree.supports_tree_reference() or
820
# repository does not support it either.
821
not self.branch.repository._format.supports_tree_reference):
822
content_summary = ('directory',) + content_summary[1:]
823
kind = content_summary[0]
824
# TODO: specific_files filtering before nested tree processing
825
if kind == 'tree-reference':
826
if self.recursive == 'down':
827
nested_revision_id = self._commit_nested_tree(
829
content_summary = content_summary[:3] + (
832
content_summary = content_summary[:3] + (
833
self.work_tree.get_reference_revision(file_id),)
835
# Record an entry for this item
836
# Note: I don't particularly want to have the existing_ie
837
# parameter but the test suite currently (28-Jun-07) breaks
838
# without it thanks to a unicode normalisation issue. :-(
839
definitely_changed = kind != existing_ie.kind
840
self._record_entry(path, file_id, specific_files, kind, name,
841
parent_id, definitely_changed, existing_ie, report_changes,
844
# Unversion IDs that were found to be deleted
845
self.work_tree.unversion(deleted_ids)
847
def _commit_nested_tree(self, file_id, path):
740
848
"Commit a nested tree."
741
sub_tree = self.work_tree.get_nested_tree(path)
849
sub_tree = self.work_tree.get_nested_tree(file_id, path)
742
850
# FIXME: be more comprehensive here:
743
851
# this works when both trees are in --trees repository,
744
852
# but when both are bound to a different repository,
746
854
# finally implement the explicit-caches approach design
747
855
# a while back - RBC 20070306.
748
856
if sub_tree.branch.repository.has_same_location(
749
self.work_tree.branch.repository):
857
self.work_tree.branch.repository):
750
858
sub_tree.branch.repository = \
751
859
self.work_tree.branch.repository
753
861
return sub_tree.commit(message=None, revprops=self.revprops,
754
recursive=self.recursive,
755
message_callback=self.message_callback,
756
timestamp=self.timestamp,
757
timezone=self.timezone,
758
committer=self.committer,
759
allow_pointless=self.allow_pointless,
760
strict=self.strict, verbose=self.verbose,
761
local=self.local, reporter=self.reporter)
762
except PointlessCommit:
763
return self.work_tree.get_reference_revision(path)
862
recursive=self.recursive,
863
message_callback=self.message_callback,
864
timestamp=self.timestamp, timezone=self.timezone,
865
committer=self.committer,
866
allow_pointless=self.allow_pointless,
867
strict=self.strict, verbose=self.verbose,
868
local=self.local, reporter=self.reporter)
869
except errors.PointlessCommit:
870
return self.work_tree.get_reference_revision(file_id)
872
def _record_entry(self, path, file_id, specific_files, kind, name,
873
parent_id, definitely_changed, existing_ie, report_changes,
875
"Record the new inventory entry for a path if any."
876
# mutter('check %s {%s}', path, file_id)
877
# mutter('%s selected for commit', path)
878
if definitely_changed or existing_ie is None:
879
ie = make_entry(kind, name, parent_id, file_id)
881
ie = existing_ie.copy()
883
# For carried over entries we don't care about the fs hash - the repo
884
# isn't generating a sha, so we're not saving computation time.
885
_, _, fs_hash = self.builder.record_entry_contents(
886
ie, self.parent_invs, path, self.work_tree, content_summary)
888
self._report_change(ie, path)
890
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
893
def _report_change(self, ie, path):
894
"""Report a change to the user.
896
The change that has occurred is described relative to the basis
899
if (self.basis_inv.has_id(ie.file_id)):
900
basis_ie = self.basis_inv[ie.file_id]
903
change = ie.describe_change(basis_ie, ie)
904
if change in (InventoryEntry.RENAMED,
905
InventoryEntry.MODIFIED_AND_RENAMED):
906
old_path = self.basis_inv.id2path(ie.file_id)
907
self.reporter.renamed(change, old_path, path)
908
self._next_progress_entry()
910
if change == 'unchanged':
912
self.reporter.snapshot_change(change, path)
913
self._next_progress_entry()
765
915
def _set_progress_stage(self, name, counter=False):
766
916
"""Set the progress stage and emit an update to the progress bar."""
780
930
def _emit_progress(self):
781
931
if self.pb_entries_count is not None:
782
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
783
self.pb_entries_count)
932
text = "%s [%d] - Stage" % (self.pb_stage_name,
933
self.pb_entries_count)
785
text = gettext("%s - Stage") % (self.pb_stage_name, )
935
text = "%s - Stage" % (self.pb_stage_name, )
786
936
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
938
def _set_specific_file_ids(self):
939
"""populate self.specific_file_ids if we will use it."""
940
if not self.use_record_iter_changes:
941
# If provided, ensure the specified files are versioned
942
if self.specific_files is not None:
943
# Note: This routine is being called because it raises
944
# PathNotVersionedError as a side effect of finding the IDs. We
945
# later use the ids we found as input to the working tree
946
# inventory iterator, so we only consider those ids rather than
947
# examining the whole tree again.
948
# XXX: Dont we have filter_unversioned to do this more
950
self.specific_file_ids = tree.find_ids_across_trees(
951
self.specific_files, [self.basis_tree, self.work_tree])
953
self.specific_file_ids = None
added
removed
bzrlib/commit.py
