/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: INADA Naoki
  • Date: 2011-05-05 09:15:34 UTC
  • mto: (5830.3.3 i18n-msgfmt)
  • mto: This revision was merged to the branch mainline in revision 5873.
  • Revision ID: songofacandy@gmail.com-20110505091534-7sv835xpofwrmpt4
Add update-pot command to Makefile and tools/bzrgettext script that
extracts help text from bzr commands.

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
18
# The newly committed revision is going to have a shape corresponding
20
19
# to that of the working tree.  Files that are not in the
50
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
50
# the rest of the code; add a deprecation of the old name.
52
51
 
53
 
from . import (
 
52
from bzrlib import (
54
53
    debug,
55
54
    errors,
 
55
    revision,
56
56
    trace,
 
57
    tree,
57
58
    ui,
58
59
    )
59
 
from .branch import Branch
60
 
from .cleanup import ExitStack
61
 
import breezy.config
62
 
from .errors import (BzrError,
63
 
                     ConflictsInTree,
64
 
                     StrictCommitFailed
65
 
                     )
66
 
from .osutils import (get_user_encoding,
67
 
                      has_symlinks,
68
 
                      is_inside_any,
69
 
                      minimum_path_selection,
70
 
                      )
71
 
from .trace import mutter, note, is_quiet
72
 
from .tree import TreeChange
73
 
from .urlutils import unescape_for_display
74
 
from .i18n import gettext
75
 
 
76
 
 
77
 
class PointlessCommit(BzrError):
78
 
 
79
 
    _fmt = "No changes to commit"
80
 
 
81
 
 
82
 
class CannotCommitSelectedFileMerge(BzrError):
83
 
 
84
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
85
 
        ' files %(files_str)s'
86
 
 
87
 
    def __init__(self, files):
88
 
        files_str = ', '.join(files)
89
 
        BzrError.__init__(self, files=files, files_str=files_str)
90
 
 
91
 
 
92
 
def filter_excluded(iter_changes, exclude):
93
 
    """Filter exclude filenames.
94
 
 
95
 
    :param iter_changes: iter_changes function
96
 
    :param exclude: List of paths to exclude
97
 
    :return: iter_changes function
98
 
    """
99
 
    for change in iter_changes:
100
 
        new_excluded = (change.path[1] is not None and
101
 
                        is_inside_any(exclude, change.path[1]))
102
 
 
103
 
        old_excluded = (change.path[0] is not None and
104
 
                        is_inside_any(exclude, change.path[0]))
105
 
 
106
 
        if old_excluded and new_excluded:
107
 
            continue
108
 
 
109
 
        if old_excluded or new_excluded:
110
 
            # TODO(jelmer): Perhaps raise an error here instead?
111
 
            continue
112
 
 
113
 
        yield change
 
60
from bzrlib.branch import Branch
 
61
from bzrlib.cleanup import OperationWithCleanups
 
62
import bzrlib.config
 
63
from bzrlib.errors import (BzrError, PointlessCommit,
 
64
                           ConflictsInTree,
 
65
                           StrictCommitFailed
 
66
                           )
 
67
from bzrlib.osutils import (get_user_encoding,
 
68
                            is_inside_any,
 
69
                            minimum_path_selection,
 
70
                            splitpath,
 
71
                            )
 
72
from bzrlib.trace import mutter, note, is_quiet
 
73
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
74
from bzrlib import symbol_versioning
 
75
from bzrlib.urlutils import unescape_for_display
114
76
 
115
77
 
116
78
class NullCommitReporter(object):
117
79
    """I report on progress of a commit."""
118
80
 
119
 
    def started(self, revno, revid, location):
 
81
    def started(self, revno, revid, location=None):
 
82
        if location is None:
 
83
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
84
                                   "to started.", DeprecationWarning,
 
85
                                   stacklevel=2)
120
86
        pass
121
87
 
122
88
    def snapshot_change(self, change, path):
148
114
        note(format, *args)
149
115
 
150
116
    def snapshot_change(self, change, path):
151
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
117
        if path == '' and change in ('added', 'modified'):
152
118
            return
153
119
        self._note("%s %s", change, path)
154
120
 
155
 
    def started(self, revno, rev_id, location):
156
 
        self._note(
157
 
            gettext('Committing to: %s'),
158
 
            unescape_for_display(location, 'utf-8'))
 
121
    def started(self, revno, rev_id, location=None):
 
122
        if location is not None:
 
123
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
124
        else:
 
125
            # When started was added, location was only made optional by
 
126
            # accident.  Matt Nordhoff 20071129
 
127
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
128
                                   "to started.", DeprecationWarning,
 
129
                                   stacklevel=2)
 
130
            location = ''
 
131
        self._note('Committing%s', location)
159
132
 
160
133
    def completed(self, revno, rev_id):
161
 
        if revno is not None:
162
 
            self._note(gettext('Committed revision %d.'), revno)
163
 
            # self._note goes to the console too; so while we want to log the
164
 
            # rev_id, we can't trivially only log it. (See bug 526425). Long
165
 
            # term we should rearrange the reporting structure, but for now
166
 
            # we just mutter seperately. We mutter the revid and revno together
167
 
            # so that concurrent bzr invocations won't lead to confusion.
168
 
            mutter('Committed revid %s as revno %d.', rev_id, revno)
169
 
        else:
170
 
            self._note(gettext('Committed revid %s.'), rev_id)
 
134
        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)
171
141
 
172
142
    def deleted(self, path):
173
 
        self._note(gettext('deleted %s'), path)
 
143
        self._note('deleted %s', path)
174
144
 
175
145
    def missing(self, path):
176
 
        self._note(gettext('missing %s'), path)
 
146
        self._note('missing %s', path)
177
147
 
178
148
    def renamed(self, change, old_path, new_path):
179
149
        self._note('%s %s => %s', change, old_path, new_path)
194
164
            the working directory; these should be removed from the
195
165
            working inventory.
196
166
    """
197
 
 
198
167
    def __init__(self,
199
168
                 reporter=None,
200
 
                 config_stack=None):
 
169
                 config=None):
201
170
        """Create a Commit object.
202
171
 
203
172
        :param reporter: the default reporter to use or None to decide later
204
173
        """
205
174
        self.reporter = reporter
206
 
        self.config_stack = config_stack
 
175
        self.config = config
207
176
 
208
177
    @staticmethod
209
 
    def update_revprops(revprops, branch, authors=None,
 
178
    def update_revprops(revprops, branch, authors=None, author=None,
210
179
                        local=False, possible_master_transports=None):
211
180
        if revprops is None:
212
181
            revprops = {}
213
182
        if possible_master_transports is None:
214
183
            possible_master_transports = []
215
 
        if (u'branch-nick' not in revprops and
216
 
                branch.repository._format.supports_storing_branch_nick):
217
 
            revprops[u'branch-nick'] = branch._get_nick(
 
184
        if not 'branch-nick' in revprops:
 
185
            revprops['branch-nick'] = branch._get_nick(
218
186
                local,
219
187
                possible_master_transports)
220
188
        if authors is not None:
221
 
            if u'author' in revprops or u'authors' in revprops:
 
189
            if author is not None:
 
190
                raise AssertionError('Specifying both author and authors '
 
191
                        'is not allowed. Specify just authors instead')
 
192
            if 'author' in revprops or 'authors' in revprops:
222
193
                # XXX: maybe we should just accept one of them?
223
194
                raise AssertionError('author property given twice')
224
195
            if authors:
225
196
                for individual in authors:
226
197
                    if '\n' in individual:
227
198
                        raise AssertionError('\\n is not a valid character '
228
 
                                             'in an author identity')
229
 
                revprops[u'authors'] = '\n'.join(authors)
 
199
                                'in an author identity')
 
200
                revprops['authors'] = '\n'.join(authors)
 
201
        if author is not None:
 
202
            symbol_versioning.warn('The parameter author was deprecated'
 
203
                   ' in version 1.13. Use authors instead',
 
204
                   DeprecationWarning)
 
205
            if 'author' in revprops or 'authors' in revprops:
 
206
                # XXX: maybe we should just accept one of them?
 
207
                raise AssertionError('author property given twice')
 
208
            if '\n' in author:
 
209
                raise AssertionError('\\n is not a valid character '
 
210
                        'in an author identity')
 
211
            revprops['authors'] = author
230
212
        return revprops
231
213
 
232
214
    def commit(self,
252
234
        """Commit working copy as a new revision.
253
235
 
254
236
        :param message: the commit message (it or message_callback is required)
255
 
        :param message_callback: A callback: message =
256
 
            message_callback(cmt_obj)
 
237
        :param message_callback: A callback: message = message_callback(cmt_obj)
257
238
 
258
239
        :param timestamp: if not None, seconds-since-epoch for a
259
240
            postdated/predated commit.
285
266
        :param lossy: When committing to a foreign VCS, ignore any
286
267
            data that can not be natively represented.
287
268
        """
288
 
        with ExitStack() as stack:
289
 
            self.revprops = revprops or {}
290
 
            # XXX: Can be set on __init__ or passed in - this is a bit ugly.
291
 
            self.config_stack = config or self.config_stack
292
 
            mutter('preparing to commit')
293
 
 
294
 
            if working_tree is None:
295
 
                raise BzrError("working_tree must be passed into commit().")
296
 
            else:
297
 
                self.work_tree = working_tree
298
 
                self.branch = self.work_tree.branch
299
 
                if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
300
 
                    if not self.branch.repository.supports_rich_root():
301
 
                        raise errors.RootNotRich()
302
 
            if message_callback is None:
303
 
                if message is not None:
304
 
                    if isinstance(message, bytes):
305
 
                        message = message.decode(get_user_encoding())
306
 
 
307
 
                    def message_callback(x):
308
 
                        return message
309
 
                else:
310
 
                    raise BzrError("The message or message_callback keyword"
311
 
                                   " parameter is required for commit().")
312
 
 
313
 
            self.bound_branch = None
314
 
            self.any_entries_deleted = False
315
 
            if exclude is not None:
316
 
                self.exclude = sorted(
317
 
                    minimum_path_selection(exclude))
318
 
            else:
319
 
                self.exclude = []
320
 
            self.local = local
321
 
            self.master_branch = None
322
 
            self.recursive = recursive
323
 
            self.rev_id = None
324
 
            # self.specific_files is None to indicate no filter, or any iterable to
325
 
            # indicate a filter - [] means no files at all, as per iter_changes.
326
 
            if specific_files is not None:
327
 
                self.specific_files = sorted(
328
 
                    minimum_path_selection(specific_files))
329
 
            else:
330
 
                self.specific_files = None
331
 
 
332
 
            self.allow_pointless = allow_pointless
333
 
            self.message_callback = message_callback
334
 
            self.timestamp = timestamp
335
 
            self.timezone = timezone
336
 
            self.committer = committer
337
 
            self.strict = strict
338
 
            self.verbose = verbose
339
 
 
340
 
            stack.enter_context(self.work_tree.lock_write())
341
 
            self.parents = self.work_tree.get_parent_ids()
342
 
            self.pb = ui.ui_factory.nested_progress_bar()
343
 
            stack.callback(self.pb.finished)
344
 
            self.basis_revid = self.work_tree.last_revision()
345
 
            self.basis_tree = self.work_tree.basis_tree()
346
 
            stack.enter_context(self.basis_tree.lock_read())
347
 
            # Cannot commit with conflicts present.
348
 
            if len(self.work_tree.conflicts()) > 0:
349
 
                raise ConflictsInTree
350
 
 
351
 
            # Setup the bound branch variables as needed.
352
 
            self._check_bound_branch(stack, possible_master_transports)
353
 
            if self.config_stack is None:
354
 
                self.config_stack = self.work_tree.get_config_stack()
355
 
 
356
 
            # Check that the working tree is up to date
357
 
            old_revno, old_revid, new_revno = self._check_out_of_date_tree()
358
 
 
359
 
            # Complete configuration setup
360
 
            if reporter is not None:
361
 
                self.reporter = reporter
362
 
            elif self.reporter is None:
363
 
                self.reporter = self._select_reporter()
364
 
 
365
 
            # Setup the progress bar. As the number of files that need to be
366
 
            # committed in unknown, progress is reported as stages.
367
 
            # We keep track of entries separately though and include that
368
 
            # information in the progress bar during the relevant stages.
369
 
            self.pb_stage_name = ""
370
 
            self.pb_stage_count = 0
371
 
            self.pb_stage_total = 5
372
 
            if self.bound_branch:
373
 
                # 2 extra stages: "Uploading data to master branch" and "Merging
374
 
                # tags to master branch"
375
 
                self.pb_stage_total += 2
376
 
            self.pb.show_pct = False
377
 
            self.pb.show_spinner = False
378
 
            self.pb.show_eta = False
379
 
            self.pb.show_count = True
380
 
            self.pb.show_bar = True
381
 
 
382
 
            # After a merge, a selected file commit is not supported.
383
 
            # See 'bzr help merge' for an explanation as to why.
384
 
            if len(self.parents) > 1 and self.specific_files is not None:
385
 
                raise CannotCommitSelectedFileMerge(self.specific_files)
386
 
            # Excludes are a form of selected file commit.
387
 
            if len(self.parents) > 1 and self.exclude:
388
 
                raise CannotCommitSelectedFileMerge(self.exclude)
389
 
 
390
 
            # Collect the changes
391
 
            self._set_progress_stage("Collecting changes", counter=True)
392
 
            self._lossy = lossy
393
 
            self.builder = self.branch.get_commit_builder(
394
 
                self.parents, self.config_stack, timestamp, timezone, committer,
395
 
                self.revprops, rev_id, lossy=lossy)
396
 
 
397
 
            if self.builder.updates_branch and self.bound_branch:
398
 
                self.builder.abort()
399
 
                raise AssertionError(
400
 
                    "bound branches not supported for commit builders "
401
 
                    "that update the branch")
402
 
 
403
 
            try:
404
 
                # find the location being committed to
405
 
                if self.bound_branch:
406
 
                    master_location = self.master_branch.base
407
 
                else:
408
 
                    master_location = self.branch.base
409
 
 
410
 
                # report the start of the commit
411
 
                self.reporter.started(new_revno, self.rev_id, master_location)
412
 
 
413
 
                self._update_builder_with_changes()
414
 
                self._check_pointless()
415
 
 
416
 
                # TODO: Now the new inventory is known, check for conflicts.
417
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
418
 
                # weave lines, because nothing should be recorded until it is known
419
 
                # that commit will succeed.
420
 
                self._set_progress_stage("Saving data locally")
421
 
                self.builder.finish_inventory()
422
 
 
423
 
                # Prompt the user for a commit message if none provided
424
 
                message = message_callback(self)
425
 
                self.message = message
426
 
 
427
 
                # Add revision data to the local branch
428
 
                self.rev_id = self.builder.commit(self.message)
429
 
 
430
 
            except Exception:
431
 
                mutter("aborting commit write group because of exception:")
432
 
                trace.log_exception_quietly()
433
 
                self.builder.abort()
434
 
                raise
435
 
 
436
 
            self._update_branches(old_revno, old_revid, new_revno)
437
 
 
438
 
            # Make the working tree be up to date with the branch. This
439
 
            # includes automatic changes scheduled to be made to the tree, such
440
 
            # as updating its basis and unversioning paths that were missing.
441
 
            self.work_tree.unversion(self.deleted_paths)
442
 
            self._set_progress_stage("Updating the working tree")
443
 
            self.work_tree.update_basis_by_delta(self.rev_id,
444
 
                                                 self.builder.get_basis_delta())
445
 
            self.reporter.completed(new_revno, self.rev_id)
446
 
            self._process_post_hooks(old_revno, new_revno)
447
 
            return self.rev_id
448
 
 
449
 
    def _update_branches(self, old_revno, old_revid, new_revno):
450
 
        """Update the master and local branch to the new revision.
451
 
 
452
 
        This will try to make sure that the master branch is updated
453
 
        before the local branch.
454
 
 
455
 
        :param old_revno: Revision number of master branch before the
456
 
            commit
457
 
        :param old_revid: Tip of master branch before the commit
458
 
        :param new_revno: Revision number of the new commit
459
 
        """
460
 
        if not self.builder.updates_branch:
461
 
            self._process_pre_hooks(old_revno, new_revno)
462
 
 
463
 
            # Upload revision data to the master.
464
 
            # this will propagate merged revisions too if needed.
465
 
            if self.bound_branch:
466
 
                self._set_progress_stage("Uploading data to master branch")
467
 
                # 'commit' to the master first so a timeout here causes the
468
 
                # local branch to be out of date
469
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
470
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
471
 
                if self._lossy:
472
 
                    self.branch.fetch(self.master_branch, self.rev_id)
473
 
 
474
 
            # and now do the commit locally.
475
 
            if new_revno is None:
476
 
                # Keep existing behaviour around ghosts
477
 
                new_revno = 1
478
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
479
 
        else:
480
 
            try:
481
 
                self._process_pre_hooks(old_revno, new_revno)
482
 
            except BaseException:
483
 
                # The commit builder will already have updated the branch,
484
 
                # revert it.
485
 
                self.branch.set_last_revision_info(old_revno, old_revid)
486
 
                raise
 
269
        operation = OperationWithCleanups(self._commit)
 
270
        self.revprops = revprops or {}
 
271
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
 
272
        self.config = config or self.config
 
273
        return operation.run(
 
274
               message=message,
 
275
               timestamp=timestamp,
 
276
               timezone=timezone,
 
277
               committer=committer,
 
278
               specific_files=specific_files,
 
279
               rev_id=rev_id,
 
280
               allow_pointless=allow_pointless,
 
281
               strict=strict,
 
282
               verbose=verbose,
 
283
               working_tree=working_tree,
 
284
               local=local,
 
285
               reporter=reporter,
 
286
               message_callback=message_callback,
 
287
               recursive=recursive,
 
288
               exclude=exclude,
 
289
               possible_master_transports=possible_master_transports,
 
290
               lossy=lossy)
 
291
 
 
292
    def _commit(self, operation, message, timestamp, timezone, committer,
 
293
            specific_files, rev_id, allow_pointless, strict, verbose,
 
294
            working_tree, local, reporter, message_callback, recursive,
 
295
            exclude, possible_master_transports, lossy):
 
296
        mutter('preparing to commit')
 
297
 
 
298
        if working_tree is None:
 
299
            raise BzrError("working_tree must be passed into commit().")
 
300
        else:
 
301
            self.work_tree = working_tree
 
302
            self.branch = self.work_tree.branch
 
303
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
304
                if not self.branch.repository.supports_rich_root():
 
305
                    raise errors.RootNotRich()
 
306
        if message_callback is None:
 
307
            if message is not None:
 
308
                if isinstance(message, str):
 
309
                    message = message.decode(get_user_encoding())
 
310
                message_callback = lambda x: message
 
311
            else:
 
312
                raise BzrError("The message or message_callback keyword"
 
313
                               " parameter is required for commit().")
 
314
 
 
315
        self.bound_branch = None
 
316
        self.any_entries_deleted = False
 
317
        if exclude is not None:
 
318
            self.exclude = sorted(
 
319
                minimum_path_selection(exclude))
 
320
        else:
 
321
            self.exclude = []
 
322
        self.local = local
 
323
        self.master_branch = None
 
324
        self.recursive = recursive
 
325
        self.rev_id = None
 
326
        # self.specific_files is None to indicate no filter, or any iterable to
 
327
        # indicate a filter - [] means no files at all, as per iter_changes.
 
328
        if specific_files is not None:
 
329
            self.specific_files = sorted(
 
330
                minimum_path_selection(specific_files))
 
331
        else:
 
332
            self.specific_files = None
 
333
 
 
334
        self.allow_pointless = allow_pointless
 
335
        self.message_callback = message_callback
 
336
        self.timestamp = timestamp
 
337
        self.timezone = timezone
 
338
        self.committer = committer
 
339
        self.strict = strict
 
340
        self.verbose = verbose
 
341
 
 
342
        self.work_tree.lock_write()
 
343
        operation.add_cleanup(self.work_tree.unlock)
 
344
        self.parents = self.work_tree.get_parent_ids()
 
345
        # We can use record_iter_changes IFF iter_changes is compatible with
 
346
        # the command line parameters, and the repository has fast delta
 
347
        # generation. See bug 347649.
 
348
        self.use_record_iter_changes = (
 
349
            not self.exclude and 
 
350
            not self.branch.repository._format.supports_tree_reference and
 
351
            (self.branch.repository._format.fast_deltas or
 
352
             len(self.parents) < 2))
 
353
        self.pb = ui.ui_factory.nested_progress_bar()
 
354
        operation.add_cleanup(self.pb.finished)
 
355
        self.basis_revid = self.work_tree.last_revision()
 
356
        self.basis_tree = self.work_tree.basis_tree()
 
357
        self.basis_tree.lock_read()
 
358
        operation.add_cleanup(self.basis_tree.unlock)
 
359
        # Cannot commit with conflicts present.
 
360
        if len(self.work_tree.conflicts()) > 0:
 
361
            raise ConflictsInTree
 
362
 
 
363
        # Setup the bound branch variables as needed.
 
364
        self._check_bound_branch(operation, possible_master_transports)
 
365
 
 
366
        # Check that the working tree is up to date
 
367
        old_revno, new_revno = self._check_out_of_date_tree()
 
368
 
 
369
        # Complete configuration setup
 
370
        if reporter is not None:
 
371
            self.reporter = reporter
 
372
        elif self.reporter is None:
 
373
            self.reporter = self._select_reporter()
 
374
        if self.config is None:
 
375
            self.config = self.branch.get_config()
 
376
 
 
377
        self._set_specific_file_ids()
 
378
 
 
379
        # Setup the progress bar. As the number of files that need to be
 
380
        # committed in unknown, progress is reported as stages.
 
381
        # We keep track of entries separately though and include that
 
382
        # information in the progress bar during the relevant stages.
 
383
        self.pb_stage_name = ""
 
384
        self.pb_stage_count = 0
 
385
        self.pb_stage_total = 5
 
386
        if self.bound_branch:
 
387
            # 2 extra stages: "Uploading data to master branch" and "Merging
 
388
            # tags to master branch"
 
389
            self.pb_stage_total += 2
 
390
        self.pb.show_pct = False
 
391
        self.pb.show_spinner = False
 
392
        self.pb.show_eta = False
 
393
        self.pb.show_count = True
 
394
        self.pb.show_bar = True
 
395
 
 
396
        self._gather_parents()
 
397
        # After a merge, a selected file commit is not supported.
 
398
        # See 'bzr help merge' for an explanation as to why.
 
399
        if len(self.parents) > 1 and self.specific_files is not None:
 
400
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
401
        # Excludes are a form of selected file commit.
 
402
        if len(self.parents) > 1 and self.exclude:
 
403
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
404
 
 
405
        # Collect the changes
 
406
        self._set_progress_stage("Collecting changes", counter=True)
 
407
        self._lossy = lossy
 
408
        self.builder = self.branch.get_commit_builder(self.parents,
 
409
            self.config, timestamp, timezone, committer, self.revprops,
 
410
            rev_id, lossy=lossy)
 
411
        if not self.builder.supports_record_entry_contents and self.exclude:
 
412
            self.builder.abort()
 
413
            raise errors.ExcludesUnsupported(self.branch.repository)
 
414
 
 
415
        try:
 
416
            self.builder.will_record_deletes()
 
417
            # find the location being committed to
 
418
            if self.bound_branch:
 
419
                master_location = self.master_branch.base
 
420
            else:
 
421
                master_location = self.branch.base
 
422
 
 
423
            # report the start of the commit
 
424
            self.reporter.started(new_revno, self.rev_id, master_location)
 
425
 
 
426
            self._update_builder_with_changes()
 
427
            self._check_pointless()
 
428
 
 
429
            # TODO: Now the new inventory is known, check for conflicts.
 
430
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
431
            # weave lines, because nothing should be recorded until it is known
 
432
            # that commit will succeed.
 
433
            self._set_progress_stage("Saving data locally")
 
434
            self.builder.finish_inventory()
 
435
 
 
436
            # Prompt the user for a commit message if none provided
 
437
            message = message_callback(self)
 
438
            self.message = message
 
439
 
 
440
            # Add revision data to the local branch
 
441
            self.rev_id = self.builder.commit(self.message)
 
442
 
 
443
        except Exception, e:
 
444
            mutter("aborting commit write group because of exception:")
 
445
            trace.log_exception_quietly()
 
446
            note("aborting commit write group: %r" % (e,))
 
447
            self.builder.abort()
 
448
            raise
 
449
 
 
450
        self._process_pre_hooks(old_revno, new_revno)
 
451
 
 
452
        # Upload revision data to the master.
 
453
        # this will propagate merged revisions too if needed.
 
454
        if self.bound_branch:
 
455
            self._set_progress_stage("Uploading data to master branch")
 
456
            # 'commit' to the master first so a timeout here causes the
 
457
            # local branch to be out of date
 
458
            (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
 
459
                self.branch, new_revno, self.rev_id, lossy=lossy)
 
460
            if lossy:
 
461
                self.branch.fetch(self.master_branch, self.rev_id)
 
462
 
 
463
        # and now do the commit locally.
 
464
        self.branch.set_last_revision_info(new_revno, self.rev_id)
487
465
 
488
466
        # Merge local tags to remote
489
467
        if self.bound_branch:
490
468
            self._set_progress_stage("Merging tags to master branch")
491
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
492
 
                self.master_branch.tags)
 
469
            tag_conflicts = self.branch.tags.merge_to(self.master_branch.tags)
493
470
            if tag_conflicts:
494
471
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
495
 
                note(gettext("Conflicting tags in bound branch:\n{0}".format(
496
 
                    "\n".join(warning_lines))))
 
472
                note("Conflicting tags in bound branch:\n" +
 
473
                    "\n".join(warning_lines))
 
474
 
 
475
        # Make the working tree be up to date with the branch. This
 
476
        # includes automatic changes scheduled to be made to the tree, such
 
477
        # as updating its basis and unversioning paths that were missing.
 
478
        self.work_tree.unversion(self.deleted_ids)
 
479
        self._set_progress_stage("Updating the working tree")
 
480
        self.work_tree.update_basis_by_delta(self.rev_id,
 
481
             self.builder.get_basis_delta())
 
482
        self.reporter.completed(new_revno, self.rev_id)
 
483
        self._process_post_hooks(old_revno, new_revno)
 
484
        return self.rev_id
497
485
 
498
486
    def _select_reporter(self):
499
487
        """Select the CommitReporter to use."""
507
495
        # A merge with no effect on files
508
496
        if len(self.parents) > 1:
509
497
            return
 
498
        # TODO: we could simplify this by using self.builder.basis_delta.
 
499
 
 
500
        # The initial commit adds a root directory, but this in itself is not
 
501
        # a worthwhile commit.
 
502
        if (self.basis_revid == revision.NULL_REVISION and
 
503
            ((self.builder.new_inventory is not None and
 
504
             len(self.builder.new_inventory) == 1) or
 
505
            len(self.builder._basis_delta) == 1)):
 
506
            raise PointlessCommit()
510
507
        if self.builder.any_changes():
511
508
            return
512
509
        raise PointlessCommit()
513
510
 
514
 
    def _check_bound_branch(self, stack, possible_master_transports=None):
 
511
    def _check_bound_branch(self, operation, possible_master_transports=None):
515
512
        """Check to see if the local branch is bound.
516
513
 
517
514
        If it is bound, then most of the commit will actually be
533
530
        # If the master branch is bound, we must fail
534
531
        master_bound_location = self.master_branch.get_bound_location()
535
532
        if master_bound_location:
536
 
            raise errors.CommitToDoubleBoundBranch(
537
 
                self.branch, self.master_branch, master_bound_location)
 
533
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
534
                    self.master_branch, master_bound_location)
538
535
 
539
536
        # TODO: jam 20051230 We could automatically push local
540
537
        #       commits to the remote branch if they would fit.
542
539
        #       to local.
543
540
 
544
541
        # Make sure the local branch is identical to the master
545
 
        master_revid = self.master_branch.last_revision()
546
 
        local_revid = self.branch.last_revision()
547
 
        if local_revid != master_revid:
 
542
        master_info = self.master_branch.last_revision_info()
 
543
        local_info = self.branch.last_revision_info()
 
544
        if local_info != master_info:
548
545
            raise errors.BoundBranchOutOfDate(self.branch,
549
 
                                              self.master_branch)
 
546
                    self.master_branch)
550
547
 
551
548
        # Now things are ready to change the master branch
552
549
        # so grab the lock
553
550
        self.bound_branch = self.branch
554
 
        stack.enter_context(self.master_branch.lock_write())
 
551
        self.master_branch.lock_write()
 
552
        operation.add_cleanup(self.master_branch.unlock)
555
553
 
556
554
    def _check_out_of_date_tree(self):
557
555
        """Check that the working tree is up to date.
558
556
 
559
 
        :return: old_revision_number, old_revision_id, new_revision_number
560
 
            tuple
 
557
        :return: old_revision_number,new_revision_number tuple
561
558
        """
562
559
        try:
563
560
            first_tree_parent = self.work_tree.get_parent_ids()[0]
566
563
            # this is so that we still consider the master branch
567
564
            # - in a checkout scenario the tree may have no
568
565
            # parents but the branch may do.
569
 
            first_tree_parent = breezy.revision.NULL_REVISION
570
 
        if (self.master_branch._format.stores_revno() or
571
 
                self.config_stack.get('calculate_revnos')):
572
 
            try:
573
 
                old_revno, master_last = self.master_branch.last_revision_info()
574
 
            except errors.UnsupportedOperation:
575
 
                master_last = self.master_branch.last_revision()
576
 
                old_revno = self.branch.revision_id_to_revno(master_last)
577
 
        else:
578
 
            master_last = self.master_branch.last_revision()
579
 
            old_revno = None
 
566
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
567
        old_revno, master_last = self.master_branch.last_revision_info()
580
568
        if master_last != first_tree_parent:
581
 
            if master_last != breezy.revision.NULL_REVISION:
 
569
            if master_last != bzrlib.revision.NULL_REVISION:
582
570
                raise errors.OutOfDateTree(self.work_tree)
583
 
        if (old_revno is not None and
584
 
                self.branch.repository.has_revision(first_tree_parent)):
 
571
        if self.branch.repository.has_revision(first_tree_parent):
585
572
            new_revno = old_revno + 1
586
573
        else:
587
574
            # ghost parents never appear in revision history.
588
 
            new_revno = None
589
 
        return old_revno, master_last, new_revno
 
575
            new_revno = 1
 
576
        return old_revno,new_revno
590
577
 
591
578
    def _process_pre_hooks(self, old_revno, new_revno):
592
579
        """Process any registered pre commit hooks."""
598
585
        # Process the post commit hooks, if any
599
586
        self._set_progress_stage("Running post_commit hooks")
600
587
        # old style commit hooks - should be deprecated ? (obsoleted in
601
 
        # 0.15^H^H^H^H 2.5.0)
602
 
        post_commit = self.config_stack.get('post_commit')
603
 
        if post_commit is not None:
604
 
            hooks = post_commit.split(' ')
 
588
        # 0.15)
 
589
        if self.config.post_commit() is not None:
 
590
            hooks = self.config.post_commit().split(' ')
605
591
            # this would be nicer with twisted.python.reflect.namedAny
606
592
            for hook in hooks:
607
593
                result = eval(hook + '(branch, rev_id)',
608
 
                              {'branch': self.branch,
609
 
                               'breezy': breezy,
610
 
                               'rev_id': self.rev_id})
 
594
                              {'branch':self.branch,
 
595
                               'bzrlib':bzrlib,
 
596
                               'rev_id':self.rev_id})
611
597
        # process new style post commit hooks
612
598
        self._process_hooks("post_commit", old_revno, new_revno)
613
599
 
628
614
        if self.parents:
629
615
            old_revid = self.parents[0]
630
616
        else:
631
 
            old_revid = breezy.revision.NULL_REVISION
 
617
            old_revid = bzrlib.revision.NULL_REVISION
632
618
 
633
619
        if hook_name == "pre_commit":
634
620
            future_tree = self.builder.revision_tree()
635
621
            tree_delta = future_tree.changes_from(self.basis_tree,
636
 
                                                  include_root=True)
 
622
                                             include_root=True)
637
623
 
638
624
        for hook in Branch.hooks[hook_name]:
639
625
            # show the running hook in the progress bar. As hooks may
654
640
                     old_revno, old_revid, new_revno, self.rev_id,
655
641
                     tree_delta, future_tree)
656
642
 
 
643
    def _gather_parents(self):
 
644
        """Record the parents of a merge for merge detection."""
 
645
        # TODO: Make sure that this list doesn't contain duplicate
 
646
        # entries and the order is preserved when doing this.
 
647
        if self.use_record_iter_changes:
 
648
            return
 
649
        self.basis_inv = self.basis_tree.inventory
 
650
        self.parent_invs = [self.basis_inv]
 
651
        for revision in self.parents[1:]:
 
652
            if self.branch.repository.has_revision(revision):
 
653
                mutter('commit parent revision {%s}', revision)
 
654
                inventory = self.branch.repository.get_inventory(revision)
 
655
                self.parent_invs.append(inventory)
 
656
            else:
 
657
                mutter('commit parent ghost revision {%s}', revision)
 
658
 
657
659
    def _update_builder_with_changes(self):
658
660
        """Update the commit builder with the data about what has changed.
659
661
        """
 
662
        exclude = self.exclude
660
663
        specific_files = self.specific_files
661
 
        mutter("Selecting files for commit with filter %r", specific_files)
 
664
        mutter("Selecting files for commit with filter %s", specific_files)
662
665
 
663
666
        self._check_strict()
664
 
        iter_changes = self.work_tree.iter_changes(
665
 
            self.basis_tree, specific_files=specific_files)
666
 
        if self.exclude:
667
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
668
 
        iter_changes = self._filter_iter_changes(iter_changes)
669
 
        for path, fs_hash in self.builder.record_iter_changes(
 
667
        if self.use_record_iter_changes:
 
668
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
669
                specific_files=specific_files)
 
670
            iter_changes = self._filter_iter_changes(iter_changes)
 
671
            for file_id, path, fs_hash in self.builder.record_iter_changes(
670
672
                self.work_tree, self.basis_revid, iter_changes):
671
 
            self.work_tree._observed_sha1(path, fs_hash)
 
673
                self.work_tree._observed_sha1(file_id, path, fs_hash)
 
674
        else:
 
675
            # Build the new inventory
 
676
            self._populate_from_inventory()
 
677
            self._record_unselected()
 
678
            self._report_and_accumulate_deletes()
672
679
 
673
680
    def _filter_iter_changes(self, iter_changes):
674
681
        """Process iter_changes.
675
682
 
676
 
        This method reports on the changes in iter_changes to the user, and
 
683
        This method reports on the changes in iter_changes to the user, and 
677
684
        converts 'missing' entries in the iter_changes iterator to 'deleted'
678
685
        entries. 'missing' entries have their
679
686
 
682
689
        """
683
690
        reporter = self.reporter
684
691
        report_changes = reporter.is_verbose()
685
 
        deleted_paths = []
 
692
        deleted_ids = []
686
693
        for change in iter_changes:
687
694
            if report_changes:
688
 
                old_path = change.path[0]
689
 
                new_path = change.path[1]
690
 
                versioned = change.versioned[1]
691
 
            kind = change.kind[1]
692
 
            versioned = change.versioned[1]
 
695
                old_path = change[1][0]
 
696
                new_path = change[1][1]
 
697
                versioned = change[3][1]
 
698
            kind = change[6][1]
 
699
            versioned = change[3][1]
693
700
            if kind is None and versioned:
694
701
                # 'missing' path
695
702
                if report_changes:
696
703
                    reporter.missing(new_path)
697
 
                if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
698
 
                    trace.warning('Ignoring "%s" as symlinks are not '
699
 
                                  'supported on this filesystem.' % (change.path[0],))
700
 
                    continue
701
 
                deleted_paths.append(change.path[1])
 
704
                deleted_ids.append(change[0])
702
705
                # Reset the new path (None) and new versioned flag (False)
703
 
                change = change.discard_new()
704
 
                new_path = change.path[1]
705
 
                versioned = False
 
706
                change = (change[0], (change[1][0], None), change[2],
 
707
                    (change[3][0], False)) + change[4:]
706
708
            elif kind == 'tree-reference':
707
709
                if self.recursive == 'down':
708
 
                    self._commit_nested_tree(change.path[1])
709
 
            if change.versioned[0] or change.versioned[1]:
 
710
                    self._commit_nested_tree(change[0], change[1][1])
 
711
            if change[3][0] or change[3][1]:
710
712
                yield change
711
713
                if report_changes:
712
714
                    if new_path is None:
713
715
                        reporter.deleted(old_path)
714
716
                    elif old_path is None:
715
 
                        reporter.snapshot_change(gettext('added'), new_path)
 
717
                        reporter.snapshot_change('added', new_path)
716
718
                    elif old_path != new_path:
717
 
                        reporter.renamed(gettext('renamed'),
718
 
                                         old_path, new_path)
 
719
                        reporter.renamed('renamed', old_path, new_path)
719
720
                    else:
720
 
                        if (new_path
721
 
                                or self.work_tree.branch.repository._format.rich_root_data):
 
721
                        if (new_path or 
 
722
                            self.work_tree.branch.repository._format.rich_root_data):
722
723
                            # Don't report on changes to '' in non rich root
723
724
                            # repositories.
724
 
                            reporter.snapshot_change(
725
 
                                gettext('modified'), new_path)
 
725
                            reporter.snapshot_change('modified', new_path)
726
726
            self._next_progress_entry()
727
 
        # Unversion files that were found to be deleted
728
 
        self.deleted_paths = deleted_paths
 
727
        # Unversion IDs that were found to be deleted
 
728
        self.deleted_ids = deleted_ids
 
729
 
 
730
    def _record_unselected(self):
 
731
        # If specific files are selected, then all un-selected files must be
 
732
        # recorded in their previous state. For more details, see
 
733
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
734
        if self.specific_files or self.exclude:
 
735
            specific_files = self.specific_files or []
 
736
            for path, old_ie in self.basis_inv.iter_entries():
 
737
                if old_ie.file_id in self.builder.new_inventory:
 
738
                    # already added - skip.
 
739
                    continue
 
740
                if (is_inside_any(specific_files, path)
 
741
                    and not is_inside_any(self.exclude, path)):
 
742
                    # was inside the selected path, and not excluded - if not
 
743
                    # present it has been deleted so skip.
 
744
                    continue
 
745
                # From here down it was either not selected, or was excluded:
 
746
                # We preserve the entry unaltered.
 
747
                ie = old_ie.copy()
 
748
                # Note: specific file commits after a merge are currently
 
749
                # prohibited. This test is for sanity/safety in case it's
 
750
                # required after that changes.
 
751
                if len(self.parents) > 1:
 
752
                    ie.revision = None
 
753
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
754
                    self.basis_tree, None)
 
755
 
 
756
    def _report_and_accumulate_deletes(self):
 
757
        if (isinstance(self.basis_inv, Inventory)
 
758
            and isinstance(self.builder.new_inventory, Inventory)):
 
759
            # the older Inventory classes provide a _byid dict, and building a
 
760
            # set from the keys of this dict is substantially faster than even
 
761
            # getting a set of ids from the inventory
 
762
            #
 
763
            # <lifeless> set(dict) is roughly the same speed as
 
764
            # set(iter(dict)) and both are significantly slower than
 
765
            # set(dict.keys())
 
766
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
767
               set(self.builder.new_inventory._byid.keys())
 
768
        else:
 
769
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
770
        if deleted_ids:
 
771
            self.any_entries_deleted = True
 
772
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
773
                for file_id in deleted_ids]
 
774
            deleted.sort()
 
775
            # XXX: this is not quite directory-order sorting
 
776
            for path, file_id in deleted:
 
777
                self.builder.record_delete(path, file_id)
 
778
                self.reporter.deleted(path)
729
779
 
730
780
    def _check_strict(self):
731
781
        # XXX: when we use iter_changes this would likely be faster if
736
786
            for unknown in self.work_tree.unknowns():
737
787
                raise StrictCommitFailed()
738
788
 
739
 
    def _commit_nested_tree(self, path):
 
789
    def _populate_from_inventory(self):
 
790
        """Populate the CommitBuilder by walking the working tree inventory."""
 
791
        # Build the revision inventory.
 
792
        #
 
793
        # This starts by creating a new empty inventory. Depending on
 
794
        # which files are selected for commit, and what is present in the
 
795
        # current tree, the new inventory is populated. inventory entries
 
796
        # which are candidates for modification have their revision set to
 
797
        # None; inventory entries that are carried over untouched have their
 
798
        # revision set to their prior value.
 
799
        #
 
800
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
801
        # results to create a new inventory at the same time, which results
 
802
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
803
        # ADHB 11-07-2006
 
804
 
 
805
        specific_files = self.specific_files
 
806
        exclude = self.exclude
 
807
        report_changes = self.reporter.is_verbose()
 
808
        deleted_ids = []
 
809
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
810
        # deleted, then we have {'foo':{'bar':{}}}
 
811
        deleted_paths = {}
 
812
        # XXX: Note that entries may have the wrong kind because the entry does
 
813
        # not reflect the status on disk.
 
814
        work_inv = self.work_tree.inventory
 
815
        # NB: entries will include entries within the excluded ids/paths
 
816
        # because iter_entries_by_dir has no 'exclude' facility today.
 
817
        entries = work_inv.iter_entries_by_dir(
 
818
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
819
        for path, existing_ie in entries:
 
820
            file_id = existing_ie.file_id
 
821
            name = existing_ie.name
 
822
            parent_id = existing_ie.parent_id
 
823
            kind = existing_ie.kind
 
824
            # Skip files that have been deleted from the working tree.
 
825
            # The deleted path ids are also recorded so they can be explicitly
 
826
            # unversioned later.
 
827
            if deleted_paths:
 
828
                path_segments = splitpath(path)
 
829
                deleted_dict = deleted_paths
 
830
                for segment in path_segments:
 
831
                    deleted_dict = deleted_dict.get(segment, None)
 
832
                    if not deleted_dict:
 
833
                        # We either took a path not present in the dict
 
834
                        # (deleted_dict was None), or we've reached an empty
 
835
                        # child dir in the dict, so are now a sub-path.
 
836
                        break
 
837
                else:
 
838
                    deleted_dict = None
 
839
                if deleted_dict is not None:
 
840
                    # the path has a deleted parent, do not add it.
 
841
                    continue
 
842
            if exclude and is_inside_any(exclude, path):
 
843
                # Skip excluded paths. Excluded paths are processed by
 
844
                # _update_builder_with_changes.
 
845
                continue
 
846
            content_summary = self.work_tree.path_content_summary(path)
 
847
            kind = content_summary[0]
 
848
            # Note that when a filter of specific files is given, we must only
 
849
            # skip/record deleted files matching that filter.
 
850
            if not specific_files or is_inside_any(specific_files, path):
 
851
                if kind == 'missing':
 
852
                    if not deleted_paths:
 
853
                        # path won't have been split yet.
 
854
                        path_segments = splitpath(path)
 
855
                    deleted_dict = deleted_paths
 
856
                    for segment in path_segments:
 
857
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
858
                    self.reporter.missing(path)
 
859
                    self._next_progress_entry()
 
860
                    deleted_ids.append(file_id)
 
861
                    continue
 
862
            # TODO: have the builder do the nested commit just-in-time IF and
 
863
            # only if needed.
 
864
            if kind == 'tree-reference':
 
865
                # enforce repository nested tree policy.
 
866
                if (not self.work_tree.supports_tree_reference() or
 
867
                    # repository does not support it either.
 
868
                    not self.branch.repository._format.supports_tree_reference):
 
869
                    kind = 'directory'
 
870
                    content_summary = (kind, None, None, None)
 
871
                elif self.recursive == 'down':
 
872
                    nested_revision_id = self._commit_nested_tree(
 
873
                        file_id, path)
 
874
                    content_summary = (kind, None, None, nested_revision_id)
 
875
                else:
 
876
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
877
                    content_summary = (kind, None, None, nested_revision_id)
 
878
 
 
879
            # Record an entry for this item
 
880
            # Note: I don't particularly want to have the existing_ie
 
881
            # parameter but the test suite currently (28-Jun-07) breaks
 
882
            # without it thanks to a unicode normalisation issue. :-(
 
883
            definitely_changed = kind != existing_ie.kind
 
884
            self._record_entry(path, file_id, specific_files, kind, name,
 
885
                parent_id, definitely_changed, existing_ie, report_changes,
 
886
                content_summary)
 
887
 
 
888
        # Unversion IDs that were found to be deleted
 
889
        self.deleted_ids = deleted_ids
 
890
 
 
891
    def _commit_nested_tree(self, file_id, path):
740
892
        "Commit a nested tree."
741
 
        sub_tree = self.work_tree.get_nested_tree(path)
 
893
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
742
894
        # FIXME: be more comprehensive here:
743
895
        # this works when both trees are in --trees repository,
744
896
        # but when both are bound to a different repository,
746
898
        # finally implement the explicit-caches approach design
747
899
        # a while back - RBC 20070306.
748
900
        if sub_tree.branch.repository.has_same_location(
749
 
                self.work_tree.branch.repository):
 
901
            self.work_tree.branch.repository):
750
902
            sub_tree.branch.repository = \
751
903
                self.work_tree.branch.repository
752
904
        try:
753
905
            return sub_tree.commit(message=None, revprops=self.revprops,
754
 
                                   recursive=self.recursive,
755
 
                                   message_callback=self.message_callback,
756
 
                                   timestamp=self.timestamp,
757
 
                                   timezone=self.timezone,
758
 
                                   committer=self.committer,
759
 
                                   allow_pointless=self.allow_pointless,
760
 
                                   strict=self.strict, verbose=self.verbose,
761
 
                                   local=self.local, reporter=self.reporter)
762
 
        except PointlessCommit:
763
 
            return self.work_tree.get_reference_revision(path)
 
906
                recursive=self.recursive,
 
907
                message_callback=self.message_callback,
 
908
                timestamp=self.timestamp, timezone=self.timezone,
 
909
                committer=self.committer,
 
910
                allow_pointless=self.allow_pointless,
 
911
                strict=self.strict, verbose=self.verbose,
 
912
                local=self.local, reporter=self.reporter)
 
913
        except errors.PointlessCommit:
 
914
            return self.work_tree.get_reference_revision(file_id)
 
915
 
 
916
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
917
        parent_id, definitely_changed, existing_ie, report_changes,
 
918
        content_summary):
 
919
        "Record the new inventory entry for a path if any."
 
920
        # mutter('check %s {%s}', path, file_id)
 
921
        # mutter('%s selected for commit', path)
 
922
        if definitely_changed or existing_ie is None:
 
923
            ie = make_entry(kind, name, parent_id, file_id)
 
924
        else:
 
925
            ie = existing_ie.copy()
 
926
            ie.revision = None
 
927
        # For carried over entries we don't care about the fs hash - the repo
 
928
        # isn't generating a sha, so we're not saving computation time.
 
929
        _, _, fs_hash = self.builder.record_entry_contents(
 
930
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
931
        if report_changes:
 
932
            self._report_change(ie, path)
 
933
        if fs_hash:
 
934
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
935
        return ie
 
936
 
 
937
    def _report_change(self, ie, path):
 
938
        """Report a change to the user.
 
939
 
 
940
        The change that has occurred is described relative to the basis
 
941
        inventory.
 
942
        """
 
943
        if (self.basis_inv.has_id(ie.file_id)):
 
944
            basis_ie = self.basis_inv[ie.file_id]
 
945
        else:
 
946
            basis_ie = None
 
947
        change = ie.describe_change(basis_ie, ie)
 
948
        if change in (InventoryEntry.RENAMED,
 
949
            InventoryEntry.MODIFIED_AND_RENAMED):
 
950
            old_path = self.basis_inv.id2path(ie.file_id)
 
951
            self.reporter.renamed(change, old_path, path)
 
952
            self._next_progress_entry()
 
953
        else:
 
954
            if change == 'unchanged':
 
955
                return
 
956
            self.reporter.snapshot_change(change, path)
 
957
            self._next_progress_entry()
764
958
 
765
959
    def _set_progress_stage(self, name, counter=False):
766
960
        """Set the progress stage and emit an update to the progress bar."""
779
973
 
780
974
    def _emit_progress(self):
781
975
        if self.pb_entries_count is not None:
782
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
783
 
                                                       self.pb_entries_count)
 
976
            text = "%s [%d] - Stage" % (self.pb_stage_name,
 
977
                self.pb_entries_count)
784
978
        else:
785
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
979
            text = "%s - Stage" % (self.pb_stage_name, )
786
980
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
981
 
 
982
    def _set_specific_file_ids(self):
 
983
        """populate self.specific_file_ids if we will use it."""
 
984
        if not self.use_record_iter_changes:
 
985
            # If provided, ensure the specified files are versioned
 
986
            if self.specific_files is not None:
 
987
                # Note: This routine is being called because it raises
 
988
                # PathNotVersionedError as a side effect of finding the IDs. We
 
989
                # later use the ids we found as input to the working tree
 
990
                # inventory iterator, so we only consider those ids rather than
 
991
                # examining the whole tree again.
 
992
                # XXX: Dont we have filter_unversioned to do this more
 
993
                # cheaply?
 
994
                self.specific_file_ids = tree.find_ids_across_trees(
 
995
                    self.specific_files, [self.basis_tree, self.work_tree])
 
996
            else:
 
997
                self.specific_file_ids = None