/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-04-06 06:59:03 UTC
  • mfrom: (5051.5.1 subunit)
  • Revision ID: pqm@pqm.ubuntu.com-20100406065903-y9dxgwmog1pmw7dz
Use subunit when running tests in PQM.

Show diffs side-by-side

added added

removed removed

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