/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: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

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