← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2009-08-04 11:25:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4585.
  • Revision ID: mbp@sourcefrog.net-20090804112523-hijycs32uketxw52
Only give the warning about hardlinking if it was actually requested!

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
49
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
50
# the rest of the code; add a deprecation of the old name.
51
51
 
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
52
59
from bzrlib import (
53
60
    debug,
54
61
    errors,
55
62
    revision,
56
63
    trace,
57
64
    tree,
 
65
    xml_serializer,
58
66
    )
59
67
from bzrlib.branch import Branch
60
 
from bzrlib.cleanup import OperationWithCleanups
61
68
import bzrlib.config
62
69
from bzrlib.errors import (BzrError, PointlessCommit,
63
70
                           ConflictsInTree,
64
71
                           StrictCommitFailed
65
72
                           )
66
73
from bzrlib.osutils import (get_user_encoding,
67
 
                            is_inside_any,
 
74
                            kind_marker, isdir,isfile, is_inside_any,
 
75
                            is_inside_or_parent_of_any,
68
76
                            minimum_path_selection,
 
77
                            quotefn, sha_file, split_lines,
69
78
                            splitpath,
70
79
                            )
71
 
from bzrlib.trace import mutter, note, is_quiet
 
80
from bzrlib.testament import Testament
 
81
from bzrlib.trace import mutter, note, warning, is_quiet
72
82
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
73
83
from bzrlib import symbol_versioning
 
84
from bzrlib.symbol_versioning import (deprecated_passed,
 
85
        deprecated_function,
 
86
        DEPRECATED_PARAMETER)
 
87
from bzrlib.workingtree import WorkingTree
74
88
from bzrlib.urlutils import unescape_for_display
75
89
import bzrlib.ui
76
90
 
132
146
 
133
147
    def completed(self, revno, rev_id):
134
148
        self._note('Committed revision %d.', revno)
135
 
        # self._note goes to the console too; so while we want to log the
136
 
        # rev_id, we can't trivially only log it. (See bug 526425). Long
137
 
        # term we should rearrange the reporting structure, but for now
138
 
        # we just mutter seperately. We mutter the revid and revno together
139
 
        # so that concurrent bzr invocations won't lead to confusion.
140
 
        mutter('Committed revid %s as revno %d.', rev_id, revno)
141
149
 
142
150
    def deleted(self, path):
143
151
        self._note('deleted %s', path)
201
209
        :param timestamp: if not None, seconds-since-epoch for a
202
210
            postdated/predated commit.
203
211
 
204
 
        :param specific_files: If not None, commit only those files. An empty
205
 
            list means 'commit no files'.
 
212
        :param specific_files: If true, commit only those files.
206
213
 
207
214
        :param rev_id: If set, use this as the new revision id.
208
215
            Useful for test or import commands that need to tightly
226
233
            commit. Pending changes to excluded files will be ignored by the
227
234
            commit.
228
235
        """
229
 
        operation = OperationWithCleanups(self._commit)
230
 
        self.revprops = revprops or {}
231
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
232
 
        self.config = config or self.config
233
 
        return operation.run(
234
 
               message=message,
235
 
               timestamp=timestamp,
236
 
               timezone=timezone,
237
 
               committer=committer,
238
 
               specific_files=specific_files,
239
 
               rev_id=rev_id,
240
 
               allow_pointless=allow_pointless,
241
 
               strict=strict,
242
 
               verbose=verbose,
243
 
               working_tree=working_tree,
244
 
               local=local,
245
 
               reporter=reporter,
246
 
               message_callback=message_callback,
247
 
               recursive=recursive,
248
 
               exclude=exclude,
249
 
               possible_master_transports=possible_master_transports)
250
 
 
251
 
    def _commit(self, operation, message, timestamp, timezone, committer,
252
 
            specific_files, rev_id, allow_pointless, strict, verbose,
253
 
            working_tree, local, reporter, message_callback, recursive,
254
 
            exclude, possible_master_transports):
255
236
        mutter('preparing to commit')
256
237
 
257
238
        if working_tree is None:
280
261
            self.exclude = []
281
262
        self.local = local
282
263
        self.master_branch = None
 
264
        self.master_locked = False
283
265
        self.recursive = recursive
284
266
        self.rev_id = None
285
 
        # self.specific_files is None to indicate no filter, or any iterable to
286
 
        # indicate a filter - [] means no files at all, as per iter_changes.
287
267
        if specific_files is not None:
288
268
            self.specific_files = sorted(
289
269
                minimum_path_selection(specific_files))
291
271
            self.specific_files = None
292
272
            
293
273
        self.allow_pointless = allow_pointless
 
274
        self.revprops = revprops
294
275
        self.message_callback = message_callback
295
276
        self.timestamp = timestamp
296
277
        self.timezone = timezone
299
280
        self.verbose = verbose
300
281
 
301
282
        self.work_tree.lock_write()
302
 
        operation.add_cleanup(self.work_tree.unlock)
303
283
        self.parents = self.work_tree.get_parent_ids()
304
284
        # We can use record_iter_changes IFF iter_changes is compatible with
305
285
        # the command line parameters, and the repository has fast delta
306
286
        # generation. See bug 347649.
307
287
        self.use_record_iter_changes = (
 
288
            not self.specific_files and
308
289
            not self.exclude and 
309
290
            not self.branch.repository._format.supports_tree_reference and
310
291
            (self.branch.repository._format.fast_deltas or
311
292
             len(self.parents) < 2))
312
293
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
313
 
        operation.add_cleanup(self.pb.finished)
314
294
        self.basis_revid = self.work_tree.last_revision()
315
295
        self.basis_tree = self.work_tree.basis_tree()
316
296
        self.basis_tree.lock_read()
317
 
        operation.add_cleanup(self.basis_tree.unlock)
318
 
        # Cannot commit with conflicts present.
319
 
        if len(self.work_tree.conflicts()) > 0:
320
 
            raise ConflictsInTree
321
 
 
322
 
        # Setup the bound branch variables as needed.
323
 
        self._check_bound_branch(operation, possible_master_transports)
324
 
 
325
 
        # Check that the working tree is up to date
326
 
        old_revno, new_revno = self._check_out_of_date_tree()
327
 
 
328
 
        # Complete configuration setup
329
 
        if reporter is not None:
330
 
            self.reporter = reporter
331
 
        elif self.reporter is None:
332
 
            self.reporter = self._select_reporter()
333
 
        if self.config is None:
334
 
            self.config = self.branch.get_config()
335
 
 
336
 
        self._set_specific_file_ids()
337
 
 
338
 
        # Setup the progress bar. As the number of files that need to be
339
 
        # committed in unknown, progress is reported as stages.
340
 
        # We keep track of entries separately though and include that
341
 
        # information in the progress bar during the relevant stages.
342
 
        self.pb_stage_name = ""
343
 
        self.pb_stage_count = 0
344
 
        self.pb_stage_total = 5
345
 
        if self.bound_branch:
346
 
            self.pb_stage_total += 1
347
 
        self.pb.show_pct = False
348
 
        self.pb.show_spinner = False
349
 
        self.pb.show_eta = False
350
 
        self.pb.show_count = True
351
 
        self.pb.show_bar = True
352
 
 
353
 
        self._gather_parents()
354
 
        # After a merge, a selected file commit is not supported.
355
 
        # See 'bzr help merge' for an explanation as to why.
356
 
        if len(self.parents) > 1 and self.specific_files is not None:
357
 
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
358
 
        # Excludes are a form of selected file commit.
359
 
        if len(self.parents) > 1 and self.exclude:
360
 
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
361
 
 
362
 
        # Collect the changes
363
 
        self._set_progress_stage("Collecting changes", counter=True)
364
 
        self.builder = self.branch.get_commit_builder(self.parents,
365
 
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
366
 
 
367
297
        try:
368
 
            self.builder.will_record_deletes()
369
 
            # find the location being committed to
370
 
            if self.bound_branch:
371
 
                master_location = self.master_branch.base
372
 
            else:
373
 
                master_location = self.branch.base
374
 
 
375
 
            # report the start of the commit
376
 
            self.reporter.started(new_revno, self.rev_id, master_location)
377
 
 
378
 
            self._update_builder_with_changes()
379
 
            self._check_pointless()
380
 
 
381
 
            # TODO: Now the new inventory is known, check for conflicts.
382
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
383
 
            # weave lines, because nothing should be recorded until it is known
384
 
            # that commit will succeed.
385
 
            self._set_progress_stage("Saving data locally")
386
 
            self.builder.finish_inventory()
387
 
 
388
 
            # Prompt the user for a commit message if none provided
389
 
            message = message_callback(self)
390
 
            self.message = message
391
 
 
392
 
            # Add revision data to the local branch
393
 
            self.rev_id = self.builder.commit(self.message)
394
 
 
395
 
        except Exception, e:
396
 
            mutter("aborting commit write group because of exception:")
397
 
            trace.log_exception_quietly()
398
 
            note("aborting commit write group: %r" % (e,))
399
 
            self.builder.abort()
400
 
            raise
401
 
 
402
 
        self._process_pre_hooks(old_revno, new_revno)
403
 
 
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)
412
 
 
413
 
        # and now do the commit locally.
414
 
        self.branch.set_last_revision_info(new_revno, self.rev_id)
415
 
 
416
 
        # Make the working tree be up to date with the branch. This
417
 
        # includes automatic changes scheduled to be made to the tree, such
418
 
        # as updating its basis and unversioning paths that were missing.
419
 
        self.work_tree.unversion(self.deleted_ids)
420
 
        self._set_progress_stage("Updating the working tree")
421
 
        self.work_tree.update_basis_by_delta(self.rev_id,
422
 
             self.builder.get_basis_delta())
423
 
        self.reporter.completed(new_revno, self.rev_id)
424
 
        self._process_post_hooks(old_revno, new_revno)
 
298
            # Cannot commit with conflicts present.
 
299
            if len(self.work_tree.conflicts()) > 0:
 
300
                raise ConflictsInTree
 
301
 
 
302
            # Setup the bound branch variables as needed.
 
303
            self._check_bound_branch(possible_master_transports)
 
304
 
 
305
            # Check that the working tree is up to date
 
306
            old_revno, new_revno = self._check_out_of_date_tree()
 
307
 
 
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()
 
313
            if self.config is None:
 
314
                self.config = self.branch.get_config()
 
315
 
 
316
            self._set_specific_file_ids()
 
317
 
 
318
            # Setup the progress bar. As the number of files that need to be
 
319
            # committed in unknown, progress is reported as stages.
 
320
            # We keep track of entries separately though and include that
 
321
            # information in the progress bar during the relevant stages.
 
322
            self.pb_stage_name = ""
 
323
            self.pb_stage_count = 0
 
324
            self.pb_stage_total = 5
 
325
            if self.bound_branch:
 
326
                self.pb_stage_total += 1
 
327
            self.pb.show_pct = False
 
328
            self.pb.show_spinner = False
 
329
            self.pb.show_eta = False
 
330
            self.pb.show_count = True
 
331
            self.pb.show_bar = True
 
332
 
 
333
            self._gather_parents()
 
334
            # After a merge, a selected file commit is not supported.
 
335
            # See 'bzr help merge' for an explanation as to why.
 
336
            if len(self.parents) > 1 and self.specific_files:
 
337
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
338
            # Excludes are a form of selected file commit.
 
339
            if len(self.parents) > 1 and self.exclude:
 
340
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
341
 
 
342
            # Collect the changes
 
343
            self._set_progress_stage("Collecting changes", counter=True)
 
344
            self.builder = self.branch.get_commit_builder(self.parents,
 
345
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
346
 
 
347
            try:
 
348
                self.builder.will_record_deletes()
 
349
                # find the location being committed to
 
350
                if self.bound_branch:
 
351
                    master_location = self.master_branch.base
 
352
                else:
 
353
                    master_location = self.branch.base
 
354
 
 
355
                # report the start of the commit
 
356
                self.reporter.started(new_revno, self.rev_id, master_location)
 
357
 
 
358
                self._update_builder_with_changes()
 
359
                self._check_pointless()
 
360
 
 
361
                # TODO: Now the new inventory is known, check for conflicts.
 
362
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
363
                # weave lines, because nothing should be recorded until it is known
 
364
                # that commit will succeed.
 
365
                self._set_progress_stage("Saving data locally")
 
366
                self.builder.finish_inventory()
 
367
 
 
368
                # Prompt the user for a commit message if none provided
 
369
                message = message_callback(self)
 
370
                self.message = message
 
371
 
 
372
                # Add revision data to the local branch
 
373
                self.rev_id = self.builder.commit(self.message)
 
374
 
 
375
            except Exception, e:
 
376
                mutter("aborting commit write group because of exception:")
 
377
                trace.log_exception_quietly()
 
378
                note("aborting commit write group: %r" % (e,))
 
379
                self.builder.abort()
 
380
                raise
 
381
 
 
382
            self._process_pre_hooks(old_revno, new_revno)
 
383
 
 
384
            # Upload revision data to the master.
 
385
            # this will propagate merged revisions too if needed.
 
386
            if self.bound_branch:
 
387
                self._set_progress_stage("Uploading data to master branch")
 
388
                # 'commit' to the master first so a timeout here causes the
 
389
                # local branch to be out of date
 
390
                self.master_branch.import_last_revision_info(
 
391
                    self.branch.repository, new_revno, self.rev_id)
 
392
 
 
393
            # and now do the commit locally.
 
394
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
395
 
 
396
            # Make the working tree be up to date with the branch. This
 
397
            # includes automatic changes scheduled to be made to the tree, such
 
398
            # as updating its basis and unversioning paths that were missing.
 
399
            self.work_tree.unversion(self.deleted_ids)
 
400
            self._set_progress_stage("Updating the working tree")
 
401
            self.work_tree.update_basis_by_delta(self.rev_id,
 
402
                 self.builder.get_basis_delta())
 
403
            self.reporter.completed(new_revno, self.rev_id)
 
404
            self._process_post_hooks(old_revno, new_revno)
 
405
        finally:
 
406
            self._cleanup()
425
407
        return self.rev_id
426
408
 
427
409
    def _select_reporter(self):
449
431
            return
450
432
        raise PointlessCommit()
451
433
 
452
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
434
    def _check_bound_branch(self, possible_master_transports=None):
453
435
        """Check to see if the local branch is bound.
454
436
 
455
437
        If it is bound, then most of the commit will actually be
490
472
        # so grab the lock
491
473
        self.bound_branch = self.branch
492
474
        self.master_branch.lock_write()
493
 
        operation.add_cleanup(self.master_branch.unlock)
 
475
        self.master_locked = True
494
476
 
495
477
    def _check_out_of_date_tree(self):
496
478
        """Check that the working tree is up to date.
581
563
                     old_revno, old_revid, new_revno, self.rev_id,
582
564
                     tree_delta, future_tree)
583
565
 
 
566
    def _cleanup(self):
 
567
        """Cleanup any open locks, progress bars etc."""
 
568
        cleanups = [self._cleanup_bound_branch,
 
569
                    self.basis_tree.unlock,
 
570
                    self.work_tree.unlock,
 
571
                    self.pb.finished]
 
572
        found_exception = None
 
573
        for cleanup in cleanups:
 
574
            try:
 
575
                cleanup()
 
576
            # we want every cleanup to run no matter what.
 
577
            # so we have a catchall here, but we will raise the
 
578
            # last encountered exception up the stack: and
 
579
            # typically this will be useful enough.
 
580
            except Exception, e:
 
581
                found_exception = e
 
582
        if found_exception is not None:
 
583
            # don't do a plan raise, because the last exception may have been
 
584
            # trashed, e is our sure-to-work exception even though it loses the
 
585
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
586
            # exc_info and if its the same one do a plain raise otherwise
 
587
            # 'raise e' as we do now.
 
588
            raise e
 
589
 
 
590
    def _cleanup_bound_branch(self):
 
591
        """Executed at the end of a try/finally to cleanup a bound branch.
 
592
 
 
593
        If the branch wasn't bound, this is a no-op.
 
594
        If it was, it resents self.branch to the local branch, instead
 
595
        of being the master.
 
596
        """
 
597
        if not self.bound_branch:
 
598
            return
 
599
        if self.master_locked:
 
600
            self.master_branch.unlock()
 
601
 
584
602
    def _gather_parents(self):
585
603
        """Record the parents of a merge for merge detection."""
586
604
        # TODO: Make sure that this list doesn't contain duplicate
601
619
        """Update the commit builder with the data about what has changed.
602
620
        """
603
621
        exclude = self.exclude
604
 
        specific_files = self.specific_files
 
622
        specific_files = self.specific_files or []
605
623
        mutter("Selecting files for commit with filter %s", specific_files)
606
624
 
607
625
        self._check_strict()
608
626
        if self.use_record_iter_changes:
609
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
610
 
                specific_files=specific_files)
 
627
            iter_changes = self.work_tree.iter_changes(self.basis_tree)
611
628
            iter_changes = self._filter_iter_changes(iter_changes)
612
629
            for file_id, path, fs_hash in self.builder.record_iter_changes(
613
630
                self.work_tree, self.basis_revid, iter_changes):
785
802
                # _update_builder_with_changes.
786
803
                continue
787
804
            content_summary = self.work_tree.path_content_summary(path)
788
 
            kind = content_summary[0]
789
805
            # Note that when a filter of specific files is given, we must only
790
806
            # skip/record deleted files matching that filter.
791
807
            if not specific_files or is_inside_any(specific_files, path):
792
 
                if kind == 'missing':
 
808
                if content_summary[0] == 'missing':
793
809
                    if not deleted_paths:
794
810
                        # path won't have been split yet.
795
811
                        path_segments = splitpath(path)
802
818
                    continue
803
819
            # TODO: have the builder do the nested commit just-in-time IF and
804
820
            # only if needed.
805
 
            if kind == 'tree-reference':
 
821
            if content_summary[0] == 'tree-reference':
806
822
                # enforce repository nested tree policy.
807
823
                if (not self.work_tree.supports_tree_reference() or
808
824
                    # repository does not support it either.
809
825
                    not self.branch.repository._format.supports_tree_reference):
810
 
                    kind = 'directory'
811
 
                    content_summary = (kind, None, None, None)
812
 
                elif self.recursive == 'down':
 
826
                    content_summary = ('directory',) + content_summary[1:]
 
827
            kind = content_summary[0]
 
828
            # TODO: specific_files filtering before nested tree processing
 
829
            if kind == 'tree-reference':
 
830
                if self.recursive == 'down':
813
831
                    nested_revision_id = self._commit_nested_tree(
814
832
                        file_id, path)
815
 
                    content_summary = (kind, None, None, nested_revision_id)
 
833
                    content_summary = content_summary[:3] + (
 
834
                        nested_revision_id,)
816
835
                else:
817
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
818
 
                    content_summary = (kind, None, None, nested_revision_id)
 
836
                    content_summary = content_summary[:3] + (
 
837
                        self.work_tree.get_reference_revision(file_id),)
819
838
 
820
839
            # Record an entry for this item
821
840
            # Note: I don't particularly want to have the existing_ie