72
72
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
73
73
from bzrlib import symbol_versioning
74
74
from bzrlib.urlutils import unescape_for_display
75
from bzrlib.i18n import gettext
77
78
class NullCommitReporter(object):
78
79
"""I report on progress of a commit."""
113
114
note(format, *args)
115
116
def snapshot_change(self, change, path):
116
if path == '' and change in (gettext('added'), gettext('modified')):
117
if path == '' and change in ('added', 'modified'):
118
119
self._note("%s %s", change, path)
127
128
"to started.", DeprecationWarning,
130
self._note(gettext('Committing%s'), location)
131
self._note('Committing%s', location)
132
133
def completed(self, revno, rev_id):
133
self._note(gettext('Committed revision %d.'), revno)
134
self._note('Committed revision %d.', revno)
134
135
# self._note goes to the console too; so while we want to log the
135
136
# rev_id, we can't trivially only log it. (See bug 526425). Long
136
137
# term we should rearrange the reporting structure, but for now
139
140
mutter('Committed revid %s as revno %d.', rev_id, revno)
141
142
def deleted(self, path):
142
self._note(gettext('deleted %s'), path)
143
self._note('deleted %s', path)
144
145
def missing(self, path):
145
self._note(gettext('missing %s'), path)
146
self._note('missing %s', path)
147
148
def renamed(self, change, old_path, new_path):
148
149
self._note('%s %s => %s', change, old_path, new_path)
166
167
def __init__(self,
169
170
"""Create a Commit object.
171
172
:param reporter: the default reporter to use or None to decide later
173
174
self.reporter = reporter
174
self.config_stack = config_stack
177
def update_revprops(revprops, branch, authors=None, author=None,
178
local=False, possible_master_transports=None):
181
if possible_master_transports is None:
182
possible_master_transports = []
183
if not 'branch-nick' in revprops:
184
revprops['branch-nick'] = branch._get_nick(
186
possible_master_transports)
187
if authors is not None:
188
if author is not None:
189
raise AssertionError('Specifying both author and authors '
190
'is not allowed. Specify just authors instead')
191
if 'author' in revprops or 'authors' in revprops:
192
# XXX: maybe we should just accept one of them?
193
raise AssertionError('author property given twice')
195
for individual in authors:
196
if '\n' in individual:
197
raise AssertionError('\\n is not a valid character '
198
'in an author identity')
199
revprops['authors'] = '\n'.join(authors)
200
if author is not None:
201
symbol_versioning.warn('The parameter author was deprecated'
202
' in version 1.13. Use authors instead',
204
if 'author' in revprops or 'authors' in revprops:
205
# XXX: maybe we should just accept one of them?
206
raise AssertionError('author property given twice')
208
raise AssertionError('\\n is not a valid character '
209
'in an author identity')
210
revprops['authors'] = author
228
192
message_callback=None,
229
193
recursive='down',
231
possible_master_transports=None,
195
possible_master_transports=None):
233
196
"""Commit working copy as a new revision.
235
198
:param message: the commit message (it or message_callback is required)
262
225
:param exclude: None or a list of relative paths to exclude from the
263
226
commit. Pending changes to excluded files will be ignored by the
265
:param lossy: When committing to a foreign VCS, ignore any
266
data that can not be natively represented.
268
229
operation = OperationWithCleanups(self._commit)
269
230
self.revprops = revprops or {}
270
231
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
271
self.config_stack = config or self.config_stack
232
self.config = config or self.config
272
233
return operation.run(
274
235
timestamp=timestamp,
285
246
message_callback=message_callback,
286
247
recursive=recursive,
288
possible_master_transports=possible_master_transports,
249
possible_master_transports=possible_master_transports)
291
251
def _commit(self, operation, message, timestamp, timezone, committer,
292
252
specific_files, rev_id, allow_pointless, strict, verbose,
293
253
working_tree, local, reporter, message_callback, recursive,
294
exclude, possible_master_transports, lossy):
254
exclude, possible_master_transports):
295
255
mutter('preparing to commit')
297
257
if working_tree is None:
329
289
minimum_path_selection(specific_files))
331
291
self.specific_files = None
333
293
self.allow_pointless = allow_pointless
334
294
self.message_callback = message_callback
335
295
self.timestamp = timestamp
349
309
not self.branch.repository._format.supports_tree_reference and
350
310
(self.branch.repository._format.fast_deltas or
351
311
len(self.parents) < 2))
352
self.pb = ui.ui_factory.nested_progress_bar()
312
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
353
313
operation.add_cleanup(self.pb.finished)
354
314
self.basis_revid = self.work_tree.last_revision()
355
315
self.basis_tree = self.work_tree.basis_tree()
363
323
self._check_bound_branch(operation, possible_master_transports)
365
325
# Check that the working tree is up to date
366
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
326
old_revno, new_revno = self._check_out_of_date_tree()
368
328
# Complete configuration setup
369
329
if reporter is not None:
370
330
self.reporter = reporter
371
331
elif self.reporter is None:
372
332
self.reporter = self._select_reporter()
373
if self.config_stack is None:
374
self.config_stack = self.branch.get_config_stack()
333
if self.config is None:
334
self.config = self.branch.get_config()
376
336
self._set_specific_file_ids()
404
362
# Collect the changes
405
363
self._set_progress_stage("Collecting changes", counter=True)
407
364
self.builder = self.branch.get_commit_builder(self.parents,
408
self.config_stack, timestamp, timezone, committer, self.revprops,
410
if not self.builder.supports_record_entry_contents and self.exclude:
412
raise errors.ExcludesUnsupported(self.branch.repository)
414
if self.builder.updates_branch and self.bound_branch:
416
raise AssertionError(
417
"bound branches not supported for commit builders "
418
"that update the branch")
365
self.config, timestamp, timezone, committer, self.revprops, rev_id)
421
368
self.builder.will_record_deletes()
448
395
except Exception, e:
449
396
mutter("aborting commit write group because of exception:")
450
397
trace.log_exception_quietly()
398
note("aborting commit write group: %r" % (e,))
451
399
self.builder.abort()
454
self._update_branches(old_revno, old_revid, new_revno)
402
self._process_pre_hooks(old_revno, new_revno)
404
# Upload revision data to the master.
405
# this will propagate merged revisions too if needed.
406
if self.bound_branch:
407
self._set_progress_stage("Uploading data to master branch")
408
# 'commit' to the master first so a timeout here causes the
409
# local branch to be out of date
410
self.master_branch.import_last_revision_info(
411
self.branch.repository, new_revno, self.rev_id)
413
# and now do the commit locally.
414
self.branch.set_last_revision_info(new_revno, self.rev_id)
456
416
# Make the working tree be up to date with the branch. This
457
417
# includes automatic changes scheduled to be made to the tree, such
464
424
self._process_post_hooks(old_revno, new_revno)
465
425
return self.rev_id
467
def _update_branches(self, old_revno, old_revid, new_revno):
468
"""Update the master and local branch to the new revision.
470
This will try to make sure that the master branch is updated
471
before the local branch.
473
:param old_revno: Revision number of master branch before the
475
:param old_revid: Tip of master branch before the commit
476
:param new_revno: Revision number of the new commit
478
if not self.builder.updates_branch:
479
self._process_pre_hooks(old_revno, new_revno)
481
# Upload revision data to the master.
482
# this will propagate merged revisions too if needed.
483
if self.bound_branch:
484
self._set_progress_stage("Uploading data to master branch")
485
# 'commit' to the master first so a timeout here causes the
486
# local branch to be out of date
487
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
488
self.branch, new_revno, self.rev_id, lossy=self._lossy)
490
self.branch.fetch(self.master_branch, self.rev_id)
492
# and now do the commit locally.
493
self.branch.set_last_revision_info(new_revno, self.rev_id)
496
self._process_pre_hooks(old_revno, new_revno)
498
# The commit builder will already have updated the branch,
500
self.branch.set_last_revision_info(old_revno, old_revid)
503
# Merge local tags to remote
504
if self.bound_branch:
505
self._set_progress_stage("Merging tags to master branch")
506
tag_updates, tag_conflicts = self.branch.tags.merge_to(
507
self.master_branch.tags)
509
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
510
note( gettext("Conflicting tags in bound branch:\n{0}".format(
511
"\n".join(warning_lines))) )
513
427
def _select_reporter(self):
514
428
"""Select the CommitReporter to use."""
522
436
# A merge with no effect on files
523
437
if len(self.parents) > 1:
439
# TODO: we could simplify this by using self.builder.basis_delta.
441
# The initial commit adds a root directory, but this in itself is not
442
# a worthwhile commit.
443
if (self.basis_revid == revision.NULL_REVISION and
444
((self.builder.new_inventory is not None and
445
len(self.builder.new_inventory) == 1) or
446
len(self.builder._basis_delta) == 1)):
447
raise PointlessCommit()
525
448
if self.builder.any_changes():
527
450
raise PointlessCommit()
572
495
def _check_out_of_date_tree(self):
573
496
"""Check that the working tree is up to date.
575
:return: old_revision_number, old_revision_id, new_revision_number
498
:return: old_revision_number,new_revision_number tuple
579
501
first_tree_parent = self.work_tree.get_parent_ids()[0]
593
515
# ghost parents never appear in revision history.
595
return old_revno, master_last, new_revno
517
return old_revno,new_revno
597
519
def _process_pre_hooks(self, old_revno, new_revno):
598
520
"""Process any registered pre commit hooks."""
604
526
# Process the post commit hooks, if any
605
527
self._set_progress_stage("Running post_commit hooks")
606
528
# old style commit hooks - should be deprecated ? (obsoleted in
607
# 0.15^H^H^H^H 2.5.0)
608
post_commit = self.config_stack.get('post_commit')
609
if post_commit is not None:
610
hooks = post_commit.split(' ')
530
if self.config.post_commit() is not None:
531
hooks = self.config.post_commit().split(' ')
611
532
# this would be nicer with twisted.python.reflect.namedAny
612
533
for hook in hooks:
613
534
result = eval(hook + '(branch, rev_id)',
725
646
# Reset the new path (None) and new versioned flag (False)
726
647
change = (change[0], (change[1][0], None), change[2],
727
648
(change[3][0], False)) + change[4:]
728
new_path = change[1][1]
730
649
elif kind == 'tree-reference':
731
650
if self.recursive == 'down':
732
651
self._commit_nested_tree(change[0], change[1][1])
736
655
if new_path is None:
737
656
reporter.deleted(old_path)
738
657
elif old_path is None:
739
reporter.snapshot_change(gettext('added'), new_path)
658
reporter.snapshot_change('added', new_path)
740
659
elif old_path != new_path:
741
reporter.renamed(gettext('renamed'), old_path, new_path)
660
reporter.renamed('renamed', old_path, new_path)
744
663
self.work_tree.branch.repository._format.rich_root_data):
745
664
# Don't report on changes to '' in non rich root
747
reporter.snapshot_change(gettext('modified'), new_path)
666
reporter.snapshot_change('modified', new_path)
748
667
self._next_progress_entry()
749
668
# Unversion IDs that were found to be deleted
750
669
self.deleted_ids = deleted_ids
756
675
if self.specific_files or self.exclude:
757
676
specific_files = self.specific_files or []
758
677
for path, old_ie in self.basis_inv.iter_entries():
759
if self.builder.new_inventory.has_id(old_ie.file_id):
678
if old_ie.file_id in self.builder.new_inventory:
760
679
# already added - skip.
762
681
if (is_inside_any(specific_files, path)
973
892
self.reporter.renamed(change, old_path, path)
974
893
self._next_progress_entry()
976
if change == gettext('unchanged'):
895
if change == 'unchanged':
978
897
self.reporter.snapshot_change(change, path)
979
898
self._next_progress_entry()
996
915
def _emit_progress(self):
997
916
if self.pb_entries_count is not None:
998
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
917
text = "%s [%d] - Stage" % (self.pb_stage_name,
999
918
self.pb_entries_count)
1001
text = gettext("%s - Stage") % (self.pb_stage_name, )
920
text = "%s - Stage" % (self.pb_stage_name, )
1002
921
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
1004
923
def _set_specific_file_ids(self):
added
removed
bzrlib/commit.py
