/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 breezy/commit.py

  • Committer: Jelmer Vernooij
  • Date: 2020-02-18 01:57:45 UTC
  • mto: This revision was merged to the branch mainline in revision 7493.
  • Revision ID: jelmer@jelmer.uk-20200218015745-q2ss9tsk74h4nh61
drop use of future.

Show diffs side-by-side

added added

removed removed

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