~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: John Arbash Meinel
  • Date: 2010-02-17 17:11:16 UTC
  • mfrom: (4797.2.17 2.1)
  • mto: (4797.2.18 2.1)
  • mto: This revision was merged to the branch mainline in revision 5055.
  • Revision ID: john@arbash-meinel.com-20100217171116-h7t9223ystbnx5h8
merge bzr.2.1 in preparation for NEWS entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
65
65
    xml_serializer,
66
66
    )
67
67
from bzrlib.branch import Branch
 
68
from bzrlib.cleanup import OperationWithCleanups
68
69
import bzrlib.config
69
70
from bzrlib.errors import (BzrError, PointlessCommit,
70
71
                           ConflictsInTree,
234
235
            commit. Pending changes to excluded files will be ignored by the
235
236
            commit.
236
237
        """
 
238
        operation = OperationWithCleanups(self._commit)
 
239
        return operation.run(
 
240
               message=message,
 
241
               timestamp=timestamp,
 
242
               timezone=timezone,
 
243
               committer=committer,
 
244
               specific_files=specific_files,
 
245
               rev_id=rev_id,
 
246
               allow_pointless=allow_pointless,
 
247
               strict=strict,
 
248
               verbose=verbose,
 
249
               revprops=revprops,
 
250
               working_tree=working_tree,
 
251
               local=local,
 
252
               reporter=reporter,
 
253
               config=config,
 
254
               message_callback=message_callback,
 
255
               recursive=recursive,
 
256
               exclude=exclude,
 
257
               possible_master_transports=possible_master_transports)
 
258
 
 
259
    def _commit(self, operation, message, timestamp, timezone, committer,
 
260
            specific_files, rev_id, allow_pointless, strict, verbose, revprops,
 
261
            working_tree, local, reporter, config, message_callback, recursive,
 
262
            exclude, possible_master_transports):
237
263
        mutter('preparing to commit')
238
264
 
239
265
        if working_tree is None:
262
288
            self.exclude = []
263
289
        self.local = local
264
290
        self.master_branch = None
265
 
        self.master_locked = False
266
291
        self.recursive = recursive
267
292
        self.rev_id = None
268
293
        # self.specific_files is None to indicate no filter, or any iterable to
283
308
        self.verbose = verbose
284
309
 
285
310
        self.work_tree.lock_write()
 
311
        operation.add_cleanup(self.work_tree.unlock)
286
312
        self.parents = self.work_tree.get_parent_ids()
287
313
        # We can use record_iter_changes IFF iter_changes is compatible with
288
314
        # the command line parameters, and the repository has fast delta
293
319
            (self.branch.repository._format.fast_deltas or
294
320
             len(self.parents) < 2))
295
321
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
322
        operation.add_cleanup(self.pb.finished)
296
323
        self.basis_revid = self.work_tree.last_revision()
297
324
        self.basis_tree = self.work_tree.basis_tree()
298
325
        self.basis_tree.lock_read()
 
326
        operation.add_cleanup(self.basis_tree.unlock)
 
327
        # Cannot commit with conflicts present.
 
328
        if len(self.work_tree.conflicts()) > 0:
 
329
            raise ConflictsInTree
 
330
 
 
331
        # Setup the bound branch variables as needed.
 
332
        self._check_bound_branch(operation, possible_master_transports)
 
333
 
 
334
        # Check that the working tree is up to date
 
335
        old_revno, new_revno = self._check_out_of_date_tree()
 
336
 
 
337
        # Complete configuration setup
 
338
        if reporter is not None:
 
339
            self.reporter = reporter
 
340
        elif self.reporter is None:
 
341
            self.reporter = self._select_reporter()
 
342
        if self.config is None:
 
343
            self.config = self.branch.get_config()
 
344
 
 
345
        self._set_specific_file_ids()
 
346
 
 
347
        # Setup the progress bar. As the number of files that need to be
 
348
        # committed in unknown, progress is reported as stages.
 
349
        # We keep track of entries separately though and include that
 
350
        # information in the progress bar during the relevant stages.
 
351
        self.pb_stage_name = ""
 
352
        self.pb_stage_count = 0
 
353
        self.pb_stage_total = 5
 
354
        if self.bound_branch:
 
355
            self.pb_stage_total += 1
 
356
        self.pb.show_pct = False
 
357
        self.pb.show_spinner = False
 
358
        self.pb.show_eta = False
 
359
        self.pb.show_count = True
 
360
        self.pb.show_bar = True
 
361
 
 
362
        self._gather_parents()
 
363
        # After a merge, a selected file commit is not supported.
 
364
        # See 'bzr help merge' for an explanation as to why.
 
365
        if len(self.parents) > 1 and self.specific_files is not None:
 
366
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
367
        # Excludes are a form of selected file commit.
 
368
        if len(self.parents) > 1 and self.exclude:
 
369
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
370
 
 
371
        # Collect the changes
 
372
        self._set_progress_stage("Collecting changes", counter=True)
 
373
        self.builder = self.branch.get_commit_builder(self.parents,
 
374
            self.config, timestamp, timezone, committer, revprops, rev_id)
 
375
 
299
376
        try:
300
 
            # Cannot commit with conflicts present.
301
 
            if len(self.work_tree.conflicts()) > 0:
302
 
                raise ConflictsInTree
303
 
 
304
 
            # Setup the bound branch variables as needed.
305
 
            self._check_bound_branch(possible_master_transports)
306
 
 
307
 
            # Check that the working tree is up to date
308
 
            old_revno, new_revno = self._check_out_of_date_tree()
309
 
 
310
 
            # Complete configuration setup
311
 
            if reporter is not None:
312
 
                self.reporter = reporter
313
 
            elif self.reporter is None:
314
 
                self.reporter = self._select_reporter()
315
 
            if self.config is None:
316
 
                self.config = self.branch.get_config()
317
 
 
318
 
            self._set_specific_file_ids()
319
 
 
320
 
            # Setup the progress bar. As the number of files that need to be
321
 
            # committed in unknown, progress is reported as stages.
322
 
            # We keep track of entries separately though and include that
323
 
            # information in the progress bar during the relevant stages.
324
 
            self.pb_stage_name = ""
325
 
            self.pb_stage_count = 0
326
 
            self.pb_stage_total = 5
327
 
            if self.bound_branch:
328
 
                self.pb_stage_total += 1
329
 
            self.pb.show_pct = False
330
 
            self.pb.show_spinner = False
331
 
            self.pb.show_eta = False
332
 
            self.pb.show_count = True
333
 
            self.pb.show_bar = True
334
 
 
335
 
            self._gather_parents()
336
 
            # After a merge, a selected file commit is not supported.
337
 
            # See 'bzr help merge' for an explanation as to why.
338
 
            if len(self.parents) > 1 and self.specific_files is not None:
339
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
340
 
            # Excludes are a form of selected file commit.
341
 
            if len(self.parents) > 1 and self.exclude:
342
 
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
343
 
 
344
 
            # Collect the changes
345
 
            self._set_progress_stage("Collecting changes", counter=True)
346
 
            self.builder = self.branch.get_commit_builder(self.parents,
347
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
348
 
 
349
 
            try:
350
 
                self.builder.will_record_deletes()
351
 
                # find the location being committed to
352
 
                if self.bound_branch:
353
 
                    master_location = self.master_branch.base
354
 
                else:
355
 
                    master_location = self.branch.base
356
 
 
357
 
                # report the start of the commit
358
 
                self.reporter.started(new_revno, self.rev_id, master_location)
359
 
 
360
 
                self._update_builder_with_changes()
361
 
                self._check_pointless()
362
 
 
363
 
                # TODO: Now the new inventory is known, check for conflicts.
364
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
365
 
                # weave lines, because nothing should be recorded until it is known
366
 
                # that commit will succeed.
367
 
                self._set_progress_stage("Saving data locally")
368
 
                self.builder.finish_inventory()
369
 
 
370
 
                # Prompt the user for a commit message if none provided
371
 
                message = message_callback(self)
372
 
                self.message = message
373
 
 
374
 
                # Add revision data to the local branch
375
 
                self.rev_id = self.builder.commit(self.message)
376
 
 
377
 
            except Exception, e:
378
 
                mutter("aborting commit write group because of exception:")
379
 
                trace.log_exception_quietly()
380
 
                note("aborting commit write group: %r" % (e,))
381
 
                self.builder.abort()
382
 
                raise
383
 
 
384
 
            self._process_pre_hooks(old_revno, new_revno)
385
 
 
386
 
            # Upload revision data to the master.
387
 
            # this will propagate merged revisions too if needed.
388
 
            if self.bound_branch:
389
 
                self._set_progress_stage("Uploading data to master branch")
390
 
                # 'commit' to the master first so a timeout here causes the
391
 
                # local branch to be out of date
392
 
                self.master_branch.import_last_revision_info(
393
 
                    self.branch.repository, new_revno, self.rev_id)
394
 
 
395
 
            # and now do the commit locally.
396
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
397
 
 
398
 
            # Make the working tree be up to date with the branch. This
399
 
            # includes automatic changes scheduled to be made to the tree, such
400
 
            # as updating its basis and unversioning paths that were missing.
401
 
            self.work_tree.unversion(self.deleted_ids)
402
 
            self._set_progress_stage("Updating the working tree")
403
 
            self.work_tree.update_basis_by_delta(self.rev_id,
404
 
                 self.builder.get_basis_delta())
405
 
            self.reporter.completed(new_revno, self.rev_id)
406
 
            self._process_post_hooks(old_revno, new_revno)
407
 
        finally:
408
 
            self._cleanup()
 
377
            self.builder.will_record_deletes()
 
378
            # find the location being committed to
 
379
            if self.bound_branch:
 
380
                master_location = self.master_branch.base
 
381
            else:
 
382
                master_location = self.branch.base
 
383
 
 
384
            # report the start of the commit
 
385
            self.reporter.started(new_revno, self.rev_id, master_location)
 
386
 
 
387
            self._update_builder_with_changes()
 
388
            self._check_pointless()
 
389
 
 
390
            # TODO: Now the new inventory is known, check for conflicts.
 
391
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
392
            # weave lines, because nothing should be recorded until it is known
 
393
            # that commit will succeed.
 
394
            self._set_progress_stage("Saving data locally")
 
395
            self.builder.finish_inventory()
 
396
 
 
397
            # Prompt the user for a commit message if none provided
 
398
            message = message_callback(self)
 
399
            self.message = message
 
400
 
 
401
            # Add revision data to the local branch
 
402
            self.rev_id = self.builder.commit(self.message)
 
403
 
 
404
        except Exception, e:
 
405
            mutter("aborting commit write group because of exception:")
 
406
            trace.log_exception_quietly()
 
407
            note("aborting commit write group: %r" % (e,))
 
408
            self.builder.abort()
 
409
            raise
 
410
 
 
411
        self._process_pre_hooks(old_revno, new_revno)
 
412
 
 
413
        # Upload revision data to the master.
 
414
        # this will propagate merged revisions too if needed.
 
415
        if self.bound_branch:
 
416
            self._set_progress_stage("Uploading data to master branch")
 
417
            # 'commit' to the master first so a timeout here causes the
 
418
            # local branch to be out of date
 
419
            self.master_branch.import_last_revision_info(
 
420
                self.branch.repository, new_revno, self.rev_id)
 
421
 
 
422
        # and now do the commit locally.
 
423
        self.branch.set_last_revision_info(new_revno, self.rev_id)
 
424
 
 
425
        # Make the working tree be up to date with the branch. This
 
426
        # includes automatic changes scheduled to be made to the tree, such
 
427
        # as updating its basis and unversioning paths that were missing.
 
428
        self.work_tree.unversion(self.deleted_ids)
 
429
        self._set_progress_stage("Updating the working tree")
 
430
        self.work_tree.update_basis_by_delta(self.rev_id,
 
431
             self.builder.get_basis_delta())
 
432
        self.reporter.completed(new_revno, self.rev_id)
 
433
        self._process_post_hooks(old_revno, new_revno)
409
434
        return self.rev_id
410
435
 
411
436
    def _select_reporter(self):
433
458
            return
434
459
        raise PointlessCommit()
435
460
 
436
 
    def _check_bound_branch(self, possible_master_transports=None):
 
461
    def _check_bound_branch(self, operation, possible_master_transports=None):
437
462
        """Check to see if the local branch is bound.
438
463
 
439
464
        If it is bound, then most of the commit will actually be
474
499
        # so grab the lock
475
500
        self.bound_branch = self.branch
476
501
        self.master_branch.lock_write()
477
 
        self.master_locked = True
 
502
        operation.add_cleanup(self.master_branch.unlock)
478
503
 
479
504
    def _check_out_of_date_tree(self):
480
505
        """Check that the working tree is up to date.
565
590
                     old_revno, old_revid, new_revno, self.rev_id,
566
591
                     tree_delta, future_tree)
567
592
 
568
 
    def _cleanup(self):
569
 
        """Cleanup any open locks, progress bars etc."""
570
 
        cleanups = [self._cleanup_bound_branch,
571
 
                    self.basis_tree.unlock,
572
 
                    self.work_tree.unlock,
573
 
                    self.pb.finished]
574
 
        found_exception = None
575
 
        for cleanup in cleanups:
576
 
            try:
577
 
                cleanup()
578
 
            # we want every cleanup to run no matter what.
579
 
            # so we have a catchall here, but we will raise the
580
 
            # last encountered exception up the stack: and
581
 
            # typically this will be useful enough.
582
 
            except Exception, e:
583
 
                found_exception = e
584
 
        if found_exception is not None:
585
 
            # don't do a plan raise, because the last exception may have been
586
 
            # trashed, e is our sure-to-work exception even though it loses the
587
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
588
 
            # exc_info and if its the same one do a plain raise otherwise
589
 
            # 'raise e' as we do now.
590
 
            raise e
591
 
 
592
 
    def _cleanup_bound_branch(self):
593
 
        """Executed at the end of a try/finally to cleanup a bound branch.
594
 
 
595
 
        If the branch wasn't bound, this is a no-op.
596
 
        If it was, it resents self.branch to the local branch, instead
597
 
        of being the master.
598
 
        """
599
 
        if not self.bound_branch:
600
 
            return
601
 
        if self.master_locked:
602
 
            self.master_branch.unlock()
603
 
 
604
593
    def _gather_parents(self):
605
594
        """Record the parents of a merge for merge detection."""
606
595
        # TODO: Make sure that this list doesn't contain duplicate