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_deleted = False
263
if exclude is not None:
264
self.exclude = sorted(
265
minimum_path_selection(exclude))
232
268
self.local = local
233
269
self.master_branch = None
234
270
self.master_locked = False
236
self.specific_files = specific_files
271
self.recursive = recursive
273
if specific_files is not None:
274
self.specific_files = sorted(
275
minimum_path_selection(specific_files))
277
self.specific_files = None
278
self.specific_file_ids = None
237
279
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
280
self.revprops = revprops
281
self.message_callback = message_callback
282
self.timestamp = timestamp
283
self.timezone = timezone
284
self.committer = committer
286
self.verbose = verbose
247
288
self.work_tree.lock_write()
289
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
290
self.basis_revid = self.work_tree.last_revision()
291
self.basis_tree = self.work_tree.basis_tree()
292
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)
294
# Cannot commit with conflicts present.
295
if len(self.work_tree.conflicts()) > 0:
296
raise ConflictsInTree
298
# Setup the bound branch variables as needed.
299
self._check_bound_branch(possible_master_transports)
301
# Check that the working tree is up to date
302
old_revno, new_revno = self._check_out_of_date_tree()
304
# Complete configuration setup
305
if reporter is not None:
306
self.reporter = reporter
307
elif self.reporter is None:
308
self.reporter = self._select_reporter()
268
309
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()
310
self.config = self.branch.get_config()
312
# If provided, ensure the specified files are versioned
313
if self.specific_files is not None:
314
# Note: This routine is being called because it raises
315
# PathNotVersionedError as a side effect of finding the IDs. We
316
# later use the ids we found as input to the working tree
317
# inventory iterator, so we only consider those ids rather than
318
# examining the whole tree again.
319
# XXX: Dont we have filter_unversioned to do this more
321
self.specific_file_ids = tree.find_ids_across_trees(
322
specific_files, [self.basis_tree, self.work_tree])
324
# Setup the progress bar. As the number of files that need to be
325
# committed in unknown, progress is reported as stages.
326
# We keep track of entries separately though and include that
327
# information in the progress bar during the relevant stages.
328
self.pb_stage_name = ""
329
self.pb_stage_count = 0
330
self.pb_stage_total = 5
331
if self.bound_branch:
332
self.pb_stage_total += 1
333
self.pb.show_pct = False
334
self.pb.show_spinner = False
335
self.pb.show_eta = False
336
self.pb.show_count = True
337
self.pb.show_bar = True
295
339
self.basis_inv = self.basis_tree.inventory
297
340
self._gather_parents()
341
# After a merge, a selected file commit is not supported.
342
# See 'bzr help merge' for an explanation as to why.
298
343
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.
344
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
345
# Excludes are a form of selected file commit.
346
if len(self.parents) > 1 and self.exclude:
347
raise errors.CannotCommitSelectedFileMerge(self.exclude)
349
# Collect the changes
350
self._set_progress_stage("Collecting changes",
351
entries_title="Directory")
352
self.builder = self.branch.get_commit_builder(self.parents,
353
self.config, timestamp, timezone, committer, revprops, rev_id)
356
self.builder.will_record_deletes()
357
# find the location being committed to
358
if self.bound_branch:
359
master_location = self.master_branch.base
361
master_location = self.branch.base
363
# report the start of the commit
364
self.reporter.started(new_revno, self.rev_id, master_location)
366
self._update_builder_with_changes()
367
self._report_and_accumulate_deletes()
368
self._check_pointless()
370
# TODO: Now the new inventory is known, check for conflicts.
371
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
372
# weave lines, because nothing should be recorded until it is known
373
# that commit will succeed.
374
self._set_progress_stage("Saving data locally")
375
self.builder.finish_inventory()
377
# Prompt the user for a commit message if none provided
378
message = message_callback(self)
379
self.message = message
380
self._escape_commit_message()
382
# Add revision data to the local branch
383
self.rev_id = self.builder.commit(self.message)
386
mutter("aborting commit write group because of exception:")
387
trace.log_exception_quietly()
388
note("aborting commit write group: %r" % (e,))
392
self._process_pre_hooks(old_revno, new_revno)
394
# Upload revision data to the master.
395
# this will propagate merged revisions too if needed.
325
396
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)
397
self._set_progress_stage("Uploading data to master branch")
398
# 'commit' to the master first so a timeout here causes the
399
# local branch to be out of date
400
self.master_branch.import_last_revision_info(
401
self.branch.repository, new_revno, self.rev_id)
333
403
# and now do the commit locally.
334
self.branch.append_revision(self.rev_id)
404
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})
406
# Make the working tree up to date with the branch
407
self._set_progress_stage("Updating the working tree")
408
self.work_tree.update_basis_by_delta(self.rev_id,
409
self.builder.get_basis_delta())
410
self.reporter.completed(new_revno, self.rev_id)
411
self._process_post_hooks(old_revno, new_revno)
350
self._cleanup_bound_branch()
351
self.work_tree.unlock()
353
def _check_bound_branch(self):
416
def _select_reporter(self):
417
"""Select the CommitReporter to use."""
419
return NullCommitReporter()
420
return ReportCommitToLog()
422
def _check_pointless(self):
423
if self.allow_pointless:
425
# A merge with no effect on files
426
if len(self.parents) > 1:
428
# TODO: we could simplify this by using self.builder.basis_delta.
430
# The initial commit adds a root directory, but this in itself is not
431
# a worthwhile commit.
432
if (self.basis_revid == revision.NULL_REVISION and
433
len(self.builder.new_inventory) == 1):
434
raise PointlessCommit()
435
# If length == 1, then we only have the root entry. Which means
436
# that there is no real difference (only the root could be different)
437
# unless deletes occured, in which case the length is irrelevant.
438
if (self.any_entries_deleted or
439
(len(self.builder.new_inventory) != 1 and
440
self.builder.any_changes())):
442
raise PointlessCommit()
444
def _check_bound_branch(self, possible_master_transports=None):
354
445
"""Check to see if the local branch is bound.
356
447
If it is bound, then most of the commit will actually be
391
483
self.bound_branch = self.branch
392
484
self.master_branch.lock_write()
393
485
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)
487
def _check_out_of_date_tree(self):
488
"""Check that the working tree is up to date.
490
:return: old_revision_number,new_revision_number tuple
493
first_tree_parent = self.work_tree.get_parent_ids()[0]
495
# if there are no parents, treat our parent as 'None'
496
# this is so that we still consider the master branch
497
# - in a checkout scenario the tree may have no
498
# parents but the branch may do.
499
first_tree_parent = bzrlib.revision.NULL_REVISION
500
old_revno, master_last = self.master_branch.last_revision_info()
501
if master_last != first_tree_parent:
502
if master_last != bzrlib.revision.NULL_REVISION:
503
raise errors.OutOfDateTree(self.work_tree)
504
if self.branch.repository.has_revision(first_tree_parent):
505
new_revno = old_revno + 1
507
# ghost parents never appear in revision history.
509
return old_revno,new_revno
511
def _process_pre_hooks(self, old_revno, new_revno):
512
"""Process any registered pre commit hooks."""
513
self._set_progress_stage("Running pre_commit hooks")
514
self._process_hooks("pre_commit", old_revno, new_revno)
516
def _process_post_hooks(self, old_revno, new_revno):
517
"""Process any registered post commit hooks."""
518
# Process the post commit hooks, if any
519
self._set_progress_stage("Running post_commit hooks")
520
# old style commit hooks - should be deprecated ? (obsoleted in
522
if self.config.post_commit() is not None:
523
hooks = self.config.post_commit().split(' ')
524
# this would be nicer with twisted.python.reflect.namedAny
526
result = eval(hook + '(branch, rev_id)',
527
{'branch':self.branch,
529
'rev_id':self.rev_id})
530
# process new style post commit hooks
531
self._process_hooks("post_commit", old_revno, new_revno)
533
def _process_hooks(self, hook_name, old_revno, new_revno):
534
if not Branch.hooks[hook_name]:
537
# new style commit hooks:
538
if not self.bound_branch:
539
hook_master = self.branch
542
hook_master = self.master_branch
543
hook_local = self.branch
544
# With bound branches, when the master is behind the local branch,
545
# the 'old_revno' and old_revid values here are incorrect.
546
# XXX: FIXME ^. RBC 20060206
548
old_revid = self.parents[0]
550
old_revid = bzrlib.revision.NULL_REVISION
552
if hook_name == "pre_commit":
553
future_tree = self.builder.revision_tree()
554
tree_delta = future_tree.changes_from(self.basis_tree,
557
for hook in Branch.hooks[hook_name]:
558
# show the running hook in the progress bar. As hooks may
559
# end up doing nothing (e.g. because they are not configured by
560
# the user) this is still showing progress, not showing overall
561
# actions - its up to each plugin to show a UI if it want's to
562
# (such as 'Emailing diff to foo@example.com').
563
self.pb_stage_name = "Running %s hooks [%s]" % \
564
(hook_name, Branch.hooks.get_hook_name(hook))
565
self._emit_progress()
566
if 'hooks' in debug.debug_flags:
567
mutter("Invoking commit hook: %r", hook)
568
if hook_name == "post_commit":
569
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
571
elif hook_name == "pre_commit":
572
hook(hook_local, hook_master,
573
old_revno, old_revid, new_revno, self.rev_id,
574
tree_delta, future_tree)
577
"""Cleanup any open locks, progress bars etc."""
578
cleanups = [self._cleanup_bound_branch,
579
self.basis_tree.unlock,
580
self.work_tree.unlock,
582
found_exception = None
583
for cleanup in cleanups:
586
# we want every cleanup to run no matter what.
587
# so we have a catchall here, but we will raise the
588
# last encountered exception up the stack: and
589
# typically this will be useful enough.
592
if found_exception is not None:
593
# don't do a plan raise, because the last exception may have been
594
# trashed, e is our sure-to-work exception even though it loses the
595
# full traceback. XXX: RBC 20060421 perhaps we could check the
596
# exc_info and if its the same one do a plain raise otherwise
597
# 'raise e' as we do now.
403
600
def _cleanup_bound_branch(self):
404
601
"""Executed at the end of a try/finally to cleanup a bound branch.
428
630
def _gather_parents(self):
429
631
"""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:
632
# TODO: Make sure that this list doesn't contain duplicate
633
# entries and the order is preserved when doing this.
634
self.parents = self.work_tree.get_parent_ids()
635
self.parent_invs = [self.basis_inv]
636
for revision in self.parents[1:]:
439
637
if self.branch.repository.has_revision(revision):
638
mutter('commit parent revision {%s}', revision)
440
639
inventory = self.branch.repository.get_inventory(revision)
441
640
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.
642
mutter('commit parent ghost revision {%s}', revision)
644
def _update_builder_with_changes(self):
645
"""Update the commit builder with the data about what has changed.
477
specific = self.specific_files
647
# Build the revision inventory.
649
# This starts by creating a new empty inventory. Depending on
650
# which files are selected for commit, and what is present in the
651
# current tree, the new inventory is populated. inventory entries
652
# which are candidates for modification have their revision set to
653
# None; inventory entries that are carried over untouched have their
654
# revision set to their prior value.
656
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
657
# results to create a new inventory at the same time, which results
658
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
661
exclude = self.exclude
662
specific_files = self.specific_files or []
663
mutter("Selecting files for commit with filter %s", specific_files)
665
# Build the new inventory
666
self._populate_from_inventory()
668
# If specific files are selected, then all un-selected files must be
669
# recorded in their previous state. For more details, see
670
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
671
if specific_files or exclude:
672
for path, old_ie in self.basis_inv.iter_entries():
673
if old_ie.file_id in self.builder.new_inventory:
674
# already added - skip.
676
if (is_inside_any(specific_files, path)
677
and not is_inside_any(exclude, path)):
678
# was inside the selected path, and not excluded - if not
679
# present it has been deleted so skip.
681
# From here down it was either not selected, or was excluded:
682
if old_ie.kind == 'directory':
683
self._next_progress_entry()
684
# We preserve the entry unaltered.
686
# Note: specific file commits after a merge are currently
687
# prohibited. This test is for sanity/safety in case it's
688
# required after that changes.
689
if len(self.parents) > 1:
691
self.builder.record_entry_contents(ie, self.parent_invs, path,
692
self.basis_tree, None)
694
def _report_and_accumulate_deletes(self):
695
# XXX: Could the list of deleted paths and ids be instead taken from
696
# _populate_from_inventory?
697
if (isinstance(self.basis_inv, Inventory)
698
and isinstance(self.builder.new_inventory, Inventory)):
699
# the older Inventory classes provide a _byid dict, and building a
700
# set from the keys of this dict is substantially faster than even
701
# getting a set of ids from the inventory
703
# <lifeless> set(dict) is roughly the same speed as
704
# set(iter(dict)) and both are significantly slower than
706
deleted_ids = set(self.basis_inv._byid.keys()) - \
707
set(self.builder.new_inventory._byid.keys())
709
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
711
self.any_entries_deleted = True
712
deleted = [(self.basis_tree.id2path(file_id), file_id)
713
for file_id in deleted_ids]
715
# XXX: this is not quite directory-order sorting
716
for path, file_id in deleted:
717
self.builder.record_delete(path, file_id)
718
self.reporter.deleted(path)
720
def _populate_from_inventory(self):
721
"""Populate the CommitBuilder by walking the working tree inventory."""
723
# raise an exception as soon as we find a single unknown.
724
for unknown in self.work_tree.unknowns():
725
raise StrictCommitFailed()
727
specific_files = self.specific_files
728
exclude = self.exclude
729
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):
731
# A tree of paths that have been deleted. E.g. if foo/bar has been
732
# deleted, then we have {'foo':{'bar':{}}}
734
# XXX: Note that entries may have the wrong kind because the entry does
735
# not reflect the status on disk.
736
work_inv = self.work_tree.inventory
737
# NB: entries will include entries within the excluded ids/paths
738
# because iter_entries_by_dir has no 'exclude' facility today.
739
entries = work_inv.iter_entries_by_dir(
740
specific_file_ids=self.specific_file_ids, yield_parents=True)
741
for path, existing_ie in entries:
742
file_id = existing_ie.file_id
743
name = existing_ie.name
744
parent_id = existing_ie.parent_id
745
kind = existing_ie.kind
746
if kind == 'directory':
747
self._next_progress_entry()
748
# Skip files that have been deleted from the working tree.
749
# The deleted path ids are also recorded so they can be explicitly
752
path_segments = splitpath(path)
753
deleted_dict = deleted_paths
754
for segment in path_segments:
755
deleted_dict = deleted_dict.get(segment, None)
757
# We either took a path not present in the dict
758
# (deleted_dict was None), or we've reached an empty
759
# child dir in the dict, so are now a sub-path.
763
if deleted_dict is not None:
764
# the path has a deleted parent, do not add it.
766
if exclude and is_inside_any(exclude, path):
767
# Skip excluded paths. Excluded paths are processed by
768
# _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.
770
content_summary = self.work_tree.path_content_summary(path)
771
# Note that when a filter of specific files is given, we must only
772
# skip/record deleted files matching that filter.
773
if not specific_files or is_inside_any(specific_files, path):
774
if content_summary[0] == 'missing':
775
if not deleted_paths:
776
# path won't have been split yet.
777
path_segments = splitpath(path)
778
deleted_dict = deleted_paths
779
for segment in path_segments:
780
deleted_dict = deleted_dict.setdefault(segment, {})
781
self.reporter.missing(path)
782
deleted_ids.append(file_id)
784
# TODO: have the builder do the nested commit just-in-time IF and
786
if content_summary[0] == 'tree-reference':
787
# enforce repository nested tree policy.
788
if (not self.work_tree.supports_tree_reference() or
789
# repository does not support it either.
790
not self.branch.repository._format.supports_tree_reference):
791
content_summary = ('directory',) + content_summary[1:]
792
kind = content_summary[0]
793
# TODO: specific_files filtering before nested tree processing
794
if kind == 'tree-reference':
795
if self.recursive == 'down':
796
nested_revision_id = self._commit_nested_tree(
798
content_summary = content_summary[:3] + (
801
content_summary = content_summary[:3] + (
802
self.work_tree.get_reference_revision(file_id),)
804
# Record an entry for this item
805
# Note: I don't particularly want to have the existing_ie
806
# parameter but the test suite currently (28-Jun-07) breaks
807
# without it thanks to a unicode normalisation issue. :-(
808
definitely_changed = kind != existing_ie.kind
809
self._record_entry(path, file_id, specific_files, kind, name,
810
parent_id, definitely_changed, existing_ie, report_changes,
813
# Unversion IDs that were found to be deleted
814
self.work_tree.unversion(deleted_ids)
816
def _commit_nested_tree(self, file_id, path):
817
"Commit a nested tree."
818
sub_tree = self.work_tree.get_nested_tree(file_id, path)
819
# FIXME: be more comprehensive here:
820
# this works when both trees are in --trees repository,
821
# but when both are bound to a different repository,
822
# it fails; a better way of approaching this is to
823
# finally implement the explicit-caches approach design
824
# a while back - RBC 20070306.
825
if sub_tree.branch.repository.has_same_location(
826
self.work_tree.branch.repository):
827
sub_tree.branch.repository = \
828
self.work_tree.branch.repository
830
return sub_tree.commit(message=None, revprops=self.revprops,
831
recursive=self.recursive,
832
message_callback=self.message_callback,
833
timestamp=self.timestamp, timezone=self.timezone,
834
committer=self.committer,
835
allow_pointless=self.allow_pointless,
836
strict=self.strict, verbose=self.verbose,
837
local=self.local, reporter=self.reporter)
838
except errors.PointlessCommit:
839
return self.work_tree.get_reference_revision(file_id)
841
def _record_entry(self, path, file_id, specific_files, kind, name,
842
parent_id, definitely_changed, existing_ie, report_changes,
844
"Record the new inventory entry for a path if any."
845
# mutter('check %s {%s}', path, file_id)
846
# mutter('%s selected for commit', path)
847
if definitely_changed or existing_ie is None:
848
ie = make_entry(kind, name, parent_id, file_id)
850
ie = existing_ie.copy()
852
# For carried over entries we don't care about the fs hash - the repo
853
# isn't generating a sha, so we're not saving computation time.
854
_, _, fs_hash = self.builder.record_entry_contents(
855
ie, self.parent_invs, path, self.work_tree, content_summary)
857
self._report_change(ie, path)
859
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
862
def _report_change(self, ie, path):
863
"""Report a change to the user.
865
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())
868
if (self.basis_inv.has_id(ie.file_id)):
869
basis_ie = self.basis_inv[ie.file_id]
872
change = ie.describe_change(basis_ie, ie)
873
if change in (InventoryEntry.RENAMED,
874
InventoryEntry.MODIFIED_AND_RENAMED):
875
old_path = self.basis_inv.id2path(ie.file_id)
876
self.reporter.renamed(change, old_path, path)
512
878
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))
880
def _set_progress_stage(self, name, entries_title=None):
881
"""Set the progress stage and emit an update to the progress bar."""
882
self.pb_stage_name = name
883
self.pb_stage_count += 1
884
self.pb_entries_title = entries_title
885
if entries_title is not None:
886
self.pb_entries_count = 0
887
self.pb_entries_total = '?'
888
self._emit_progress()
890
def _next_progress_entry(self):
891
"""Emit an update to the progress bar and increment the entry count."""
892
self.pb_entries_count += 1
893
self._emit_progress()
895
def _emit_progress(self):
896
if self.pb_entries_title:
897
if self.pb_entries_total == '?':
898
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
899
self.pb_entries_title, self.pb_entries_count)
901
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
902
self.pb_entries_title, self.pb_entries_count,
903
str(self.pb_entries_total))
905
text = "%s - Stage" % (self.pb_stage_name)
906
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
