206
message_callback=None,
209
possible_master_transports=None):
176
message_callback=None):
210
177
"""Commit working copy as a new revision.
212
:param message: the commit message (it or message_callback is required)
214
:param timestamp: if not None, seconds-since-epoch for a
215
postdated/predated commit.
217
:param specific_files: If true, commit only those files.
219
:param rev_id: If set, use this as the new revision id.
179
branch -- the deprecated branch to commit to. New callers should pass in
182
message -- the commit message (it or message_callback is required)
184
timestamp -- if not None, seconds-since-epoch for a
185
postdated/predated commit.
187
specific_files -- If true, commit only those files.
189
rev_id -- If set, use this as the new revision id.
220
190
Useful for test or import commands that need to tightly
221
191
control what revisions are assigned. If you duplicate
222
192
a revision id that exists elsewhere it is your own fault.
223
193
If null (default), a time/random revision id is generated.
225
:param allow_pointless: If true (default), commit even if nothing
195
allow_pointless -- If true (default), commit even if nothing
226
196
has changed and no merges are recorded.
228
:param strict: If true, don't allow a commit if the working tree
198
strict -- If true, don't allow a commit if the working tree
229
199
contains unknown files.
231
:param revprops: Properties for new revision
201
revprops -- Properties for new revision
232
202
:param local: Perform a local only commit.
233
:param reporter: the reporter to use or None for the default
234
:param verbose: if True and the reporter is not None, report everything
235
:param recursive: If set to 'down', commit in any subtrees that have
236
pending changes of any sort during this commit.
237
:param exclude: None or a list of relative paths to exclude from the
238
commit. Pending changes to excluded files will be ignored by the
241
204
mutter('preparing to commit')
243
if working_tree is None:
244
raise BzrError("working_tree must be passed into commit().")
206
if deprecated_passed(branch):
207
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
208
"deprecated as of bzr 0.8. Please use working_tree= instead.",
209
DeprecationWarning, stacklevel=2)
211
self.work_tree = self.branch.bzrdir.open_workingtree()
212
elif working_tree is None:
213
raise BzrError("One of branch and working_tree must be passed into commit().")
246
215
self.work_tree = working_tree
247
216
self.branch = self.work_tree.branch
248
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
249
if not self.branch.repository.supports_rich_root():
250
raise errors.RootNotRich()
251
217
if message_callback is None:
252
218
if message is not None:
253
219
if isinstance(message, str):
254
message = message.decode(get_user_encoding())
220
message = message.decode(bzrlib.user_encoding)
255
221
message_callback = lambda x: message
257
223
raise BzrError("The message or message_callback keyword"
258
224
" parameter is required for commit().")
260
226
self.bound_branch = None
261
self.any_entries_deleted = False
262
if exclude is not None:
263
self.exclude = sorted(
264
minimum_path_selection(exclude))
267
227
self.local = local
268
228
self.master_branch = None
269
229
self.master_locked = False
270
self.recursive = recursive
271
230
self.rev_id = None
272
if specific_files is not None:
273
self.specific_files = sorted(
274
minimum_path_selection(specific_files))
276
self.specific_files = None
231
self.specific_files = specific_files
278
232
self.allow_pointless = allow_pointless
279
self.revprops = revprops
280
self.message_callback = message_callback
281
self.timestamp = timestamp
282
self.timezone = timezone
283
self.committer = committer
285
self.verbose = verbose
234
if reporter is None and self.reporter is None:
235
self.reporter = NullCommitReporter()
236
elif reporter is not None:
237
self.reporter = reporter
287
239
self.work_tree.lock_write()
288
self.parents = self.work_tree.get_parent_ids()
289
# We can use record_iter_changes IFF iter_changes is compatible with
290
# the command line parameters, and the repository has fast delta
291
# generation. See bug 347649.
292
self.use_record_iter_changes = (
293
not self.specific_files and
295
not self.branch.repository._format.supports_tree_reference and
296
(self.branch.repository._format.fast_deltas or
297
len(self.parents) < 2))
298
240
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
299
self.basis_revid = self.work_tree.last_revision()
300
self.basis_tree = self.work_tree.basis_tree()
301
self.basis_tree.lock_read()
303
242
# Cannot commit with conflicts present.
304
if len(self.work_tree.conflicts()) > 0:
243
if len(self.work_tree.conflicts())>0:
305
244
raise ConflictsInTree
307
# Setup the bound branch variables as needed.
308
self._check_bound_branch(possible_master_transports)
310
# Check that the working tree is up to date
311
old_revno, new_revno = self._check_out_of_date_tree()
313
# Complete configuration setup
314
if reporter is not None:
315
self.reporter = reporter
316
elif self.reporter is None:
317
self.reporter = self._select_reporter()
246
# setup the bound branch variables as needed.
247
self._check_bound_branch()
249
# check for out of date working trees
251
first_tree_parent = self.work_tree.get_parent_ids()[0]
253
# if there are no parents, treat our parent as 'None'
254
# this is so that we still consier the master branch
255
# - in a checkout scenario the tree may have no
256
# parents but the branch may do.
257
first_tree_parent = None
258
master_last = self.master_branch.last_revision()
259
if (master_last is not None and
260
master_last != first_tree_parent):
261
raise errors.OutOfDateTree(self.work_tree)
264
# raise an exception as soon as we find a single unknown.
265
for unknown in self.work_tree.unknowns():
266
raise StrictCommitFailed()
318
268
if self.config is None:
319
269
self.config = self.branch.get_config()
321
self._set_specific_file_ids()
323
# Setup the progress bar. As the number of files that need to be
324
# committed in unknown, progress is reported as stages.
325
# We keep track of entries separately though and include that
326
# information in the progress bar during the relevant stages.
327
self.pb_stage_name = ""
328
self.pb_stage_count = 0
329
self.pb_stage_total = 5
330
if self.bound_branch:
331
self.pb_stage_total += 1
332
self.pb.show_pct = False
333
self.pb.show_spinner = False
334
self.pb.show_eta = False
335
self.pb.show_count = True
336
self.pb.show_bar = True
271
self.work_inv = self.work_tree.inventory
272
self.basis_tree = self.work_tree.basis_tree()
273
self.basis_inv = self.basis_tree.inventory
274
if specific_files is not None:
275
# Ensure specified files are versioned
276
# (We don't actually need the ids here)
277
tree.find_ids_across_trees(specific_files,
278
[self.basis_tree, self.work_tree])
279
# one to finish, one for rev and inventory, and one for each
280
# inventory entry, and the same for the new inventory.
281
# note that this estimate is too long when we do a partial tree
282
# commit which excludes some new files from being considered.
283
# The estimate is corrected when we populate the new inv.
284
self.pb_total = len(self.work_inv) + 5
338
287
self._gather_parents()
339
# After a merge, a selected file commit is not supported.
340
# See 'bzr help merge' for an explanation as to why.
341
288
if len(self.parents) > 1 and self.specific_files:
342
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
343
# Excludes are a form of selected file commit.
344
if len(self.parents) > 1 and self.exclude:
345
raise errors.CannotCommitSelectedFileMerge(self.exclude)
347
# Collect the changes
348
self._set_progress_stage("Collecting changes", counter=True)
349
self.builder = self.branch.get_commit_builder(self.parents,
289
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
292
self.builder = self.branch.get_commit_builder(self.parents,
350
293
self.config, timestamp, timezone, committer, revprops, rev_id)
353
self.builder.will_record_deletes()
354
# find the location being committed to
355
if self.bound_branch:
356
master_location = self.master_branch.base
358
master_location = self.branch.base
360
# report the start of the commit
361
self.reporter.started(new_revno, self.rev_id, master_location)
363
self._update_builder_with_changes()
364
self._check_pointless()
366
# TODO: Now the new inventory is known, check for conflicts.
367
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
368
# weave lines, because nothing should be recorded until it is known
369
# that commit will succeed.
370
self._set_progress_stage("Saving data locally")
371
self.builder.finish_inventory()
373
# Prompt the user for a commit message if none provided
374
message = message_callback(self)
375
self.message = message
376
self._escape_commit_message()
378
# Add revision data to the local branch
379
self.rev_id = self.builder.commit(self.message)
382
mutter("aborting commit write group because of exception:")
383
trace.log_exception_quietly()
384
note("aborting commit write group: %r" % (e,))
388
self._process_pre_hooks(old_revno, new_revno)
390
# Upload revision data to the master.
295
self._remove_deleted()
296
self._populate_new_inv()
297
self._report_deletes()
299
self._check_pointless()
301
self._emit_progress_update()
302
# TODO: Now the new inventory is known, check for conflicts and
303
# prompt the user for a commit message.
304
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
305
# weave lines, because nothing should be recorded until it is known
306
# that commit will succeed.
307
self.builder.finish_inventory()
308
self._emit_progress_update()
309
message = message_callback(self)
310
assert isinstance(message, unicode), type(message)
311
self.message = message
312
self._escape_commit_message()
314
self.rev_id = self.builder.commit(self.message)
315
self._emit_progress_update()
316
# revision data is in the local branch now.
318
# upload revision data to the master.
391
319
# this will propagate merged revisions too if needed.
392
320
if self.bound_branch:
393
self._set_progress_stage("Uploading data to master branch")
394
# 'commit' to the master first so a timeout here causes the
395
# local branch to be out of date
396
self.master_branch.import_last_revision_info(
397
self.branch.repository, new_revno, self.rev_id)
321
self.master_branch.repository.fetch(self.branch.repository,
322
revision_id=self.rev_id)
323
# now the master has the revision data
324
# 'commit' to the master first so a timeout here causes the local
325
# branch to be out of date
326
self.master_branch.append_revision(self.rev_id)
399
328
# and now do the commit locally.
400
self.branch.set_last_revision_info(new_revno, self.rev_id)
329
self.branch.append_revision(self.rev_id)
402
# Make the working tree up to date with the branch
403
self._set_progress_stage("Updating the working tree")
404
self.work_tree.update_basis_by_delta(self.rev_id,
405
self.builder.get_basis_delta())
406
self.reporter.completed(new_revno, self.rev_id)
407
self._process_post_hooks(old_revno, new_revno)
331
rev_tree = self.builder.revision_tree()
332
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
333
# now the work tree is up to date with the branch
335
self.reporter.completed(self.branch.revno(), self.rev_id)
336
# old style commit hooks - should be deprecated ? (obsoleted in
338
if self.config.post_commit() is not None:
339
hooks = self.config.post_commit().split(' ')
340
# this would be nicer with twisted.python.reflect.namedAny
342
result = eval(hook + '(branch, rev_id)',
343
{'branch':self.branch,
345
'rev_id':self.rev_id})
346
# new style commit hooks:
347
if not self.bound_branch:
348
hook_master = self.branch
351
hook_master = self.master_branch
352
hook_local = self.branch
353
new_revno = self.branch.revno()
354
# With bound branches, when the master is behind the local branch,
355
# the 'old_revno' and old_revid values here are incorrect.
356
# XXX: FIXME ^. RBC 20060206
357
old_revno = new_revno - 1
359
old_revid = self.parents[0]
361
old_revid = bzrlib.revision.NULL_REVISION
362
for hook in Branch.hooks['post_commit']:
363
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
365
self._emit_progress_update()
410
368
return self.rev_id
412
def _select_reporter(self):
413
"""Select the CommitReporter to use."""
415
return NullCommitReporter()
416
return ReportCommitToLog()
370
def _any_real_changes(self):
371
"""Are there real changes between new_inventory and basis?
373
For trees without rich roots, inv.root.revision changes every commit.
374
But if that is the only change, we want to treat it as though there
377
new_entries = self.builder.new_inventory.iter_entries()
378
basis_entries = self.basis_inv.iter_entries()
379
new_path, new_root_ie = new_entries.next()
380
basis_path, basis_root_ie = basis_entries.next()
382
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
383
def ie_equal_no_revision(this, other):
384
return ((this.file_id == other.file_id)
385
and (this.name == other.name)
386
and (this.symlink_target == other.symlink_target)
387
and (this.text_sha1 == other.text_sha1)
388
and (this.text_size == other.text_size)
389
and (this.text_id == other.text_id)
390
and (this.parent_id == other.parent_id)
391
and (this.kind == other.kind)
392
and (this.executable == other.executable)
394
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
397
for new_ie, basis_ie in zip(new_entries, basis_entries):
398
if new_ie != basis_ie:
401
# No actual changes present
418
404
def _check_pointless(self):
419
405
if self.allow_pointless:
477
463
self.master_branch.lock_write()
478
464
self.master_locked = True
480
def _check_out_of_date_tree(self):
481
"""Check that the working tree is up to date.
483
:return: old_revision_number,new_revision_number tuple
486
first_tree_parent = self.work_tree.get_parent_ids()[0]
488
# if there are no parents, treat our parent as 'None'
489
# this is so that we still consider the master branch
490
# - in a checkout scenario the tree may have no
491
# parents but the branch may do.
492
first_tree_parent = bzrlib.revision.NULL_REVISION
493
old_revno, master_last = self.master_branch.last_revision_info()
494
if master_last != first_tree_parent:
495
if master_last != bzrlib.revision.NULL_REVISION:
496
raise errors.OutOfDateTree(self.work_tree)
497
if self.branch.repository.has_revision(first_tree_parent):
498
new_revno = old_revno + 1
500
# ghost parents never appear in revision history.
502
return old_revno,new_revno
504
def _process_pre_hooks(self, old_revno, new_revno):
505
"""Process any registered pre commit hooks."""
506
self._set_progress_stage("Running pre_commit hooks")
507
self._process_hooks("pre_commit", old_revno, new_revno)
509
def _process_post_hooks(self, old_revno, new_revno):
510
"""Process any registered post commit hooks."""
511
# Process the post commit hooks, if any
512
self._set_progress_stage("Running post_commit hooks")
513
# old style commit hooks - should be deprecated ? (obsoleted in
515
if self.config.post_commit() is not None:
516
hooks = self.config.post_commit().split(' ')
517
# this would be nicer with twisted.python.reflect.namedAny
519
result = eval(hook + '(branch, rev_id)',
520
{'branch':self.branch,
522
'rev_id':self.rev_id})
523
# process new style post commit hooks
524
self._process_hooks("post_commit", old_revno, new_revno)
526
def _process_hooks(self, hook_name, old_revno, new_revno):
527
if not Branch.hooks[hook_name]:
530
# new style commit hooks:
531
if not self.bound_branch:
532
hook_master = self.branch
535
hook_master = self.master_branch
536
hook_local = self.branch
537
# With bound branches, when the master is behind the local branch,
538
# the 'old_revno' and old_revid values here are incorrect.
539
# XXX: FIXME ^. RBC 20060206
541
old_revid = self.parents[0]
543
old_revid = bzrlib.revision.NULL_REVISION
545
if hook_name == "pre_commit":
546
future_tree = self.builder.revision_tree()
547
tree_delta = future_tree.changes_from(self.basis_tree,
550
for hook in Branch.hooks[hook_name]:
551
# show the running hook in the progress bar. As hooks may
552
# end up doing nothing (e.g. because they are not configured by
553
# the user) this is still showing progress, not showing overall
554
# actions - its up to each plugin to show a UI if it want's to
555
# (such as 'Emailing diff to foo@example.com').
556
self.pb_stage_name = "Running %s hooks [%s]" % \
557
(hook_name, Branch.hooks.get_hook_name(hook))
558
self._emit_progress()
559
if 'hooks' in debug.debug_flags:
560
mutter("Invoking commit hook: %r", hook)
561
if hook_name == "post_commit":
562
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
564
elif hook_name == "pre_commit":
565
hook(hook_local, hook_master,
566
old_revno, old_revid, new_revno, self.rev_id,
567
tree_delta, future_tree)
569
466
def _cleanup(self):
570
467
"""Cleanup any open locks, progress bars etc."""
571
468
cleanups = [self._cleanup_bound_branch,
572
self.basis_tree.unlock,
573
469
self.work_tree.unlock,
574
470
self.pb.finished]
575
471
found_exception = None
630
531
mutter('commit parent ghost revision {%s}', revision)
632
def _update_builder_with_changes(self):
633
"""Update the commit builder with the data about what has changed.
635
exclude = self.exclude
636
specific_files = self.specific_files or []
637
mutter("Selecting files for commit with filter %s", specific_files)
640
if self.use_record_iter_changes:
641
iter_changes = self.work_tree.iter_changes(self.basis_tree)
642
iter_changes = self._filter_iter_changes(iter_changes)
643
for file_id, path, fs_hash in self.builder.record_iter_changes(
644
self.work_tree, self.basis_revid, iter_changes):
645
self.work_tree._observed_sha1(file_id, path, fs_hash)
647
# Build the new inventory
648
self._populate_from_inventory()
649
self._record_unselected()
650
self._report_and_accumulate_deletes()
652
def _filter_iter_changes(self, iter_changes):
653
"""Process iter_changes.
655
This method reports on the changes in iter_changes to the user, and
656
converts 'missing' entries in the iter_changes iterator to 'deleted'
657
entries. 'missing' entries have their
659
:param iter_changes: An iter_changes to process.
660
:return: A generator of changes.
662
reporter = self.reporter
663
report_changes = reporter.is_verbose()
533
def _remove_deleted(self):
534
"""Remove deleted files from the working inventories.
536
This is done prior to taking the working inventory as the
537
basis for the new committed inventory.
539
This returns true if any files
540
*that existed in the basis inventory* were deleted.
541
Files that were added and deleted
542
in the working copy don't matter.
544
specific = self.specific_files
665
for change in iter_changes:
667
old_path = change[1][0]
668
new_path = change[1][1]
669
versioned = change[3][1]
671
versioned = change[3][1]
672
if kind is None and versioned:
675
reporter.missing(new_path)
676
deleted_ids.append(change[0])
677
# Reset the new path (None) and new versioned flag (False)
678
change = (change[0], (change[1][0], None), change[2],
679
(change[3][0], False)) + change[4:]
680
elif kind == 'tree-reference':
681
if self.recursive == 'down':
682
self._commit_nested_tree(change[0], change[1][1])
683
if change[3][0] or change[3][1]:
687
reporter.deleted(old_path)
688
elif old_path is None:
689
reporter.snapshot_change('added', new_path)
690
elif old_path != new_path:
691
reporter.renamed('renamed', old_path, new_path)
694
self.work_tree.branch.repository._format.rich_root_data):
695
# Don't report on changes to '' in non rich root
697
reporter.snapshot_change('modified', new_path)
698
self._next_progress_entry()
699
# Unversion IDs that were found to be deleted
546
deleted_paths = set()
547
for path, ie in self.work_inv.iter_entries():
548
if is_inside_any(deleted_paths, path):
549
# The tree will delete the required ids recursively.
551
if specific and not is_inside_any(specific, path):
553
if not self.work_tree.has_filename(path):
554
deleted_paths.add(path)
555
self.reporter.missing(path)
556
deleted_ids.append(ie.file_id)
700
557
self.work_tree.unversion(deleted_ids)
702
def _record_unselected(self):
703
# If specific files are selected, then all un-selected files must be
704
# recorded in their previous state. For more details, see
705
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
706
if self.specific_files or self.exclude:
707
specific_files = self.specific_files or []
708
for path, old_ie in self.basis_inv.iter_entries():
709
if old_ie.file_id in self.builder.new_inventory:
710
# already added - skip.
712
if (is_inside_any(specific_files, path)
713
and not is_inside_any(self.exclude, path)):
714
# was inside the selected path, and not excluded - if not
715
# present it has been deleted so skip.
717
# From here down it was either not selected, or was excluded:
718
# We preserve the entry unaltered.
720
# Note: specific file commits after a merge are currently
721
# prohibited. This test is for sanity/safety in case it's
722
# required after that changes.
723
if len(self.parents) > 1:
725
self.builder.record_entry_contents(ie, self.parent_invs, path,
726
self.basis_tree, None)
728
def _report_and_accumulate_deletes(self):
729
if (isinstance(self.basis_inv, Inventory)
730
and isinstance(self.builder.new_inventory, Inventory)):
731
# the older Inventory classes provide a _byid dict, and building a
732
# set from the keys of this dict is substantially faster than even
733
# getting a set of ids from the inventory
735
# <lifeless> set(dict) is roughly the same speed as
736
# set(iter(dict)) and both are significantly slower than
738
deleted_ids = set(self.basis_inv._byid.keys()) - \
739
set(self.builder.new_inventory._byid.keys())
741
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
743
self.any_entries_deleted = True
744
deleted = [(self.basis_tree.id2path(file_id), file_id)
745
for file_id in deleted_ids]
747
# XXX: this is not quite directory-order sorting
748
for path, file_id in deleted:
749
self.builder.record_delete(path, file_id)
750
self.reporter.deleted(path)
752
def _check_strict(self):
753
# XXX: when we use iter_changes this would likely be faster if
754
# iter_changes would check for us (even in the presence of
757
# raise an exception as soon as we find a single unknown.
758
for unknown in self.work_tree.unknowns():
759
raise StrictCommitFailed()
761
def _populate_from_inventory(self):
762
"""Populate the CommitBuilder by walking the working tree inventory."""
763
# Build the revision inventory.
765
# This starts by creating a new empty inventory. Depending on
766
# which files are selected for commit, and what is present in the
767
# current tree, the new inventory is populated. inventory entries
768
# which are candidates for modification have their revision set to
769
# None; inventory entries that are carried over untouched have their
770
# revision set to their prior value.
559
def _populate_new_inv(self):
560
"""Build revision inventory.
562
This creates a new empty inventory. Depending on
563
which files are selected for commit, and what is present in the
564
current tree, the new inventory is populated. inventory entries
565
which are candidates for modification have their revision set to
566
None; inventory entries that are carried over untouched have their
567
revision set to their prior value.
772
569
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
773
570
# results to create a new inventory at the same time, which results
774
571
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
775
572
# ADHB 11-07-2006
777
specific_files = self.specific_files
778
exclude = self.exclude
779
report_changes = self.reporter.is_verbose()
781
# A tree of paths that have been deleted. E.g. if foo/bar has been
782
# deleted, then we have {'foo':{'bar':{}}}
784
# XXX: Note that entries may have the wrong kind because the entry does
785
# not reflect the status on disk.
786
work_inv = self.work_tree.inventory
787
# NB: entries will include entries within the excluded ids/paths
788
# because iter_entries_by_dir has no 'exclude' facility today.
789
entries = work_inv.iter_entries_by_dir(
790
specific_file_ids=self.specific_file_ids, yield_parents=True)
791
for path, existing_ie in entries:
792
file_id = existing_ie.file_id
793
name = existing_ie.name
794
parent_id = existing_ie.parent_id
795
kind = existing_ie.kind
796
# Skip files that have been deleted from the working tree.
797
# The deleted path ids are also recorded so they can be explicitly
800
path_segments = splitpath(path)
801
deleted_dict = deleted_paths
802
for segment in path_segments:
803
deleted_dict = deleted_dict.get(segment, None)
805
# We either took a path not present in the dict
806
# (deleted_dict was None), or we've reached an empty
807
# child dir in the dict, so are now a sub-path.
811
if deleted_dict is not None:
812
# the path has a deleted parent, do not add it.
814
if exclude and is_inside_any(exclude, path):
815
# Skip excluded paths. Excluded paths are processed by
816
# _update_builder_with_changes.
818
content_summary = self.work_tree.path_content_summary(path)
819
# Note that when a filter of specific files is given, we must only
820
# skip/record deleted files matching that filter.
821
if not specific_files or is_inside_any(specific_files, path):
822
if content_summary[0] == 'missing':
823
if not deleted_paths:
824
# path won't have been split yet.
825
path_segments = splitpath(path)
826
deleted_dict = deleted_paths
827
for segment in path_segments:
828
deleted_dict = deleted_dict.setdefault(segment, {})
829
self.reporter.missing(path)
830
self._next_progress_entry()
831
deleted_ids.append(file_id)
833
# TODO: have the builder do the nested commit just-in-time IF and
835
if content_summary[0] == 'tree-reference':
836
# enforce repository nested tree policy.
837
if (not self.work_tree.supports_tree_reference() or
838
# repository does not support it either.
839
not self.branch.repository._format.supports_tree_reference):
840
content_summary = ('directory',) + content_summary[1:]
841
kind = content_summary[0]
842
# TODO: specific_files filtering before nested tree processing
843
if kind == 'tree-reference':
844
if self.recursive == 'down':
845
nested_revision_id = self._commit_nested_tree(
847
content_summary = content_summary[:3] + (
850
content_summary = content_summary[:3] + (
851
self.work_tree.get_reference_revision(file_id),)
853
# Record an entry for this item
854
# Note: I don't particularly want to have the existing_ie
855
# parameter but the test suite currently (28-Jun-07) breaks
856
# without it thanks to a unicode normalisation issue. :-(
857
definitely_changed = kind != existing_ie.kind
858
self._record_entry(path, file_id, specific_files, kind, name,
859
parent_id, definitely_changed, existing_ie, report_changes,
862
# Unversion IDs that were found to be deleted
863
self.work_tree.unversion(deleted_ids)
865
def _commit_nested_tree(self, file_id, path):
866
"Commit a nested tree."
867
sub_tree = self.work_tree.get_nested_tree(file_id, path)
868
# FIXME: be more comprehensive here:
869
# this works when both trees are in --trees repository,
870
# but when both are bound to a different repository,
871
# it fails; a better way of approaching this is to
872
# finally implement the explicit-caches approach design
873
# a while back - RBC 20070306.
874
if sub_tree.branch.repository.has_same_location(
875
self.work_tree.branch.repository):
876
sub_tree.branch.repository = \
877
self.work_tree.branch.repository
879
return sub_tree.commit(message=None, revprops=self.revprops,
880
recursive=self.recursive,
881
message_callback=self.message_callback,
882
timestamp=self.timestamp, timezone=self.timezone,
883
committer=self.committer,
884
allow_pointless=self.allow_pointless,
885
strict=self.strict, verbose=self.verbose,
886
local=self.local, reporter=self.reporter)
887
except errors.PointlessCommit:
888
return self.work_tree.get_reference_revision(file_id)
890
def _record_entry(self, path, file_id, specific_files, kind, name,
891
parent_id, definitely_changed, existing_ie, report_changes,
893
"Record the new inventory entry for a path if any."
894
# mutter('check %s {%s}', path, file_id)
895
# mutter('%s selected for commit', path)
896
if definitely_changed or existing_ie is None:
897
ie = make_entry(kind, name, parent_id, file_id)
899
ie = existing_ie.copy()
573
mutter("Selecting files for commit with filter %s", self.specific_files)
574
assert self.work_inv.root is not None
575
entries = self.work_inv.iter_entries()
576
if not self.builder.record_root_entry:
577
symbol_versioning.warn('CommitBuilders should support recording'
578
' the root entry as of bzr 0.10.', DeprecationWarning,
580
self.builder.new_inventory.add(self.basis_inv.root.copy())
582
self._emit_progress_update()
583
for path, new_ie in entries:
584
self._emit_progress_update()
585
file_id = new_ie.file_id
587
kind = self.work_tree.kind(file_id)
588
if kind != new_ie.kind:
589
new_ie = inventory.make_entry(kind, new_ie.name,
590
new_ie.parent_id, file_id)
591
except errors.NoSuchFile:
593
# mutter('check %s {%s}', path, file_id)
594
if (not self.specific_files or
595
is_inside_or_parent_of_any(self.specific_files, path)):
596
# mutter('%s selected for commit', path)
600
# mutter('%s not selected for commit', path)
601
if self.basis_inv.has_id(file_id):
602
ie = self.basis_inv[file_id].copy()
604
# this entry is new and not being committed
606
self.builder.record_entry_contents(ie, self.parent_invs,
607
path, self.work_tree)
608
# describe the nature of the change that has occurred relative to
609
# the basis inventory.
610
if (self.basis_inv.has_id(ie.file_id)):
611
basis_ie = self.basis_inv[ie.file_id]
614
change = ie.describe_change(basis_ie, ie)
615
if change in (InventoryEntry.RENAMED,
616
InventoryEntry.MODIFIED_AND_RENAMED):
617
old_path = self.basis_inv.id2path(ie.file_id)
618
self.reporter.renamed(change, old_path, path)
620
self.reporter.snapshot_change(change, path)
622
if not self.specific_files:
625
# ignore removals that don't match filespec
626
for path, new_ie in self.basis_inv.iter_entries():
627
if new_ie.file_id in self.work_inv:
629
if is_inside_any(self.specific_files, path):
900
632
ie.revision = None
901
# For carried over entries we don't care about the fs hash - the repo
902
# isn't generating a sha, so we're not saving computation time.
903
_, _, fs_hash = self.builder.record_entry_contents(
904
ie, self.parent_invs, path, self.work_tree, content_summary)
906
self._report_change(ie, path)
908
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
911
def _report_change(self, ie, path):
912
"""Report a change to the user.
914
The change that has occurred is described relative to the basis
917
if (self.basis_inv.has_id(ie.file_id)):
918
basis_ie = self.basis_inv[ie.file_id]
921
change = ie.describe_change(basis_ie, ie)
922
if change in (InventoryEntry.RENAMED,
923
InventoryEntry.MODIFIED_AND_RENAMED):
924
old_path = self.basis_inv.id2path(ie.file_id)
925
self.reporter.renamed(change, old_path, path)
926
self._next_progress_entry()
928
if change == 'unchanged':
930
self.reporter.snapshot_change(change, path)
931
self._next_progress_entry()
933
def _set_progress_stage(self, name, counter=False):
934
"""Set the progress stage and emit an update to the progress bar."""
935
self.pb_stage_name = name
936
self.pb_stage_count += 1
938
self.pb_entries_count = 0
940
self.pb_entries_count = None
941
self._emit_progress()
943
def _next_progress_entry(self):
944
"""Emit an update to the progress bar and increment the entry count."""
945
self.pb_entries_count += 1
946
self._emit_progress()
948
def _emit_progress(self):
949
if self.pb_entries_count is not None:
950
text = "%s [%d] - Stage" % (self.pb_stage_name,
951
self.pb_entries_count)
953
text = "%s - Stage" % (self.pb_stage_name, )
954
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
956
def _set_specific_file_ids(self):
957
"""populate self.specific_file_ids if we will use it."""
958
if not self.use_record_iter_changes:
959
# If provided, ensure the specified files are versioned
960
if self.specific_files is not None:
961
# Note: This routine is being called because it raises
962
# PathNotVersionedError as a side effect of finding the IDs. We
963
# later use the ids we found as input to the working tree
964
# inventory iterator, so we only consider those ids rather than
965
# examining the whole tree again.
966
# XXX: Dont we have filter_unversioned to do this more
968
self.specific_file_ids = tree.find_ids_across_trees(
969
self.specific_files, [self.basis_tree, self.work_tree])
971
self.specific_file_ids = None
633
self.builder.record_entry_contents(ie, self.parent_invs, path,
636
def _emit_progress_update(self):
637
"""Emit an update to the progress bar."""
638
self.pb.update("Committing", self.pb_count, self.pb_total)
641
def _report_deletes(self):
642
for path, ie in self.basis_inv.iter_entries():
643
if ie.file_id not in self.builder.new_inventory:
644
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
