206
message_callback=None,
209
185
"""Commit working copy as a new revision.
211
:param message: the commit message (it or message_callback is required)
213
:param timestamp: if not None, seconds-since-epoch for a
214
postdated/predated commit.
216
:param specific_files: If true, commit only those files.
218
:param rev_id: If set, use this as the new revision id.
187
branch -- the deprecated branch to commit to. New callers should pass in
190
message -- the commit message, a mandatory parameter
192
timestamp -- if not None, seconds-since-epoch for a
193
postdated/predated commit.
195
specific_files -- If true, commit only those files.
197
rev_id -- If set, use this as the new revision id.
219
198
Useful for test or import commands that need to tightly
220
199
control what revisions are assigned. If you duplicate
221
200
a revision id that exists elsewhere it is your own fault.
222
201
If null (default), a time/random revision id is generated.
224
:param allow_pointless: If true (default), commit even if nothing
203
allow_pointless -- If true (default), commit even if nothing
225
204
has changed and no merges are recorded.
227
:param strict: If true, don't allow a commit if the working tree
206
strict -- If true, don't allow a commit if the working tree
228
207
contains unknown files.
230
:param revprops: Properties for new revision
231
:param local: Perform a local only commit.
232
:param reporter: the reporter to use or None for the default
233
:param verbose: if True and the reporter is not None, report everything
234
:param recursive: If set to 'down', commit in any subtrees that have
235
pending changes of any sort during this commit.
236
:param exclude: None or a list of relative paths to exclude from the
237
commit. Pending changes to excluded files will be ignored by the
209
revprops -- Properties for new revision
240
211
mutter('preparing to commit')
242
if working_tree is None:
243
raise BzrError("working_tree must be passed into commit().")
213
if deprecated_passed(branch):
214
warn("Commit.commit (branch, ...): The branch parameter is "
215
"deprecated as of bzr 0.8. Please use working_tree= instead.",
216
DeprecationWarning, stacklevel=2)
218
self.work_tree = self.branch.bzrdir.open_workingtree()
219
elif working_tree is None:
220
raise BzrError("One of branch and working_tree must be passed into commit().")
245
222
self.work_tree = working_tree
246
223
self.branch = self.work_tree.branch
247
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
248
if not self.branch.repository.supports_rich_root():
249
raise errors.RootNotRich()
250
if message_callback is None:
251
if message is not None:
252
if isinstance(message, str):
253
message = message.decode(get_user_encoding())
254
message_callback = lambda x: message
256
raise BzrError("The message or message_callback keyword"
257
" parameter is required for commit().")
225
raise BzrError("The message keyword parameter is required for commit().")
259
self.bound_branch = None
260
self.any_entries_changed = False
261
self.any_entries_deleted = False
262
if exclude is not None:
263
self.exclude = sorted(
264
minimum_path_selection(exclude))
268
self.master_branch = None
269
self.master_locked = False
270
self.recursive = recursive
272
if specific_files is not None:
273
self.specific_files = sorted(
274
minimum_path_selection(specific_files))
276
self.specific_files = None
277
self.specific_file_ids = None
227
self.weave_store = self.branch.repository.weave_store
229
self.specific_files = specific_files
278
230
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
286
# accumulates an inventory delta to the basis entry, so we can make
287
# just the necessary updates to the workingtree's cached basis.
288
self._basis_delta = []
290
self.work_tree.lock_write()
291
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
292
self.basis_revid = self.work_tree.last_revision()
293
self.basis_tree = self.work_tree.basis_tree()
294
self.basis_tree.lock_read()
231
self.revprops = {'branch-nick': self.branch.nick}
233
self.revprops.update(revprops)
235
# check for out of date working trees
236
if self.work_tree.last_revision() != self.branch.last_revision():
237
raise errors.OutOfDateTree(self.work_tree)
240
# raise an exception as soon as we find a single unknown.
241
for unknown in self.work_tree.unknowns():
242
raise StrictCommitFailed()
244
if timestamp is None:
245
self.timestamp = time.time()
247
self.timestamp = long(timestamp)
249
if self.config is None:
250
self.config = bzrlib.config.BranchConfig(self.branch)
253
self.rev_id = _gen_revision_id(self.config, self.timestamp)
257
if committer is None:
258
self.committer = self.config.username()
260
assert isinstance(committer, basestring), type(committer)
261
self.committer = committer
264
self.timezone = local_time_offset()
266
self.timezone = int(timezone)
268
if isinstance(message, str):
269
message = message.decode(bzrlib.user_encoding)
270
assert isinstance(message, unicode), type(message)
271
self.message = message
272
self._escape_commit_message()
274
self.branch.lock_write()
296
# Cannot commit with conflicts present.
297
if len(self.work_tree.conflicts()) > 0:
298
raise ConflictsInTree
300
# Setup the bound branch variables as needed.
301
self._check_bound_branch()
303
# Check that the working tree is up to date
304
old_revno, new_revno = self._check_out_of_date_tree()
306
# Complete configuration setup
307
if reporter is not None:
308
self.reporter = reporter
309
elif self.reporter is None:
310
self.reporter = self._select_reporter()
311
if self.config is None:
312
self.config = self.branch.get_config()
314
# If provided, ensure the specified files are versioned
315
if self.specific_files is not None:
316
# Note: This routine is being called because it raises
317
# PathNotVersionedError as a side effect of finding the IDs. We
318
# later use the ids we found as input to the working tree
319
# inventory iterator, so we only consider those ids rather than
320
# examining the whole tree again.
321
# XXX: Dont we have filter_unversioned to do this more
323
self.specific_file_ids = tree.find_ids_across_trees(
324
specific_files, [self.basis_tree, self.work_tree])
326
# Setup the progress bar. As the number of files that need to be
327
# committed in unknown, progress is reported as stages.
328
# We keep track of entries separately though and include that
329
# information in the progress bar during the relevant stages.
330
self.pb_stage_name = ""
331
self.pb_stage_count = 0
332
self.pb_stage_total = 5
333
if self.bound_branch:
334
self.pb_stage_total += 1
335
self.pb.show_pct = False
336
self.pb.show_spinner = False
337
self.pb.show_eta = False
338
self.pb.show_count = True
339
self.pb.show_bar = True
276
self.work_inv = self.work_tree.inventory
277
self.basis_tree = self.work_tree.basis_tree()
341
278
self.basis_inv = self.basis_tree.inventory
342
280
self._gather_parents()
343
# After a merge, a selected file commit is not supported.
344
# See 'bzr help merge' for an explanation as to why.
345
281
if len(self.parents) > 1 and self.specific_files:
346
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
347
# Excludes are a form of selected file commit.
348
if len(self.parents) > 1 and self.exclude:
349
raise errors.CannotCommitSelectedFileMerge(self.exclude)
351
# Collect the changes
352
self._set_progress_stage("Collecting changes",
353
entries_title="Directory")
354
self.builder = self.branch.get_commit_builder(self.parents,
355
self.config, timestamp, timezone, committer, revprops, rev_id)
282
raise NotImplementedError('selected-file commit of merges is not supported yet')
283
self._check_parents_present()
358
# find the location being committed to
359
if self.bound_branch:
360
master_location = self.master_branch.base
362
master_location = self.branch.base
364
# report the start of the commit
365
self.reporter.started(new_revno, self.rev_id, master_location)
367
self._update_builder_with_changes()
368
self._report_and_accumulate_deletes()
369
self._check_pointless()
371
# TODO: Now the new inventory is known, check for conflicts.
372
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
373
# weave lines, because nothing should be recorded until it is known
374
# that commit will succeed.
375
self._set_progress_stage("Saving data locally")
376
self.builder.finish_inventory()
378
# Prompt the user for a commit message if none provided
379
message = message_callback(self)
380
self.message = message
381
self._escape_commit_message()
383
# Add revision data to the local branch
384
self.rev_id = self.builder.commit(self.message)
390
self._process_pre_hooks(old_revno, new_revno)
392
# Upload revision data to the master.
393
# this will propagate merged revisions too if needed.
394
if self.bound_branch:
395
if not self.master_branch.repository.has_same_location(
396
self.branch.repository):
397
self._set_progress_stage("Uploading data to master branch")
398
self.master_branch.repository.fetch(self.branch.repository,
399
revision_id=self.rev_id)
400
# now the master has the revision data
401
# 'commit' to the master first so a timeout here causes the
402
# local branch to be out of date
403
self.master_branch.set_last_revision_info(new_revno,
406
# and now do the commit locally.
407
self.branch.set_last_revision_info(new_revno, self.rev_id)
409
# Make the working tree up to date with the branch
410
self._set_progress_stage("Updating the working tree")
411
self.work_tree.update_basis_by_delta(self.rev_id,
413
self.reporter.completed(new_revno, self.rev_id)
414
self._process_post_hooks(old_revno, new_revno)
285
self._remove_deleted()
286
self._populate_new_inv()
287
self._store_snapshot()
288
self._report_deletes()
290
if not (self.allow_pointless
291
or len(self.parents) > 1
292
or self.new_inv != self.basis_inv):
293
raise PointlessCommit()
295
if len(list(self.work_tree.iter_conflicts()))>0:
296
raise ConflictsInTree
298
self._record_inventory()
299
self._make_revision()
300
self.work_tree.set_pending_merges([])
301
self.branch.append_revision(self.rev_id)
302
if len(self.parents):
303
precursor = self.parents[0]
306
self.work_tree.set_last_revision(self.rev_id, precursor)
307
self.reporter.completed(self.branch.revno()+1, self.rev_id)
308
if self.config.post_commit() is not None:
309
hooks = self.config.post_commit().split(' ')
310
# this would be nicer with twisted.python.reflect.namedAny
312
result = eval(hook + '(branch, rev_id)',
313
{'branch':self.branch,
315
'rev_id':self.rev_id})
419
def _select_reporter(self):
420
"""Select the CommitReporter to use."""
422
return NullCommitReporter()
423
return ReportCommitToLog()
425
def _check_pointless(self):
426
if self.allow_pointless:
428
# A merge with no effect on files
429
if len(self.parents) > 1:
431
# TODO: we could simplify this by using self._basis_delta.
433
# The initial commit adds a root directory, but this in itself is not
434
# a worthwhile commit.
435
if (self.basis_revid == revision.NULL_REVISION and
436
len(self.builder.new_inventory) == 1):
437
raise PointlessCommit()
438
# If length == 1, then we only have the root entry. Which means
439
# that there is no real difference (only the root could be different)
440
# unless deletes occured, in which case the length is irrelevant.
441
if (self.any_entries_deleted or
442
(len(self.builder.new_inventory) != 1 and
443
self.any_entries_changed)):
445
raise PointlessCommit()
447
def _check_bound_branch(self):
448
"""Check to see if the local branch is bound.
450
If it is bound, then most of the commit will actually be
451
done using the remote branch as the target branch.
452
Only at the end will the local branch be updated.
454
if self.local and not self.branch.get_bound_location():
455
raise errors.LocalRequiresBoundBranch()
458
self.master_branch = self.branch.get_master_branch()
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
self.master_locked = True
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)
579
"""Cleanup any open locks, progress bars etc."""
580
cleanups = [self._cleanup_bound_branch,
581
self.basis_tree.unlock,
582
self.work_tree.unlock,
584
found_exception = None
585
for cleanup in cleanups:
588
# we want every cleanup to run no matter what.
589
# so we have a catchall here, but we will raise the
590
# last encountered exception up the stack: and
591
# typically this will be useful enough.
594
if found_exception is not None:
595
# don't do a plan raise, because the last exception may have been
596
# trashed, e is our sure-to-work exception even though it loses the
597
# full traceback. XXX: RBC 20060421 perhaps we could check the
598
# exc_info and if its the same one do a plain raise otherwise
599
# 'raise e' as we do now.
602
def _cleanup_bound_branch(self):
603
"""Executed at the end of a try/finally to cleanup a bound branch.
605
If the branch wasn't bound, this is a no-op.
606
If it was, it resents self.branch to the local branch, instead
609
if not self.bound_branch:
611
if self.master_locked:
612
self.master_branch.unlock()
319
def _record_inventory(self):
320
"""Store the inventory for the new revision."""
321
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
322
self.inv_sha1 = sha_string(inv_text)
323
s = self.branch.repository.control_weaves
324
s.add_text('inventory', self.rev_id,
325
split_lines(inv_text), self.present_parents,
326
self.branch.get_transaction())
614
328
def _escape_commit_message(self):
615
329
"""Replace xml-incompatible control characters."""
616
# FIXME: RBC 20060419 this should be done by the revision
617
# serialiser not by commit. Then we can also add an unescaper
618
# in the deserializer and start roundtripping revision messages
619
# precisely. See repository_implementations/test_repository.py
621
330
# Python strings can include characters that can't be
622
331
# represented in well-formed XML; escape characters that
623
332
# aren't listed in the XML specification
632
341
def _gather_parents(self):
633
342
"""Record the parents of a merge for merge detection."""
634
# TODO: Make sure that this list doesn't contain duplicate
635
# entries and the order is preserved when doing this.
636
self.parents = self.work_tree.get_parent_ids()
637
self.parent_invs = [self.basis_inv]
638
for revision in self.parents[1:]:
343
pending_merges = self.work_tree.pending_merges()
345
self.parent_invs = []
346
self.present_parents = []
347
precursor_id = self.branch.last_revision()
349
self.parents.append(precursor_id)
350
self.parents += pending_merges
351
for revision in self.parents:
639
352
if self.branch.repository.has_revision(revision):
640
mutter('commit parent revision {%s}', revision)
641
353
inventory = self.branch.repository.get_inventory(revision)
642
354
self.parent_invs.append(inventory)
644
mutter('commit parent ghost revision {%s}', revision)
646
def _update_builder_with_changes(self):
647
"""Update the commit builder with the data about what has changed.
355
self.present_parents.append(revision)
357
def _check_parents_present(self):
358
for parent_id in self.parents:
359
mutter('commit parent revision {%s}', parent_id)
360
if not self.branch.repository.has_revision(parent_id):
361
if parent_id == self.branch.last_revision():
362
warning("parent is missing %r", parent_id)
363
raise HistoryMissing(self.branch, 'revision', parent_id)
365
mutter("commit will ghost revision %r", parent_id)
367
def _make_revision(self):
368
"""Record a new revision object for this commit."""
369
self.rev = Revision(timestamp=self.timestamp,
370
timezone=self.timezone,
371
committer=self.committer,
372
message=self.message,
373
inventory_sha1=self.inv_sha1,
374
revision_id=self.rev_id,
375
properties=self.revprops)
376
self.rev.parent_ids = self.parents
378
serializer_v5.write_revision(self.rev, rev_tmp)
380
if self.config.signature_needed():
381
plaintext = Testament(self.rev, self.new_inv).as_short_text()
382
self.branch.repository.store_revision_signature(
383
gpg.GPGStrategy(self.config), plaintext, self.rev_id)
384
self.branch.repository.revision_store.add(rev_tmp, self.rev_id)
385
mutter('new revision_id is {%s}', self.rev_id)
387
def _remove_deleted(self):
388
"""Remove deleted files from the working inventories.
390
This is done prior to taking the working inventory as the
391
basis for the new committed inventory.
393
This returns true if any files
394
*that existed in the basis inventory* were deleted.
395
Files that were added and deleted
396
in the working copy don't matter.
649
# Build the revision inventory.
651
# This starts by creating a new empty inventory. Depending on
652
# which files are selected for commit, and what is present in the
653
# current tree, the new inventory is populated. inventory entries
654
# which are candidates for modification have their revision set to
655
# None; inventory entries that are carried over untouched have their
656
# revision set to their prior value.
658
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
659
# results to create a new inventory at the same time, which results
660
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
663
exclude = self.exclude
664
specific_files = self.specific_files or []
665
mutter("Selecting files for commit with filter %s", specific_files)
667
# Build the new inventory
668
self._populate_from_inventory()
670
# If specific files are selected, then all un-selected files must be
671
# recorded in their previous state. For more details, see
672
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
673
if specific_files or exclude:
674
for path, old_ie in self.basis_inv.iter_entries():
675
if old_ie.file_id in self.builder.new_inventory:
676
# already added - skip.
678
if (is_inside_any(specific_files, path)
679
and not is_inside_any(exclude, path)):
680
# was inside the selected path, and not excluded - if not
681
# present it has been deleted so skip.
683
# From here down it was either not selected, or was excluded:
684
if old_ie.kind == 'directory':
685
self._next_progress_entry()
686
# We preserve the entry unaltered.
688
# Note: specific file commits after a merge are currently
689
# prohibited. This test is for sanity/safety in case it's
690
# required after that changes.
691
if len(self.parents) > 1:
693
delta, version_recorded, _ = self.builder.record_entry_contents(
694
ie, self.parent_invs, path, self.basis_tree, None)
696
self.any_entries_changed = True
698
self._basis_delta.append(delta)
700
def _report_and_accumulate_deletes(self):
701
# XXX: Could the list of deleted paths and ids be instead taken from
702
# _populate_from_inventory?
703
deleted_ids = set(self.basis_inv._byid.keys()) - \
704
set(self.builder.new_inventory._byid.keys())
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._basis_delta.append((path, None, file_id, None))
713
self.reporter.deleted(path)
715
def _populate_from_inventory(self):
716
"""Populate the CommitBuilder by walking the working tree inventory."""
718
# raise an exception as soon as we find a single unknown.
719
for unknown in self.work_tree.unknowns():
720
raise StrictCommitFailed()
722
specific_files = self.specific_files
723
exclude = self.exclude
724
report_changes = self.reporter.is_verbose()
398
specific = self.specific_files
726
# A tree of paths that have been deleted. E.g. if foo/bar has been
727
# deleted, then we have {'foo':{'bar':{}}}
729
# XXX: Note that entries may have the wrong kind because the entry does
730
# not reflect the status on disk.
731
work_inv = self.work_tree.inventory
732
# NB: entries will include entries within the excluded ids/paths
733
# because iter_entries_by_dir has no 'exclude' facility today.
734
entries = work_inv.iter_entries_by_dir(
735
specific_file_ids=self.specific_file_ids, yield_parents=True)
736
for path, existing_ie in entries:
737
file_id = existing_ie.file_id
738
name = existing_ie.name
739
parent_id = existing_ie.parent_id
740
kind = existing_ie.kind
741
if kind == 'directory':
742
self._next_progress_entry()
743
# Skip files that have been deleted from the working tree.
744
# The deleted path ids are also recorded so they can be explicitly
747
path_segments = splitpath(path)
748
deleted_dict = deleted_paths
749
for segment in path_segments:
750
deleted_dict = deleted_dict.get(segment, None)
752
# We either took a path not present in the dict
753
# (deleted_dict was None), or we've reached an empty
754
# child dir in the dict, so are now a sub-path.
758
if deleted_dict is not None:
759
# the path has a deleted parent, do not add it.
761
if exclude and is_inside_any(exclude, path):
762
# Skip excluded paths. Excluded paths are processed by
763
# _update_builder_with_changes.
400
for path, ie in self.work_inv.iter_entries():
401
if specific and not is_inside_any(specific, path):
765
content_summary = self.work_tree.path_content_summary(path)
766
# Note that when a filter of specific files is given, we must only
767
# skip/record deleted files matching that filter.
768
if not specific_files or is_inside_any(specific_files, path):
769
if content_summary[0] == 'missing':
770
if not deleted_paths:
771
# path won't have been split yet.
772
path_segments = splitpath(path)
773
deleted_dict = deleted_paths
774
for segment in path_segments:
775
deleted_dict = deleted_dict.setdefault(segment, {})
776
self.reporter.missing(path)
777
deleted_ids.append(file_id)
403
if not self.work_tree.has_filename(path):
404
self.reporter.missing(path)
405
deleted_ids.append((path, ie.file_id))
407
deleted_ids.sort(reverse=True)
408
for path, file_id in deleted_ids:
409
del self.work_inv[file_id]
410
self.work_tree._write_inventory(self.work_inv)
412
def _store_snapshot(self):
413
"""Pass over inventory and record a snapshot.
415
Entries get a new revision when they are modified in
416
any way, which includes a merge with a new set of
417
parents that have the same entry.
419
# XXX: Need to think more here about when the user has
420
# made a specific decision on a particular value -- c.f.
422
for path, ie in self.new_inv.iter_entries():
423
previous_entries = ie.find_previous_heads(
425
self.weave_store.get_weave_prelude_or_empty(ie.file_id,
426
self.branch.get_transaction()))
427
if ie.revision is None:
428
change = ie.snapshot(self.rev_id, path, previous_entries,
429
self.work_tree, self.weave_store,
430
self.branch.get_transaction())
433
self.reporter.snapshot_change(change, path)
435
def _populate_new_inv(self):
436
"""Build revision inventory.
438
This creates a new empty inventory. Depending on
439
which files are selected for commit, and what is present in the
440
current tree, the new inventory is populated. inventory entries
441
which are candidates for modification have their revision set to
442
None; inventory entries that are carried over untouched have their
443
revision set to their prior value.
445
mutter("Selecting files for commit with filter %s", self.specific_files)
446
self.new_inv = Inventory()
447
for path, new_ie in self.work_inv.iter_entries():
448
file_id = new_ie.file_id
449
mutter('check %s {%s}', path, new_ie.file_id)
450
if self.specific_files:
451
if not is_inside_any(self.specific_files, path):
452
mutter('%s not selected for commit', path)
453
self._carry_entry(file_id)
779
# TODO: have the builder do the nested commit just-in-time IF and
781
if content_summary[0] == 'tree-reference':
782
# enforce repository nested tree policy.
783
if (not self.work_tree.supports_tree_reference() or
784
# repository does not support it either.
785
not self.branch.repository._format.supports_tree_reference):
786
content_summary = ('directory',) + content_summary[1:]
787
kind = content_summary[0]
788
# TODO: specific_files filtering before nested tree processing
789
if kind == 'tree-reference':
790
if self.recursive == 'down':
791
nested_revision_id = self._commit_nested_tree(
793
content_summary = content_summary[:3] + (
796
content_summary = content_summary[:3] + (
797
self.work_tree.get_reference_revision(file_id),)
799
# Record an entry for this item
800
# Note: I don't particularly want to have the existing_ie
801
# parameter but the test suite currently (28-Jun-07) breaks
802
# without it thanks to a unicode normalisation issue. :-(
803
definitely_changed = kind != existing_ie.kind
804
self._record_entry(path, file_id, specific_files, kind, name,
805
parent_id, definitely_changed, existing_ie, report_changes,
808
# Unversion IDs that were found to be deleted
809
self.work_tree.unversion(deleted_ids)
811
def _commit_nested_tree(self, file_id, path):
812
"Commit a nested tree."
813
sub_tree = self.work_tree.get_nested_tree(file_id, path)
814
# FIXME: be more comprehensive here:
815
# this works when both trees are in --trees repository,
816
# but when both are bound to a different repository,
817
# it fails; a better way of approaching this is to
818
# finally implement the explicit-caches approach design
819
# a while back - RBC 20070306.
820
if sub_tree.branch.repository.has_same_location(
821
self.work_tree.branch.repository):
822
sub_tree.branch.repository = \
823
self.work_tree.branch.repository
825
return sub_tree.commit(message=None, revprops=self.revprops,
826
recursive=self.recursive,
827
message_callback=self.message_callback,
828
timestamp=self.timestamp, timezone=self.timezone,
829
committer=self.committer,
830
allow_pointless=self.allow_pointless,
831
strict=self.strict, verbose=self.verbose,
832
local=self.local, reporter=self.reporter)
833
except errors.PointlessCommit:
834
return self.work_tree.get_reference_revision(file_id)
836
def _record_entry(self, path, file_id, specific_files, kind, name,
837
parent_id, definitely_changed, existing_ie, report_changes,
839
"Record the new inventory entry for a path if any."
840
# mutter('check %s {%s}', path, file_id)
841
# mutter('%s selected for commit', path)
842
if definitely_changed or existing_ie is None:
843
ie = make_entry(kind, name, parent_id, file_id)
845
ie = existing_ie.copy()
847
# For carried over entries we don't care about the fs hash - the repo
848
# isn't generating a sha, so we're not saving computation time.
849
delta, version_recorded, fs_hash = self.builder.record_entry_contents(
850
ie, self.parent_invs, path, self.work_tree, content_summary)
852
self._basis_delta.append(delta)
854
self.any_entries_changed = True
856
self._report_change(ie, path)
858
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
456
# this is selected, ensure its parents are too.
457
parent_id = new_ie.parent_id
458
while parent_id != ROOT_ID:
459
if not self.new_inv.has_id(parent_id):
460
ie = self._select_entry(self.work_inv[parent_id])
461
mutter('%s selected for commit because of %s',
462
self.new_inv.id2path(parent_id), path)
464
ie = self.new_inv[parent_id]
465
if ie.revision is not None:
467
mutter('%s selected for commit because of %s',
468
self.new_inv.id2path(parent_id), path)
469
parent_id = ie.parent_id
470
mutter('%s selected for commit', path)
471
self._select_entry(new_ie)
473
def _select_entry(self, new_ie):
474
"""Make new_ie be considered for committing."""
861
def _report_change(self, ie, path):
862
"""Report a change to the user.
864
The change that has occurred is described relative to the basis
867
if (self.basis_inv.has_id(ie.file_id)):
868
basis_ie = self.basis_inv[ie.file_id]
871
change = ie.describe_change(basis_ie, ie)
872
if change in (InventoryEntry.RENAMED,
873
InventoryEntry.MODIFIED_AND_RENAMED):
874
old_path = self.basis_inv.id2path(ie.file_id)
875
self.reporter.renamed(change, old_path, path)
877
self.reporter.snapshot_change(change, path)
879
def _set_progress_stage(self, name, entries_title=None):
880
"""Set the progress stage and emit an update to the progress bar."""
881
self.pb_stage_name = name
882
self.pb_stage_count += 1
883
self.pb_entries_title = entries_title
884
if entries_title is not None:
885
self.pb_entries_count = 0
886
self.pb_entries_total = '?'
887
self._emit_progress()
889
def _next_progress_entry(self):
890
"""Emit an update to the progress bar and increment the entry count."""
891
self.pb_entries_count += 1
892
self._emit_progress()
894
def _emit_progress(self):
895
if self.pb_entries_title:
896
if self.pb_entries_total == '?':
897
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
898
self.pb_entries_title, self.pb_entries_count)
900
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
901
self.pb_entries_title, self.pb_entries_count,
902
str(self.pb_entries_total))
904
text = "%s - Stage" % (self.pb_stage_name)
905
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
480
def _carry_entry(self, file_id):
481
"""Carry the file unchanged from the basis revision."""
482
if self.basis_inv.has_id(file_id):
483
self.new_inv.add(self.basis_inv[file_id].copy())
485
def _report_deletes(self):
486
for file_id in self.basis_inv:
487
if file_id not in self.new_inv:
488
self.reporter.deleted(self.basis_inv.id2path(file_id))
490
def _gen_revision_id(config, when):
491
"""Return new revision-id."""
492
s = '%s-%s-' % (config.user_email(), compact_date(when))
493
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
