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
288
# accumulates an inventory delta to the basis entry, so we can make
289
# just the necessary updates to the workingtree's cached basis.
290
self._basis_delta = []
247
292
self.work_tree.lock_write()
293
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
294
self.basis_revid = self.work_tree.last_revision()
295
self.basis_tree = self.work_tree.basis_tree()
296
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)
298
# Cannot commit with conflicts present.
299
if len(self.work_tree.conflicts()) > 0:
300
raise ConflictsInTree
302
# Setup the bound branch variables as needed.
303
self._check_bound_branch(possible_master_transports)
305
# Check that the working tree is up to date
306
old_revno, new_revno = self._check_out_of_date_tree()
308
# Complete configuration setup
309
if reporter is not None:
310
self.reporter = reporter
311
elif self.reporter is None:
312
self.reporter = self._select_reporter()
268
313
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()
314
self.config = self.branch.get_config()
316
# If provided, ensure the specified files are versioned
317
if self.specific_files is not None:
318
# Note: This routine is being called because it raises
319
# PathNotVersionedError as a side effect of finding the IDs. We
320
# later use the ids we found as input to the working tree
321
# inventory iterator, so we only consider those ids rather than
322
# examining the whole tree again.
323
# XXX: Dont we have filter_unversioned to do this more
325
self.specific_file_ids = tree.find_ids_across_trees(
326
specific_files, [self.basis_tree, self.work_tree])
328
# Setup the progress bar. As the number of files that need to be
329
# committed in unknown, progress is reported as stages.
330
# We keep track of entries separately though and include that
331
# information in the progress bar during the relevant stages.
332
self.pb_stage_name = ""
333
self.pb_stage_count = 0
334
self.pb_stage_total = 5
335
if self.bound_branch:
336
self.pb_stage_total += 1
337
self.pb.show_pct = False
338
self.pb.show_spinner = False
339
self.pb.show_eta = False
340
self.pb.show_count = True
341
self.pb.show_bar = True
295
343
self.basis_inv = self.basis_tree.inventory
297
344
self._gather_parents()
345
# After a merge, a selected file commit is not supported.
346
# See 'bzr help merge' for an explanation as to why.
298
347
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.
348
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
349
# Excludes are a form of selected file commit.
350
if len(self.parents) > 1 and self.exclude:
351
raise errors.CannotCommitSelectedFileMerge(self.exclude)
353
# Collect the changes
354
self._set_progress_stage("Collecting changes",
355
entries_title="Directory")
356
self.builder = self.branch.get_commit_builder(self.parents,
357
self.config, timestamp, timezone, committer, revprops, rev_id)
360
# find the location being committed to
361
if self.bound_branch:
362
master_location = self.master_branch.base
364
master_location = self.branch.base
366
# report the start of the commit
367
self.reporter.started(new_revno, self.rev_id, master_location)
369
self._update_builder_with_changes()
370
self._report_and_accumulate_deletes()
371
self._check_pointless()
373
# TODO: Now the new inventory is known, check for conflicts.
374
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
375
# weave lines, because nothing should be recorded until it is known
376
# that commit will succeed.
377
self._set_progress_stage("Saving data locally")
378
self.builder.finish_inventory()
380
# Prompt the user for a commit message if none provided
381
message = message_callback(self)
382
self.message = message
383
self._escape_commit_message()
385
# Add revision data to the local branch
386
self.rev_id = self.builder.commit(self.message)
389
mutter("aborting commit write group because of exception:")
390
trace.log_exception_quietly()
391
note("aborting commit write group: %r" % (e,))
395
self._process_pre_hooks(old_revno, new_revno)
397
# Upload revision data to the master.
398
# this will propagate merged revisions too if needed.
325
399
if self.bound_branch:
326
self.master_branch.repository.fetch(self.branch.repository,
327
revision_id=self.rev_id)
400
if not self.master_branch.repository.has_same_location(
401
self.branch.repository):
402
self._set_progress_stage("Uploading data to master branch")
403
self.master_branch.repository.fetch(self.branch.repository,
404
revision_id=self.rev_id)
328
405
# 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)
406
# 'commit' to the master first so a timeout here causes the
407
# local branch to be out of date
408
self.master_branch.set_last_revision_info(new_revno,
333
411
# and now do the commit locally.
334
self.branch.append_revision(self.rev_id)
412
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})
414
# Make the working tree up to date with the branch
415
self._set_progress_stage("Updating the working tree")
416
self.work_tree.update_basis_by_delta(self.rev_id,
418
self.reporter.completed(new_revno, self.rev_id)
419
self._process_post_hooks(old_revno, new_revno)
350
self._cleanup_bound_branch()
351
self.work_tree.unlock()
353
def _check_bound_branch(self):
424
def _select_reporter(self):
425
"""Select the CommitReporter to use."""
427
return NullCommitReporter()
428
return ReportCommitToLog()
430
def _check_pointless(self):
431
if self.allow_pointless:
433
# A merge with no effect on files
434
if len(self.parents) > 1:
436
# TODO: we could simplify this by using self._basis_delta.
438
# The initial commit adds a root directory, but this in itself is not
439
# a worthwhile commit.
440
if (self.basis_revid == revision.NULL_REVISION and
441
len(self.builder.new_inventory) == 1):
442
raise PointlessCommit()
443
# If length == 1, then we only have the root entry. Which means
444
# that there is no real difference (only the root could be different)
445
# unless deletes occured, in which case the length is irrelevant.
446
if (self.any_entries_deleted or
447
(len(self.builder.new_inventory) != 1 and
448
self.any_entries_changed)):
450
raise PointlessCommit()
452
def _check_bound_branch(self, possible_master_transports=None):
354
453
"""Check to see if the local branch is bound.
356
455
If it is bound, then most of the commit will actually be
391
491
self.bound_branch = self.branch
392
492
self.master_branch.lock_write()
393
493
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)
495
def _check_out_of_date_tree(self):
496
"""Check that the working tree is up to date.
498
:return: old_revision_number,new_revision_number tuple
501
first_tree_parent = self.work_tree.get_parent_ids()[0]
503
# if there are no parents, treat our parent as 'None'
504
# this is so that we still consider the master branch
505
# - in a checkout scenario the tree may have no
506
# parents but the branch may do.
507
first_tree_parent = bzrlib.revision.NULL_REVISION
508
old_revno, master_last = self.master_branch.last_revision_info()
509
if master_last != first_tree_parent:
510
if master_last != bzrlib.revision.NULL_REVISION:
511
raise errors.OutOfDateTree(self.work_tree)
512
if self.branch.repository.has_revision(first_tree_parent):
513
new_revno = old_revno + 1
515
# ghost parents never appear in revision history.
517
return old_revno,new_revno
519
def _process_pre_hooks(self, old_revno, new_revno):
520
"""Process any registered pre commit hooks."""
521
self._set_progress_stage("Running pre_commit hooks")
522
self._process_hooks("pre_commit", old_revno, new_revno)
524
def _process_post_hooks(self, old_revno, new_revno):
525
"""Process any registered post commit hooks."""
526
# Process the post commit hooks, if any
527
self._set_progress_stage("Running post_commit hooks")
528
# old style commit hooks - should be deprecated ? (obsoleted in
530
if self.config.post_commit() is not None:
531
hooks = self.config.post_commit().split(' ')
532
# this would be nicer with twisted.python.reflect.namedAny
534
result = eval(hook + '(branch, rev_id)',
535
{'branch':self.branch,
537
'rev_id':self.rev_id})
538
# process new style post commit hooks
539
self._process_hooks("post_commit", old_revno, new_revno)
541
def _process_hooks(self, hook_name, old_revno, new_revno):
542
if not Branch.hooks[hook_name]:
545
# new style commit hooks:
546
if not self.bound_branch:
547
hook_master = self.branch
550
hook_master = self.master_branch
551
hook_local = self.branch
552
# With bound branches, when the master is behind the local branch,
553
# the 'old_revno' and old_revid values here are incorrect.
554
# XXX: FIXME ^. RBC 20060206
556
old_revid = self.parents[0]
558
old_revid = bzrlib.revision.NULL_REVISION
560
if hook_name == "pre_commit":
561
future_tree = self.builder.revision_tree()
562
tree_delta = future_tree.changes_from(self.basis_tree,
565
for hook in Branch.hooks[hook_name]:
566
# show the running hook in the progress bar. As hooks may
567
# end up doing nothing (e.g. because they are not configured by
568
# the user) this is still showing progress, not showing overall
569
# actions - its up to each plugin to show a UI if it want's to
570
# (such as 'Emailing diff to foo@example.com').
571
self.pb_stage_name = "Running %s hooks [%s]" % \
572
(hook_name, Branch.hooks.get_hook_name(hook))
573
self._emit_progress()
574
if 'hooks' in debug.debug_flags:
575
mutter("Invoking commit hook: %r", hook)
576
if hook_name == "post_commit":
577
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
579
elif hook_name == "pre_commit":
580
hook(hook_local, hook_master,
581
old_revno, old_revid, new_revno, self.rev_id,
582
tree_delta, future_tree)
585
"""Cleanup any open locks, progress bars etc."""
586
cleanups = [self._cleanup_bound_branch,
587
self.basis_tree.unlock,
588
self.work_tree.unlock,
590
found_exception = None
591
for cleanup in cleanups:
594
# we want every cleanup to run no matter what.
595
# so we have a catchall here, but we will raise the
596
# last encountered exception up the stack: and
597
# typically this will be useful enough.
600
if found_exception is not None:
601
# don't do a plan raise, because the last exception may have been
602
# trashed, e is our sure-to-work exception even though it loses the
603
# full traceback. XXX: RBC 20060421 perhaps we could check the
604
# exc_info and if its the same one do a plain raise otherwise
605
# 'raise e' as we do now.
403
608
def _cleanup_bound_branch(self):
404
609
"""Executed at the end of a try/finally to cleanup a bound branch.
428
638
def _gather_parents(self):
429
639
"""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:
640
# TODO: Make sure that this list doesn't contain duplicate
641
# entries and the order is preserved when doing this.
642
self.parents = self.work_tree.get_parent_ids()
643
self.parent_invs = [self.basis_inv]
644
for revision in self.parents[1:]:
439
645
if self.branch.repository.has_revision(revision):
646
mutter('commit parent revision {%s}', revision)
440
647
inventory = self.branch.repository.get_inventory(revision)
441
648
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.
650
mutter('commit parent ghost revision {%s}', revision)
652
def _update_builder_with_changes(self):
653
"""Update the commit builder with the data about what has changed.
477
specific = self.specific_files
655
# Build the revision inventory.
657
# This starts by creating a new empty inventory. Depending on
658
# which files are selected for commit, and what is present in the
659
# current tree, the new inventory is populated. inventory entries
660
# which are candidates for modification have their revision set to
661
# None; inventory entries that are carried over untouched have their
662
# revision set to their prior value.
664
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
665
# results to create a new inventory at the same time, which results
666
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
669
exclude = self.exclude
670
specific_files = self.specific_files or []
671
mutter("Selecting files for commit with filter %s", specific_files)
673
# Build the new inventory
674
self._populate_from_inventory()
676
# If specific files are selected, then all un-selected files must be
677
# recorded in their previous state. For more details, see
678
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
679
if specific_files or exclude:
680
for path, old_ie in self.basis_inv.iter_entries():
681
if old_ie.file_id in self.builder.new_inventory:
682
# already added - skip.
684
if (is_inside_any(specific_files, path)
685
and not is_inside_any(exclude, path)):
686
# was inside the selected path, and not excluded - if not
687
# present it has been deleted so skip.
689
# From here down it was either not selected, or was excluded:
690
if old_ie.kind == 'directory':
691
self._next_progress_entry()
692
# We preserve the entry unaltered.
694
# Note: specific file commits after a merge are currently
695
# prohibited. This test is for sanity/safety in case it's
696
# required after that changes.
697
if len(self.parents) > 1:
699
delta, version_recorded, _ = self.builder.record_entry_contents(
700
ie, self.parent_invs, path, self.basis_tree, None)
702
self.any_entries_changed = True
704
self._basis_delta.append(delta)
706
def _report_and_accumulate_deletes(self):
707
# XXX: Could the list of deleted paths and ids be instead taken from
708
# _populate_from_inventory?
709
if (isinstance(self.basis_inv, Inventory)
710
and isinstance(self.builder.new_inventory, Inventory)):
711
# the older Inventory classes provide a _byid dict, and building a
712
# set from the keys of this dict is substantially faster than even
713
# getting a set of ids from the inventory
715
# <lifeless> set(dict) is roughly the same speed as
716
# set(iter(dict)) and both are significantly slower than
718
deleted_ids = set(self.basis_inv._byid.keys()) - \
719
set(self.builder.new_inventory._byid.keys())
721
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
723
self.any_entries_deleted = True
724
deleted = [(self.basis_tree.id2path(file_id), file_id)
725
for file_id in deleted_ids]
727
# XXX: this is not quite directory-order sorting
728
for path, file_id in deleted:
729
self._basis_delta.append((path, None, file_id, None))
730
self.reporter.deleted(path)
732
def _populate_from_inventory(self):
733
"""Populate the CommitBuilder by walking the working tree inventory."""
735
# raise an exception as soon as we find a single unknown.
736
for unknown in self.work_tree.unknowns():
737
raise StrictCommitFailed()
739
specific_files = self.specific_files
740
exclude = self.exclude
741
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):
743
# A tree of paths that have been deleted. E.g. if foo/bar has been
744
# deleted, then we have {'foo':{'bar':{}}}
746
# XXX: Note that entries may have the wrong kind because the entry does
747
# not reflect the status on disk.
748
work_inv = self.work_tree.inventory
749
# NB: entries will include entries within the excluded ids/paths
750
# because iter_entries_by_dir has no 'exclude' facility today.
751
entries = work_inv.iter_entries_by_dir(
752
specific_file_ids=self.specific_file_ids, yield_parents=True)
753
for path, existing_ie in entries:
754
file_id = existing_ie.file_id
755
name = existing_ie.name
756
parent_id = existing_ie.parent_id
757
kind = existing_ie.kind
758
if kind == 'directory':
759
self._next_progress_entry()
760
# Skip files that have been deleted from the working tree.
761
# The deleted path ids are also recorded so they can be explicitly
764
path_segments = splitpath(path)
765
deleted_dict = deleted_paths
766
for segment in path_segments:
767
deleted_dict = deleted_dict.get(segment, None)
769
# We either took a path not present in the dict
770
# (deleted_dict was None), or we've reached an empty
771
# child dir in the dict, so are now a sub-path.
775
if deleted_dict is not None:
776
# the path has a deleted parent, do not add it.
778
if exclude and is_inside_any(exclude, path):
779
# Skip excluded paths. Excluded paths are processed by
780
# _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.
782
content_summary = self.work_tree.path_content_summary(path)
783
# Note that when a filter of specific files is given, we must only
784
# skip/record deleted files matching that filter.
785
if not specific_files or is_inside_any(specific_files, path):
786
if content_summary[0] == 'missing':
787
if not deleted_paths:
788
# path won't have been split yet.
789
path_segments = splitpath(path)
790
deleted_dict = deleted_paths
791
for segment in path_segments:
792
deleted_dict = deleted_dict.setdefault(segment, {})
793
self.reporter.missing(path)
794
deleted_ids.append(file_id)
796
# TODO: have the builder do the nested commit just-in-time IF and
798
if content_summary[0] == 'tree-reference':
799
# enforce repository nested tree policy.
800
if (not self.work_tree.supports_tree_reference() or
801
# repository does not support it either.
802
not self.branch.repository._format.supports_tree_reference):
803
content_summary = ('directory',) + content_summary[1:]
804
kind = content_summary[0]
805
# TODO: specific_files filtering before nested tree processing
806
if kind == 'tree-reference':
807
if self.recursive == 'down':
808
nested_revision_id = self._commit_nested_tree(
810
content_summary = content_summary[:3] + (
813
content_summary = content_summary[:3] + (
814
self.work_tree.get_reference_revision(file_id),)
816
# Record an entry for this item
817
# Note: I don't particularly want to have the existing_ie
818
# parameter but the test suite currently (28-Jun-07) breaks
819
# without it thanks to a unicode normalisation issue. :-(
820
definitely_changed = kind != existing_ie.kind
821
self._record_entry(path, file_id, specific_files, kind, name,
822
parent_id, definitely_changed, existing_ie, report_changes,
825
# Unversion IDs that were found to be deleted
826
self.work_tree.unversion(deleted_ids)
828
def _commit_nested_tree(self, file_id, path):
829
"Commit a nested tree."
830
sub_tree = self.work_tree.get_nested_tree(file_id, path)
831
# FIXME: be more comprehensive here:
832
# this works when both trees are in --trees repository,
833
# but when both are bound to a different repository,
834
# it fails; a better way of approaching this is to
835
# finally implement the explicit-caches approach design
836
# a while back - RBC 20070306.
837
if sub_tree.branch.repository.has_same_location(
838
self.work_tree.branch.repository):
839
sub_tree.branch.repository = \
840
self.work_tree.branch.repository
842
return sub_tree.commit(message=None, revprops=self.revprops,
843
recursive=self.recursive,
844
message_callback=self.message_callback,
845
timestamp=self.timestamp, timezone=self.timezone,
846
committer=self.committer,
847
allow_pointless=self.allow_pointless,
848
strict=self.strict, verbose=self.verbose,
849
local=self.local, reporter=self.reporter)
850
except errors.PointlessCommit:
851
return self.work_tree.get_reference_revision(file_id)
853
def _record_entry(self, path, file_id, specific_files, kind, name,
854
parent_id, definitely_changed, existing_ie, report_changes,
856
"Record the new inventory entry for a path if any."
857
# mutter('check %s {%s}', path, file_id)
858
# mutter('%s selected for commit', path)
859
if definitely_changed or existing_ie is None:
860
ie = make_entry(kind, name, parent_id, file_id)
862
ie = existing_ie.copy()
864
# For carried over entries we don't care about the fs hash - the repo
865
# isn't generating a sha, so we're not saving computation time.
866
delta, version_recorded, fs_hash = self.builder.record_entry_contents(
867
ie, self.parent_invs, path, self.work_tree, content_summary)
869
self._basis_delta.append(delta)
871
self.any_entries_changed = True
873
self._report_change(ie, path)
875
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
878
def _report_change(self, ie, path):
879
"""Report a change to the user.
881
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())
884
if (self.basis_inv.has_id(ie.file_id)):
885
basis_ie = self.basis_inv[ie.file_id]
888
change = ie.describe_change(basis_ie, ie)
889
if change in (InventoryEntry.RENAMED,
890
InventoryEntry.MODIFIED_AND_RENAMED):
891
old_path = self.basis_inv.id2path(ie.file_id)
892
self.reporter.renamed(change, old_path, path)
512
894
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))
896
def _set_progress_stage(self, name, entries_title=None):
897
"""Set the progress stage and emit an update to the progress bar."""
898
self.pb_stage_name = name
899
self.pb_stage_count += 1
900
self.pb_entries_title = entries_title
901
if entries_title is not None:
902
self.pb_entries_count = 0
903
self.pb_entries_total = '?'
904
self._emit_progress()
906
def _next_progress_entry(self):
907
"""Emit an update to the progress bar and increment the entry count."""
908
self.pb_entries_count += 1
909
self._emit_progress()
911
def _emit_progress(self):
912
if self.pb_entries_title:
913
if self.pb_entries_total == '?':
914
text = "%s [%s %d] - Stage" % (self.pb_stage_name,
915
self.pb_entries_title, self.pb_entries_count)
917
text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
918
self.pb_entries_title, self.pb_entries_count,
919
str(self.pb_entries_total))
921
text = "%s - Stage" % (self.pb_stage_name)
922
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
bzrlib/commit.py
