183
203
working_tree=None,
207
message_callback=None,
210
possible_master_transports=None):
187
211
"""Commit working copy as a new revision.
189
branch -- the deprecated branch to commit to. New callers should pass in
192
message -- the commit message, a mandatory parameter
194
timestamp -- if not None, seconds-since-epoch for a
195
postdated/predated commit.
197
specific_files -- If true, commit only those files.
199
rev_id -- If set, use this as the new revision id.
213
:param message: the commit message (it or message_callback is required)
215
:param timestamp: if not None, seconds-since-epoch for a
216
postdated/predated commit.
218
:param specific_files: If true, commit only those files.
220
:param rev_id: If set, use this as the new revision id.
200
221
Useful for test or import commands that need to tightly
201
222
control what revisions are assigned. If you duplicate
202
223
a revision id that exists elsewhere it is your own fault.
203
224
If null (default), a time/random revision id is generated.
205
allow_pointless -- If true (default), commit even if nothing
226
:param allow_pointless: If true (default), commit even if nothing
206
227
has changed and no merges are recorded.
208
strict -- If true, don't allow a commit if the working tree
229
:param strict: If true, don't allow a commit if the working tree
209
230
contains unknown files.
211
revprops -- Properties for new revision
232
:param revprops: Properties for new revision
212
233
:param local: Perform a local only commit.
234
:param reporter: the reporter to use or None for the default
235
:param verbose: if True and the reporter is not None, report everything
236
:param recursive: If set to 'down', commit in any subtrees that have
237
pending changes of any sort during this commit.
238
:param exclude: None or a list of relative paths to exclude from the
239
commit. Pending changes to excluded files will be ignored by the
214
242
mutter('preparing to commit')
216
if deprecated_passed(branch):
217
warn("Commit.commit (branch, ...): The branch parameter is "
218
"deprecated as of bzr 0.8. Please use working_tree= instead.",
219
DeprecationWarning, stacklevel=2)
221
self.work_tree = self.branch.bzrdir.open_workingtree()
222
elif working_tree is None:
223
raise BzrError("One of branch and working_tree must be passed into commit().")
244
if working_tree is None:
245
raise BzrError("working_tree must be passed into commit().")
225
247
self.work_tree = working_tree
226
248
self.branch = self.work_tree.branch
228
raise BzrError("The message keyword parameter is required for commit().")
249
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
250
if not self.branch.repository.supports_rich_root():
251
raise errors.RootNotRich()
252
if message_callback is None:
253
if message is not None:
254
if isinstance(message, str):
255
message = message.decode(get_user_encoding())
256
message_callback = lambda x: message
258
raise BzrError("The message or message_callback keyword"
259
" parameter is required for commit().")
230
self.weave_store = self.branch.repository.weave_store
231
261
self.bound_branch = None
262
self.any_entries_changed = False
263
self.any_entries_deleted = False
264
if exclude is not None:
265
self.exclude = sorted(
266
minimum_path_selection(exclude))
232
269
self.local = local
233
270
self.master_branch = None
234
271
self.master_locked = False
236
self.specific_files = specific_files
272
self.recursive = recursive
274
if specific_files is not None:
275
self.specific_files = sorted(
276
minimum_path_selection(specific_files))
278
self.specific_files = None
279
self.specific_file_ids = None
237
280
self.allow_pointless = allow_pointless
239
if revprops is not None:
240
self.revprops.update(revprops)
242
if reporter is None and self.reporter is None:
243
self.reporter = NullCommitReporter()
244
elif reporter is not None:
245
self.reporter = reporter
281
self.revprops = revprops
282
self.message_callback = message_callback
283
self.timestamp = timestamp
284
self.timezone = timezone
285
self.committer = committer
287
self.verbose = verbose
247
289
self.work_tree.lock_write()
290
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
291
self.basis_revid = self.work_tree.last_revision()
292
self.basis_tree = self.work_tree.basis_tree()
293
self.basis_tree.lock_read()
249
# setup the bound branch variables as needed.
250
self._check_bound_branch()
252
# check for out of date working trees
253
# if we are bound, then self.branch is the master branch and this
254
# test is thus all we need.
255
if self.work_tree.last_revision() != self.master_branch.last_revision():
256
raise errors.OutOfDateTree(self.work_tree)
259
# raise an exception as soon as we find a single unknown.
260
for unknown in self.work_tree.unknowns():
261
raise StrictCommitFailed()
263
if timestamp is None:
264
self.timestamp = time.time()
266
self.timestamp = long(timestamp)
295
# Cannot commit with conflicts present.
296
if len(self.work_tree.conflicts()) > 0:
297
raise ConflictsInTree
299
# Setup the bound branch variables as needed.
300
self._check_bound_branch(possible_master_transports)
302
# Check that the working tree is up to date
303
old_revno, new_revno = self._check_out_of_date_tree()
305
# Complete configuration setup
306
if reporter is not None:
307
self.reporter = reporter
308
elif self.reporter is None:
309
self.reporter = self._select_reporter()
268
310
if self.config is None:
269
self.config = bzrlib.config.BranchConfig(self.branch)
272
self.rev_id = _gen_revision_id(self.config, self.timestamp)
276
if committer is None:
277
self.committer = self.config.username()
279
assert isinstance(committer, basestring), type(committer)
280
self.committer = committer
283
self.timezone = local_time_offset()
285
self.timezone = int(timezone)
287
if isinstance(message, str):
288
message = message.decode(bzrlib.user_encoding)
289
assert isinstance(message, unicode), type(message)
290
self.message = message
291
self._escape_commit_message()
293
self.work_inv = self.work_tree.inventory
294
self.basis_tree = self.work_tree.basis_tree()
311
self.config = self.branch.get_config()
313
# If provided, ensure the specified files are versioned
314
if self.specific_files is not None:
315
# Note: This routine is being called because it raises
316
# PathNotVersionedError as a side effect of finding the IDs. We
317
# later use the ids we found as input to the working tree
318
# inventory iterator, so we only consider those ids rather than
319
# examining the whole tree again.
320
# XXX: Dont we have filter_unversioned to do this more
322
self.specific_file_ids = tree.find_ids_across_trees(
323
specific_files, [self.basis_tree, self.work_tree])
325
# Setup the progress bar. As the number of files that need to be
326
# committed in unknown, progress is reported as stages.
327
# We keep track of entries separately though and include that
328
# information in the progress bar during the relevant stages.
329
self.pb_stage_name = ""
330
self.pb_stage_count = 0
331
self.pb_stage_total = 5
332
if self.bound_branch:
333
self.pb_stage_total += 1
334
self.pb.show_pct = False
335
self.pb.show_spinner = False
336
self.pb.show_eta = False
337
self.pb.show_count = True
338
self.pb.show_bar = True
295
340
self.basis_inv = self.basis_tree.inventory
297
341
self._gather_parents()
342
# After a merge, a selected file commit is not supported.
343
# See 'bzr help merge' for an explanation as to why.
298
344
if len(self.parents) > 1 and self.specific_files:
299
raise NotImplementedError('selected-file commit of merges is not supported yet')
300
self._check_parents_present()
302
self._remove_deleted()
303
self._populate_new_inv()
304
self._store_snapshot()
305
self._report_deletes()
307
if not (self.allow_pointless
308
or len(self.parents) > 1
309
or self.new_inv != self.basis_inv):
310
raise PointlessCommit()
312
if len(self.work_tree.conflicts())>0:
313
raise ConflictsInTree
315
self.inv_sha1 = self.branch.repository.add_inventory(
320
self._make_revision()
321
# revision data is in the local branch now.
323
# upload revision data to the master.
324
# this will propogate merged revisions too if needed.
345
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
346
# Excludes are a form of selected file commit.
347
if len(self.parents) > 1 and self.exclude:
348
raise errors.CannotCommitSelectedFileMerge(self.exclude)
350
# Collect the changes
351
self._set_progress_stage("Collecting changes",
352
entries_title="Directory")
353
self.builder = self.branch.get_commit_builder(self.parents,
354
self.config, timestamp, timezone, committer, revprops, rev_id)
357
self.builder.will_record_deletes()
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)
387
mutter("aborting commit write group because of exception:")
388
trace.log_exception_quietly()
389
note("aborting commit write group: %r" % (e,))
393
self._process_pre_hooks(old_revno, new_revno)
395
# Upload revision data to the master.
396
# this will propagate merged revisions too if needed.
325
397
if self.bound_branch:
326
self.master_branch.repository.fetch(self.branch.repository,
327
revision_id=self.rev_id)
328
# now the master has the revision data
329
# 'commit' to the master first so a timeout here causes the local
330
# branch to be out of date
331
self.master_branch.append_revision(self.rev_id)
398
self._set_progress_stage("Uploading data to master branch")
399
# 'commit' to the master first so a timeout here causes the
400
# local branch to be out of date
401
self.master_branch.import_last_revision_info(
402
self.branch.repository, new_revno, self.rev_id)
333
404
# and now do the commit locally.
334
self.branch.append_revision(self.rev_id)
405
self.branch.set_last_revision_info(new_revno, self.rev_id)
336
self.work_tree.set_pending_merges([])
337
self.work_tree.set_last_revision(self.rev_id)
338
# now the work tree is up to date with the branch
340
self.reporter.completed(self.branch.revno(), self.rev_id)
341
if self.config.post_commit() is not None:
342
hooks = self.config.post_commit().split(' ')
343
# this would be nicer with twisted.python.reflect.namedAny
345
result = eval(hook + '(branch, rev_id)',
346
{'branch':self.branch,
348
'rev_id':self.rev_id})
407
# Make the working tree up to date with the branch
408
self._set_progress_stage("Updating the working tree")
409
self.work_tree.update_basis_by_delta(self.rev_id,
410
self.builder.get_basis_delta())
411
self.reporter.completed(new_revno, self.rev_id)
412
self._process_post_hooks(old_revno, new_revno)
350
self._cleanup_bound_branch()
351
self.work_tree.unlock()
353
def _check_bound_branch(self):
417
def _select_reporter(self):
418
"""Select the CommitReporter to use."""
420
return NullCommitReporter()
421
return ReportCommitToLog()
423
def _check_pointless(self):
424
if self.allow_pointless:
426
# A merge with no effect on files
427
if len(self.parents) > 1:
429
# TODO: we could simplify this by using self.builder.basis_delta.
431
# The initial commit adds a root directory, but this in itself is not
432
# a worthwhile commit.
433
if (self.basis_revid == revision.NULL_REVISION and
434
len(self.builder.new_inventory) == 1):
435
raise PointlessCommit()
436
# If length == 1, then we only have the root entry. Which means
437
# that there is no real difference (only the root could be different)
438
# unless deletes occured, in which case the length is irrelevant.
439
if (self.any_entries_deleted or
440
(len(self.builder.new_inventory) != 1 and
441
self.any_entries_changed)):
443
raise PointlessCommit()
445
def _check_bound_branch(self, possible_master_transports=None):
354
446
"""Check to see if the local branch is bound.
356
448
If it is bound, then most of the commit will actually be
391
484
self.bound_branch = self.branch
392
485
self.master_branch.lock_write()
393
486
self.master_locked = True
395
#### # Check to see if we have any pending merges. If we do
396
#### # those need to be pushed into the master branch
397
#### pending_merges = self.work_tree.pending_merges()
398
#### if pending_merges:
399
#### for revision_id in pending_merges:
400
#### self.master_branch.repository.fetch(self.bound_branch.repository,
401
#### revision_id=revision_id)
488
def _check_out_of_date_tree(self):
489
"""Check that the working tree is up to date.
491
:return: old_revision_number,new_revision_number tuple
494
first_tree_parent = self.work_tree.get_parent_ids()[0]
496
# if there are no parents, treat our parent as 'None'
497
# this is so that we still consider the master branch
498
# - in a checkout scenario the tree may have no
499
# parents but the branch may do.
500
first_tree_parent = bzrlib.revision.NULL_REVISION
501
old_revno, master_last = self.master_branch.last_revision_info()
502
if master_last != first_tree_parent:
503
if master_last != bzrlib.revision.NULL_REVISION:
504
raise errors.OutOfDateTree(self.work_tree)
505
if self.branch.repository.has_revision(first_tree_parent):
506
new_revno = old_revno + 1
508
# ghost parents never appear in revision history.
510
return old_revno,new_revno
512
def _process_pre_hooks(self, old_revno, new_revno):
513
"""Process any registered pre commit hooks."""
514
self._set_progress_stage("Running pre_commit hooks")
515
self._process_hooks("pre_commit", old_revno, new_revno)
517
def _process_post_hooks(self, old_revno, new_revno):
518
"""Process any registered post commit hooks."""
519
# Process the post commit hooks, if any
520
self._set_progress_stage("Running post_commit hooks")
521
# old style commit hooks - should be deprecated ? (obsoleted in
523
if self.config.post_commit() is not None:
524
hooks = self.config.post_commit().split(' ')
525
# this would be nicer with twisted.python.reflect.namedAny
527
result = eval(hook + '(branch, rev_id)',
528
{'branch':self.branch,
530
'rev_id':self.rev_id})
531
# process new style post commit hooks
532
self._process_hooks("post_commit", old_revno, new_revno)
534
def _process_hooks(self, hook_name, old_revno, new_revno):
535
if not Branch.hooks[hook_name]:
538
# new style commit hooks:
539
if not self.bound_branch:
540
hook_master = self.branch
543
hook_master = self.master_branch
544
hook_local = self.branch
545
# With bound branches, when the master is behind the local branch,
546
# the 'old_revno' and old_revid values here are incorrect.
547
# XXX: FIXME ^. RBC 20060206
549
old_revid = self.parents[0]
551
old_revid = bzrlib.revision.NULL_REVISION
553
if hook_name == "pre_commit":
554
future_tree = self.builder.revision_tree()
555
tree_delta = future_tree.changes_from(self.basis_tree,
558
for hook in Branch.hooks[hook_name]:
559
# show the running hook in the progress bar. As hooks may
560
# end up doing nothing (e.g. because they are not configured by
561
# the user) this is still showing progress, not showing overall
562
# actions - its up to each plugin to show a UI if it want's to
563
# (such as 'Emailing diff to foo@example.com').
564
self.pb_stage_name = "Running %s hooks [%s]" % \
565
(hook_name, Branch.hooks.get_hook_name(hook))
566
self._emit_progress()
567
if 'hooks' in debug.debug_flags:
568
mutter("Invoking commit hook: %r", hook)
569
if hook_name == "post_commit":
570
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
572
elif hook_name == "pre_commit":
573
hook(hook_local, hook_master,
574
old_revno, old_revid, new_revno, self.rev_id,
575
tree_delta, future_tree)
578
"""Cleanup any open locks, progress bars etc."""
579
cleanups = [self._cleanup_bound_branch,
580
self.basis_tree.unlock,
581
self.work_tree.unlock,
583
found_exception = None
584
for cleanup in cleanups:
587
# we want every cleanup to run no matter what.
588
# so we have a catchall here, but we will raise the
589
# last encountered exception up the stack: and
590
# typically this will be useful enough.
593
if found_exception is not None:
594
# don't do a plan raise, because the last exception may have been
595
# trashed, e is our sure-to-work exception even though it loses the
596
# full traceback. XXX: RBC 20060421 perhaps we could check the
597
# exc_info and if its the same one do a plain raise otherwise
598
# 'raise e' as we do now.
403
601
def _cleanup_bound_branch(self):
404
602
"""Executed at the end of a try/finally to cleanup a bound branch.
428
631
def _gather_parents(self):
429
632
"""Record the parents of a merge for merge detection."""
430
pending_merges = self.work_tree.pending_merges()
432
self.parent_invs = []
433
self.present_parents = []
434
precursor_id = self.branch.last_revision()
436
self.parents.append(precursor_id)
437
self.parents += pending_merges
438
for revision in self.parents:
633
# TODO: Make sure that this list doesn't contain duplicate
634
# entries and the order is preserved when doing this.
635
self.parents = self.work_tree.get_parent_ids()
636
self.parent_invs = [self.basis_inv]
637
for revision in self.parents[1:]:
439
638
if self.branch.repository.has_revision(revision):
639
mutter('commit parent revision {%s}', revision)
440
640
inventory = self.branch.repository.get_inventory(revision)
441
641
self.parent_invs.append(inventory)
442
self.present_parents.append(revision)
444
def _check_parents_present(self):
445
for parent_id in self.parents:
446
mutter('commit parent revision {%s}', parent_id)
447
if not self.branch.repository.has_revision(parent_id):
448
if parent_id == self.branch.last_revision():
449
warning("parent is missing %r", parent_id)
450
raise HistoryMissing(self.branch, 'revision', parent_id)
452
mutter("commit will ghost revision %r", parent_id)
454
def _make_revision(self):
455
"""Record a new revision object for this commit."""
456
rev = Revision(timestamp=self.timestamp,
457
timezone=self.timezone,
458
committer=self.committer,
459
message=self.message,
460
inventory_sha1=self.inv_sha1,
461
revision_id=self.rev_id,
462
properties=self.revprops)
463
rev.parent_ids = self.parents
464
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
466
def _remove_deleted(self):
467
"""Remove deleted files from the working inventories.
469
This is done prior to taking the working inventory as the
470
basis for the new committed inventory.
472
This returns true if any files
473
*that existed in the basis inventory* were deleted.
474
Files that were added and deleted
475
in the working copy don't matter.
643
mutter('commit parent ghost revision {%s}', revision)
645
def _update_builder_with_changes(self):
646
"""Update the commit builder with the data about what has changed.
477
specific = self.specific_files
648
# Build the revision inventory.
650
# This starts by creating a new empty inventory. Depending on
651
# which files are selected for commit, and what is present in the
652
# current tree, the new inventory is populated. inventory entries
653
# which are candidates for modification have their revision set to
654
# None; inventory entries that are carried over untouched have their
655
# revision set to their prior value.
657
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
658
# results to create a new inventory at the same time, which results
659
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
662
exclude = self.exclude
663
specific_files = self.specific_files or []
664
mutter("Selecting files for commit with filter %s", specific_files)
666
# Build the new inventory
667
self._populate_from_inventory()
669
# If specific files are selected, then all un-selected files must be
670
# recorded in their previous state. For more details, see
671
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
672
if specific_files or exclude:
673
for path, old_ie in self.basis_inv.iter_entries():
674
if old_ie.file_id in self.builder.new_inventory:
675
# already added - skip.
677
if (is_inside_any(specific_files, path)
678
and not is_inside_any(exclude, path)):
679
# was inside the selected path, and not excluded - if not
680
# present it has been deleted so skip.
682
# From here down it was either not selected, or was excluded:
683
if old_ie.kind == 'directory':
684
self._next_progress_entry()
685
# We preserve the entry unaltered.
687
# Note: specific file commits after a merge are currently
688
# prohibited. This test is for sanity/safety in case it's
689
# required after that changes.
690
if len(self.parents) > 1:
692
_, version_recorded, _ = self.builder.record_entry_contents(
693
ie, self.parent_invs, path, self.basis_tree, None)
695
self.any_entries_changed = True
697
def _report_and_accumulate_deletes(self):
698
# XXX: Could the list of deleted paths and ids be instead taken from
699
# _populate_from_inventory?
700
if (isinstance(self.basis_inv, Inventory)
701
and isinstance(self.builder.new_inventory, Inventory)):
702
# the older Inventory classes provide a _byid dict, and building a
703
# set from the keys of this dict is substantially faster than even
704
# getting a set of ids from the inventory
706
# <lifeless> set(dict) is roughly the same speed as
707
# set(iter(dict)) and both are significantly slower than
709
deleted_ids = set(self.basis_inv._byid.keys()) - \
710
set(self.builder.new_inventory._byid.keys())
712
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
714
self.any_entries_deleted = True
715
deleted = [(self.basis_tree.id2path(file_id), file_id)
716
for file_id in deleted_ids]
718
# XXX: this is not quite directory-order sorting
719
for path, file_id in deleted:
720
self.builder.record_delete(path, file_id)
721
self.reporter.deleted(path)
723
def _populate_from_inventory(self):
724
"""Populate the CommitBuilder by walking the working tree inventory."""
726
# raise an exception as soon as we find a single unknown.
727
for unknown in self.work_tree.unknowns():
728
raise StrictCommitFailed()
730
specific_files = self.specific_files
731
exclude = self.exclude
732
report_changes = self.reporter.is_verbose()
479
for path, ie in self.work_inv.iter_entries():
480
if specific and not is_inside_any(specific, path):
734
# A tree of paths that have been deleted. E.g. if foo/bar has been
735
# deleted, then we have {'foo':{'bar':{}}}
737
# XXX: Note that entries may have the wrong kind because the entry does
738
# not reflect the status on disk.
739
work_inv = self.work_tree.inventory
740
# NB: entries will include entries within the excluded ids/paths
741
# because iter_entries_by_dir has no 'exclude' facility today.
742
entries = work_inv.iter_entries_by_dir(
743
specific_file_ids=self.specific_file_ids, yield_parents=True)
744
for path, existing_ie in entries:
745
file_id = existing_ie.file_id
746
name = existing_ie.name
747
parent_id = existing_ie.parent_id
748
kind = existing_ie.kind
749
if kind == 'directory':
750
self._next_progress_entry()
751
# Skip files that have been deleted from the working tree.
752
# The deleted path ids are also recorded so they can be explicitly
755
path_segments = splitpath(path)
756
deleted_dict = deleted_paths
757
for segment in path_segments:
758
deleted_dict = deleted_dict.get(segment, None)
760
# We either took a path not present in the dict
761
# (deleted_dict was None), or we've reached an empty
762
# child dir in the dict, so are now a sub-path.
766
if deleted_dict is not None:
767
# the path has a deleted parent, do not add it.
769
if exclude and is_inside_any(exclude, path):
770
# Skip excluded paths. Excluded paths are processed by
771
# _update_builder_with_changes.
482
if not self.work_tree.has_filename(path):
483
self.reporter.missing(path)
484
deleted_ids.append((path, ie.file_id))
486
deleted_ids.sort(reverse=True)
487
for path, file_id in deleted_ids:
488
del self.work_inv[file_id]
489
self.work_tree._write_inventory(self.work_inv)
491
def _store_snapshot(self):
492
"""Pass over inventory and record a snapshot.
494
Entries get a new revision when they are modified in
495
any way, which includes a merge with a new set of
496
parents that have the same entry.
773
content_summary = self.work_tree.path_content_summary(path)
774
# Note that when a filter of specific files is given, we must only
775
# skip/record deleted files matching that filter.
776
if not specific_files or is_inside_any(specific_files, path):
777
if content_summary[0] == 'missing':
778
if not deleted_paths:
779
# path won't have been split yet.
780
path_segments = splitpath(path)
781
deleted_dict = deleted_paths
782
for segment in path_segments:
783
deleted_dict = deleted_dict.setdefault(segment, {})
784
self.reporter.missing(path)
785
deleted_ids.append(file_id)
787
# TODO: have the builder do the nested commit just-in-time IF and
789
if content_summary[0] == 'tree-reference':
790
# enforce repository nested tree policy.
791
if (not self.work_tree.supports_tree_reference() or
792
# repository does not support it either.
793
not self.branch.repository._format.supports_tree_reference):
794
content_summary = ('directory',) + content_summary[1:]
795
kind = content_summary[0]
796
# TODO: specific_files filtering before nested tree processing
797
if kind == 'tree-reference':
798
if self.recursive == 'down':
799
nested_revision_id = self._commit_nested_tree(
801
content_summary = content_summary[:3] + (
804
content_summary = content_summary[:3] + (
805
self.work_tree.get_reference_revision(file_id),)
807
# Record an entry for this item
808
# Note: I don't particularly want to have the existing_ie
809
# parameter but the test suite currently (28-Jun-07) breaks
810
# without it thanks to a unicode normalisation issue. :-(
811
definitely_changed = kind != existing_ie.kind
812
self._record_entry(path, file_id, specific_files, kind, name,
813
parent_id, definitely_changed, existing_ie, report_changes,
816
# Unversion IDs that were found to be deleted
817
self.work_tree.unversion(deleted_ids)
819
def _commit_nested_tree(self, file_id, path):
820
"Commit a nested tree."
821
sub_tree = self.work_tree.get_nested_tree(file_id, path)
822
# FIXME: be more comprehensive here:
823
# this works when both trees are in --trees repository,
824
# but when both are bound to a different repository,
825
# it fails; a better way of approaching this is to
826
# finally implement the explicit-caches approach design
827
# a while back - RBC 20070306.
828
if sub_tree.branch.repository.has_same_location(
829
self.work_tree.branch.repository):
830
sub_tree.branch.repository = \
831
self.work_tree.branch.repository
833
return sub_tree.commit(message=None, revprops=self.revprops,
834
recursive=self.recursive,
835
message_callback=self.message_callback,
836
timestamp=self.timestamp, timezone=self.timezone,
837
committer=self.committer,
838
allow_pointless=self.allow_pointless,
839
strict=self.strict, verbose=self.verbose,
840
local=self.local, reporter=self.reporter)
841
except errors.PointlessCommit:
842
return self.work_tree.get_reference_revision(file_id)
844
def _record_entry(self, path, file_id, specific_files, kind, name,
845
parent_id, definitely_changed, existing_ie, report_changes,
847
"Record the new inventory entry for a path if any."
848
# mutter('check %s {%s}', path, file_id)
849
# mutter('%s selected for commit', path)
850
if definitely_changed or existing_ie is None:
851
ie = make_entry(kind, name, parent_id, file_id)
853
ie = existing_ie.copy()
855
# For carried over entries we don't care about the fs hash - the repo
856
# isn't generating a sha, so we're not saving computation time.
857
_, version_recorded, fs_hash = self.builder.record_entry_contents(
858
ie, self.parent_invs, path, self.work_tree, content_summary)
860
self.any_entries_changed = True
862
self._report_change(ie, path)
864
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
867
def _report_change(self, ie, path):
868
"""Report a change to the user.
870
The change that has occurred is described relative to the basis
498
# XXX: Need to think more here about when the user has
499
# made a specific decision on a particular value -- c.f.
501
for path, ie in self.new_inv.iter_entries():
502
previous_entries = ie.find_previous_heads(
505
self.branch.repository.get_transaction())
506
if ie.revision is None:
507
change = ie.snapshot(self.rev_id, path, previous_entries,
508
self.work_tree, self.weave_store,
509
self.branch.get_transaction())
873
if (self.basis_inv.has_id(ie.file_id)):
874
basis_ie = self.basis_inv[ie.file_id]
877
change = ie.describe_change(basis_ie, ie)
878
if change in (InventoryEntry.RENAMED,
879
InventoryEntry.MODIFIED_AND_RENAMED):
880
old_path = self.basis_inv.id2path(ie.file_id)
881
self.reporter.renamed(change, old_path, path)
512
883
self.reporter.snapshot_change(change, path)
514
def _populate_new_inv(self):
515
"""Build revision inventory.
517
This creates a new empty inventory. Depending on
518
which files are selected for commit, and what is present in the
519
current tree, the new inventory is populated. inventory entries
520
which are candidates for modification have their revision set to
521
None; inventory entries that are carried over untouched have their
522
revision set to their prior value.
524
mutter("Selecting files for commit with filter %s", self.specific_files)
525
self.new_inv = Inventory(revision_id=self.rev_id)
526
for path, new_ie in self.work_inv.iter_entries():
527
file_id = new_ie.file_id
528
mutter('check %s {%s}', path, new_ie.file_id)
529
if self.specific_files:
530
if not is_inside_any(self.specific_files, path):
531
mutter('%s not selected for commit', path)
532
self._carry_entry(file_id)
535
# this is selected, ensure its parents are too.
536
parent_id = new_ie.parent_id
537
while parent_id != ROOT_ID:
538
if not self.new_inv.has_id(parent_id):
539
ie = self._select_entry(self.work_inv[parent_id])
540
mutter('%s selected for commit because of %s',
541
self.new_inv.id2path(parent_id), path)
543
ie = self.new_inv[parent_id]
544
if ie.revision is not None:
546
mutter('%s selected for commit because of %s',
547
self.new_inv.id2path(parent_id), path)
548
parent_id = ie.parent_id
549
mutter('%s selected for commit', path)
550
self._select_entry(new_ie)
552
def _select_entry(self, new_ie):
553
"""Make new_ie be considered for committing."""
559
def _carry_entry(self, file_id):
560
"""Carry the file unchanged from the basis revision."""
561
if self.basis_inv.has_id(file_id):
562
self.new_inv.add(self.basis_inv[file_id].copy())
564
def _report_deletes(self):
565
for file_id in self.basis_inv:
566
if file_id not in self.new_inv:
567
self.reporter.deleted(self.basis_inv.id2path(file_id))
569
def _gen_revision_id(config, when):
570
"""Return new revision-id."""
571
s = '%s-%s-' % (config.user_email(), compact_date(when))
572
s += hexlify(rand_bytes(8))
885
def _set_progress_stage(self, name, entries_title=None):
886
"""Set the progress stage and emit an update to the progress bar."""
887
self.pb_stage_name = name
888
self.pb_stage_count += 1
889
self.pb_entries_title = entries_title
890
if entries_title is not None:
891
self.pb_entries_count = 0
892
self.pb_entries_total = '?'
893
self._emit_progress()
895
def _next_progress_entry(self):
896
"""Emit an update to the progress bar and increment the entry count."""
897
self.pb_entries_count += 1
898
self._emit_progress()
900
def _emit_progress(self):
901
if self.pb_entries_title:
902
if self.pb_entries_total == '?':
903
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
904
self.pb_entries_title, self.pb_entries_count)
906
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
907
self.pb_entries_title, self.pb_entries_count,
908
str(self.pb_entries_total))
910
text = "%s - Stage" % (self.pb_stage_name)
911
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
