/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

Merge from bzr.dev, resolving conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
# to that of the working tree.  Files that are not in the
 
19
# to that of the working inventory.  Files that are not in the
21
20
# working tree and that were in the predecessor are reported as
22
21
# removed --- this can include files that were either removed from the
23
22
# inventory or deleted in the working tree.  If they were only
26
25
# We then consider the remaining entries, which will be in the new
27
26
# version.  Directory entries are simply copied across.  File entries
28
27
# must be checked to see if a new version of the file should be
29
 
# recorded.  For each parent revision tree, we check to see what
 
28
# recorded.  For each parent revision inventory, we check to see what
30
29
# version of the file was present.  If the file was present in at
31
30
# least one tree, and if it was the same version in all the trees,
32
31
# then we can just refer to that version.  Otherwise, a new version
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 (
54
 
    debug,
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
 
59
from bzrlib import (
55
60
    errors,
56
 
    trace,
 
61
    inventory,
57
62
    tree,
58
 
    ui,
59
63
    )
60
 
from .branch import Branch
61
 
from .cleanup import OperationWithCleanups
62
 
import breezy.config
63
 
from .errors import (BzrError,
64
 
                     ConflictsInTree,
65
 
                     StrictCommitFailed
66
 
                     )
67
 
from .osutils import (get_user_encoding,
68
 
                      is_inside_any,
69
 
                      minimum_path_selection,
70
 
                      splitpath,
71
 
                      )
72
 
from .trace import mutter, note, is_quiet
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
 
        old_path = change[1][0]
101
 
        new_path = change[1][1]
102
 
 
103
 
        new_excluded = (new_path is not None and
104
 
            is_inside_any(exclude, new_path))
105
 
 
106
 
        old_excluded = (old_path is not None and
107
 
            is_inside_any(exclude, old_path))
108
 
 
109
 
        if old_excluded and new_excluded:
110
 
            continue
111
 
 
112
 
        if old_excluded or new_excluded:
113
 
            # TODO(jelmer): Perhaps raise an error here instead?
114
 
            continue
115
 
 
116
 
        yield change
 
64
from bzrlib.branch import Branch
 
65
import bzrlib.config
 
66
from bzrlib.errors import (BzrError, PointlessCommit,
 
67
                           ConflictsInTree,
 
68
                           StrictCommitFailed
 
69
                           )
 
70
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
71
                            is_inside_or_parent_of_any,
 
72
                            quotefn, sha_file, split_lines)
 
73
from bzrlib.testament import Testament
 
74
from bzrlib.trace import mutter, note, warning
 
75
from bzrlib.xml5 import serializer_v5
 
76
from bzrlib.inventory import Inventory, InventoryEntry
 
77
from bzrlib import symbol_versioning
 
78
from bzrlib.symbol_versioning import (deprecated_passed,
 
79
        deprecated_function,
 
80
        DEPRECATED_PARAMETER)
 
81
from bzrlib.workingtree import WorkingTree
 
82
import bzrlib.ui
117
83
 
118
84
 
119
85
class NullCommitReporter(object):
120
86
    """I report on progress of a commit."""
121
87
 
122
 
    def started(self, revno, revid, location):
123
 
        pass
124
 
 
125
88
    def snapshot_change(self, change, path):
126
89
        pass
127
90
 
128
91
    def completed(self, revno, rev_id):
129
92
        pass
130
93
 
131
 
    def deleted(self, path):
 
94
    def deleted(self, file_id):
 
95
        pass
 
96
 
 
97
    def escaped(self, escape_count, message):
132
98
        pass
133
99
 
134
100
    def missing(self, path):
137
103
    def renamed(self, change, old_path, new_path):
138
104
        pass
139
105
 
140
 
    def is_verbose(self):
141
 
        return False
142
 
 
143
106
 
144
107
class ReportCommitToLog(NullCommitReporter):
145
108
 
146
 
    def _note(self, format, *args):
147
 
        """Output a message.
148
 
 
149
 
        Subclasses may choose to override this method.
150
 
        """
151
 
        note(format, *args)
 
109
    # this may be more useful if 'note' was replaced by an overridable
 
110
    # method on self, which would allow more trivial subclassing.
 
111
    # alternative, a callable could be passed in, allowing really trivial
 
112
    # reuse for some uis. RBC 20060511
152
113
 
153
114
    def snapshot_change(self, change, path):
154
 
        if path == '' and change in (gettext('added'), gettext('modified')):
155
 
            return
156
 
        self._note("%s %s", change, path)
157
 
 
158
 
    def started(self, revno, rev_id, location):
159
 
        self._note(
160
 
            gettext('Committing to: %s'),
161
 
            unescape_for_display(location, 'utf-8'))
 
115
        if change == 'unchanged':
 
116
            return
 
117
        if change == 'added' and path == '':
 
118
            return
 
119
        note("%s %s", change, path)
162
120
 
163
121
    def completed(self, revno, rev_id):
164
 
        self._note(gettext('Committed revision %d.'), revno)
165
 
        # self._note goes to the console too; so while we want to log the
166
 
        # rev_id, we can't trivially only log it. (See bug 526425). Long
167
 
        # term we should rearrange the reporting structure, but for now
168
 
        # we just mutter seperately. We mutter the revid and revno together
169
 
        # so that concurrent bzr invocations won't lead to confusion.
170
 
        mutter('Committed revid %s as revno %d.', rev_id, revno)
 
122
        note('Committed revision %d.', revno)
 
123
    
 
124
    def deleted(self, file_id):
 
125
        note('deleted %s', file_id)
171
126
 
172
 
    def deleted(self, path):
173
 
        self._note(gettext('deleted %s'), path)
 
127
    def escaped(self, escape_count, message):
 
128
        note("replaced %d control characters in message", escape_count)
174
129
 
175
130
    def missing(self, path):
176
 
        self._note(gettext('missing %s'), path)
 
131
        note('missing %s', path)
177
132
 
178
133
    def renamed(self, change, old_path, new_path):
179
 
        self._note('%s %s => %s', change, old_path, new_path)
180
 
 
181
 
    def is_verbose(self):
182
 
        return True
 
134
        note('%s %s => %s', change, old_path, new_path)
183
135
 
184
136
 
185
137
class Commit(object):
196
148
    """
197
149
    def __init__(self,
198
150
                 reporter=None,
199
 
                 config_stack=None):
200
 
        """Create a Commit object.
201
 
 
202
 
        :param reporter: the default reporter to use or None to decide later
203
 
        """
204
 
        self.reporter = reporter
205
 
        self.config_stack = config_stack
206
 
 
207
 
    @staticmethod
208
 
    def update_revprops(revprops, branch, authors=None,
209
 
                        local=False, possible_master_transports=None):
210
 
        if revprops is None:
211
 
            revprops = {}
212
 
        if possible_master_transports is None:
213
 
            possible_master_transports = []
214
 
        if (not u'branch-nick' in revprops and
215
 
                branch.repository._format.supports_storing_branch_nick):
216
 
            revprops[u'branch-nick'] = branch._get_nick(
217
 
                local,
218
 
                possible_master_transports)
219
 
        if authors is not None:
220
 
            if u'author' in revprops or u'authors' in revprops:
221
 
                # XXX: maybe we should just accept one of them?
222
 
                raise AssertionError('author property given twice')
223
 
            if authors:
224
 
                for individual in authors:
225
 
                    if '\n' in individual:
226
 
                        raise AssertionError('\\n is not a valid character '
227
 
                                'in an author identity')
228
 
                revprops[u'authors'] = '\n'.join(authors)
229
 
        return revprops
230
 
 
 
151
                 config=None):
 
152
        if reporter is not None:
 
153
            self.reporter = reporter
 
154
        else:
 
155
            self.reporter = NullCommitReporter()
 
156
        if config is not None:
 
157
            self.config = config
 
158
        else:
 
159
            self.config = None
 
160
        
231
161
    def commit(self,
232
162
               message=None,
233
163
               timestamp=None,
244
174
               reporter=None,
245
175
               config=None,
246
176
               message_callback=None,
247
 
               recursive='down',
248
 
               exclude=None,
249
 
               possible_master_transports=None,
250
 
               lossy=False):
 
177
               recursive='down'):
251
178
        """Commit working copy as a new revision.
252
179
 
253
 
        :param message: the commit message (it or message_callback is required)
254
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
255
 
 
256
 
        :param timestamp: if not None, seconds-since-epoch for a
257
 
            postdated/predated commit.
258
 
 
259
 
        :param specific_files: If not None, commit only those files. An empty
260
 
            list means 'commit no files'.
261
 
 
262
 
        :param rev_id: If set, use this as the new revision id.
 
180
        message -- the commit message (it or message_callback is required)
 
181
 
 
182
        timestamp -- if not None, seconds-since-epoch for a
 
183
             postdated/predated commit.
 
184
 
 
185
        specific_files -- If true, commit only those files.
 
186
 
 
187
        rev_id -- If set, use this as the new revision id.
263
188
            Useful for test or import commands that need to tightly
264
189
            control what revisions are assigned.  If you duplicate
265
190
            a revision id that exists elsewhere it is your own fault.
266
191
            If null (default), a time/random revision id is generated.
267
192
 
268
 
        :param allow_pointless: If true (default), commit even if nothing
 
193
        allow_pointless -- If true (default), commit even if nothing
269
194
            has changed and no merges are recorded.
270
195
 
271
 
        :param strict: If true, don't allow a commit if the working tree
 
196
        strict -- If true, don't allow a commit if the working tree
272
197
            contains unknown files.
273
198
 
274
 
        :param revprops: Properties for new revision
 
199
        revprops -- Properties for new revision
275
200
        :param local: Perform a local only commit.
276
 
        :param reporter: the reporter to use or None for the default
277
 
        :param verbose: if True and the reporter is not None, report everything
278
201
        :param recursive: If set to 'down', commit in any subtrees that have
279
202
            pending changes of any sort during this commit.
280
 
        :param exclude: None or a list of relative paths to exclude from the
281
 
            commit. Pending changes to excluded files will be ignored by the
282
 
            commit.
283
 
        :param lossy: When committing to a foreign VCS, ignore any
284
 
            data that can not be natively represented.
285
203
        """
286
 
        operation = OperationWithCleanups(self._commit)
287
 
        self.revprops = revprops or {}
288
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
 
        self.config_stack = config or self.config_stack
290
 
        return operation.run(
291
 
               message=message,
292
 
               timestamp=timestamp,
293
 
               timezone=timezone,
294
 
               committer=committer,
295
 
               specific_files=specific_files,
296
 
               rev_id=rev_id,
297
 
               allow_pointless=allow_pointless,
298
 
               strict=strict,
299
 
               verbose=verbose,
300
 
               working_tree=working_tree,
301
 
               local=local,
302
 
               reporter=reporter,
303
 
               message_callback=message_callback,
304
 
               recursive=recursive,
305
 
               exclude=exclude,
306
 
               possible_master_transports=possible_master_transports,
307
 
               lossy=lossy)
308
 
 
309
 
    def _commit(self, operation, message, timestamp, timezone, committer,
310
 
            specific_files, rev_id, allow_pointless, strict, verbose,
311
 
            working_tree, local, reporter, message_callback, recursive,
312
 
            exclude, possible_master_transports, lossy):
313
204
        mutter('preparing to commit')
314
205
 
315
206
        if working_tree is None:
322
213
                    raise errors.RootNotRich()
323
214
        if message_callback is None:
324
215
            if message is not None:
325
 
                if isinstance(message, bytes):
326
 
                    message = message.decode(get_user_encoding())
 
216
                if isinstance(message, str):
 
217
                    message = message.decode(bzrlib.user_encoding)
327
218
                message_callback = lambda x: message
328
219
            else:
329
220
                raise BzrError("The message or message_callback keyword"
330
221
                               " parameter is required for commit().")
331
222
 
332
223
        self.bound_branch = None
333
 
        self.any_entries_deleted = False
334
 
        if exclude is not None:
335
 
            self.exclude = sorted(
336
 
                minimum_path_selection(exclude))
337
 
        else:
338
 
            self.exclude = []
339
224
        self.local = local
340
225
        self.master_branch = None
341
 
        self.recursive = recursive
 
226
        self.master_locked = False
342
227
        self.rev_id = None
343
 
        # self.specific_files is None to indicate no filter, or any iterable to
344
 
        # indicate a filter - [] means no files at all, as per iter_changes.
345
 
        if specific_files is not None:
346
 
            self.specific_files = sorted(
347
 
                minimum_path_selection(specific_files))
348
 
        else:
349
 
            self.specific_files = None
350
 
 
 
228
        self.specific_files = specific_files
351
229
        self.allow_pointless = allow_pointless
 
230
        self.recursive = recursive
 
231
        self.revprops = revprops
352
232
        self.message_callback = message_callback
353
233
        self.timestamp = timestamp
354
234
        self.timezone = timezone
355
235
        self.committer = committer
 
236
        self.specific_files = specific_files
356
237
        self.strict = strict
357
238
        self.verbose = verbose
 
239
        self.local = local
 
240
 
 
241
        if reporter is None and self.reporter is None:
 
242
            self.reporter = NullCommitReporter()
 
243
        elif reporter is not None:
 
244
            self.reporter = reporter
358
245
 
359
246
        self.work_tree.lock_write()
360
 
        operation.add_cleanup(self.work_tree.unlock)
361
 
        self.parents = self.work_tree.get_parent_ids()
362
 
        self.pb = ui.ui_factory.nested_progress_bar()
363
 
        operation.add_cleanup(self.pb.finished)
364
 
        self.basis_revid = self.work_tree.last_revision()
 
247
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
365
248
        self.basis_tree = self.work_tree.basis_tree()
366
249
        self.basis_tree.lock_read()
367
 
        operation.add_cleanup(self.basis_tree.unlock)
368
 
        # Cannot commit with conflicts present.
369
 
        if len(self.work_tree.conflicts()) > 0:
370
 
            raise ConflictsInTree
371
 
 
372
 
        # Setup the bound branch variables as needed.
373
 
        self._check_bound_branch(operation, possible_master_transports)
374
 
 
375
 
        # Check that the working tree is up to date
376
 
        old_revno, old_revid, new_revno = self._check_out_of_date_tree()
377
 
 
378
 
        # Complete configuration setup
379
 
        if reporter is not None:
380
 
            self.reporter = reporter
381
 
        elif self.reporter is None:
382
 
            self.reporter = self._select_reporter()
383
 
        if self.config_stack is None:
384
 
            self.config_stack = self.work_tree.get_config_stack()
385
 
 
386
 
        # Setup the progress bar. As the number of files that need to be
387
 
        # committed in unknown, progress is reported as stages.
388
 
        # We keep track of entries separately though and include that
389
 
        # information in the progress bar during the relevant stages.
390
 
        self.pb_stage_name = ""
391
 
        self.pb_stage_count = 0
392
 
        self.pb_stage_total = 5
393
 
        if self.bound_branch:
394
 
            # 2 extra stages: "Uploading data to master branch" and "Merging
395
 
            # tags to master branch"
396
 
            self.pb_stage_total += 2
397
 
        self.pb.show_pct = False
398
 
        self.pb.show_spinner = False
399
 
        self.pb.show_eta = False
400
 
        self.pb.show_count = True
401
 
        self.pb.show_bar = True
402
 
 
403
 
        # After a merge, a selected file commit is not supported.
404
 
        # See 'bzr help merge' for an explanation as to why.
405
 
        if len(self.parents) > 1 and self.specific_files is not None:
406
 
            raise CannotCommitSelectedFileMerge(self.specific_files)
407
 
        # Excludes are a form of selected file commit.
408
 
        if len(self.parents) > 1 and self.exclude:
409
 
            raise CannotCommitSelectedFileMerge(self.exclude)
410
 
 
411
 
        # Collect the changes
412
 
        self._set_progress_stage("Collecting changes", counter=True)
413
 
        self._lossy = lossy
414
 
        self.builder = self.branch.get_commit_builder(self.parents,
415
 
            self.config_stack, timestamp, timezone, committer, self.revprops,
416
 
            rev_id, lossy=lossy)
417
 
 
418
 
        if self.builder.updates_branch and self.bound_branch:
419
 
            self.builder.abort()
420
 
            raise AssertionError(
421
 
                "bound branches not supported for commit builders "
422
 
                "that update the branch")
423
 
 
424
250
        try:
425
 
            # find the location being committed to
426
 
            if self.bound_branch:
427
 
                master_location = self.master_branch.base
 
251
            # Cannot commit with conflicts present.
 
252
            if len(self.work_tree.conflicts())>0:
 
253
                raise ConflictsInTree
 
254
 
 
255
            # setup the bound branch variables as needed.
 
256
            self._check_bound_branch()
 
257
 
 
258
            # check for out of date working trees
 
259
            try:
 
260
                first_tree_parent = self.work_tree.get_parent_ids()[0]
 
261
            except IndexError:
 
262
                # if there are no parents, treat our parent as 'None'
 
263
                # this is so that we still consier the master branch
 
264
                # - in a checkout scenario the tree may have no
 
265
                # parents but the branch may do.
 
266
                first_tree_parent = bzrlib.revision.NULL_REVISION
 
267
            old_revno, master_last = self.master_branch.last_revision_info()
 
268
            if master_last != first_tree_parent:
 
269
                if master_last != bzrlib.revision.NULL_REVISION:
 
270
                    raise errors.OutOfDateTree(self.work_tree)
 
271
            if self.branch.repository.has_revision(first_tree_parent):
 
272
                new_revno = old_revno + 1
428
273
            else:
429
 
                master_location = self.branch.base
430
 
 
431
 
            # report the start of the commit
432
 
            self.reporter.started(new_revno, self.rev_id, master_location)
433
 
 
434
 
            self._update_builder_with_changes()
 
274
                # ghost parents never appear in revision history.
 
275
                new_revno = 1
 
276
            if strict:
 
277
                # raise an exception as soon as we find a single unknown.
 
278
                for unknown in self.work_tree.unknowns():
 
279
                    raise StrictCommitFailed()
 
280
                   
 
281
            if self.config is None:
 
282
                self.config = self.branch.get_config()
 
283
 
 
284
            self.work_inv = self.work_tree.inventory
 
285
            self.basis_inv = self.basis_tree.inventory
 
286
            if specific_files is not None:
 
287
                # Ensure specified files are versioned
 
288
                # (We don't actually need the ids here)
 
289
                # XXX: Dont we have filter_unversioned to do this more
 
290
                # cheaply?
 
291
                tree.find_ids_across_trees(specific_files,
 
292
                                           [self.basis_tree, self.work_tree])
 
293
            # one to finish, one for rev and inventory, and one for each
 
294
            # inventory entry, and the same for the new inventory.
 
295
            # note that this estimate is too long when we do a partial tree
 
296
            # commit which excludes some new files from being considered.
 
297
            # The estimate is corrected when we populate the new inv.
 
298
            self.pb_total = len(self.work_inv) + 5
 
299
            self.pb_count = 0
 
300
 
 
301
            self._gather_parents()
 
302
            if len(self.parents) > 1 and self.specific_files:
 
303
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
 
304
                        self.specific_files)
 
305
            
 
306
            self.builder = self.branch.get_commit_builder(self.parents,
 
307
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
308
            
 
309
            self._remove_deleted()
 
310
            self._populate_new_inv()
 
311
            self._report_deletes()
 
312
 
435
313
            self._check_pointless()
436
314
 
437
 
            # TODO: Now the new inventory is known, check for conflicts.
 
315
            self._emit_progress_update()
 
316
            # TODO: Now the new inventory is known, check for conflicts and
 
317
            # prompt the user for a commit message.
438
318
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
439
319
            # weave lines, because nothing should be recorded until it is known
440
320
            # that commit will succeed.
441
 
            self._set_progress_stage("Saving data locally")
442
321
            self.builder.finish_inventory()
443
 
 
444
 
            # Prompt the user for a commit message if none provided
 
322
            self._emit_progress_update()
445
323
            message = message_callback(self)
 
324
            assert isinstance(message, unicode), type(message)
446
325
            self.message = message
 
326
            self._escape_commit_message()
447
327
 
448
 
            # Add revision data to the local branch
449
328
            self.rev_id = self.builder.commit(self.message)
450
 
 
451
 
        except Exception as e:
452
 
            mutter("aborting commit write group because of exception:")
453
 
            trace.log_exception_quietly()
454
 
            self.builder.abort()
455
 
            raise
456
 
 
457
 
        self._update_branches(old_revno, old_revid, new_revno)
458
 
 
459
 
        # Make the working tree be up to date with the branch. This
460
 
        # includes automatic changes scheduled to be made to the tree, such
461
 
        # as updating its basis and unversioning paths that were missing.
462
 
        self.work_tree.unversion(self.deleted_paths)
463
 
        self._set_progress_stage("Updating the working tree")
464
 
        self.work_tree.update_basis_by_delta(self.rev_id,
465
 
             self.builder.get_basis_delta())
466
 
        self.reporter.completed(new_revno, self.rev_id)
467
 
        self._process_post_hooks(old_revno, new_revno)
468
 
        return self.rev_id
469
 
 
470
 
    def _update_branches(self, old_revno, old_revid, new_revno):
471
 
        """Update the master and local branch to the new revision.
472
 
 
473
 
        This will try to make sure that the master branch is updated
474
 
        before the local branch.
475
 
 
476
 
        :param old_revno: Revision number of master branch before the
477
 
            commit
478
 
        :param old_revid: Tip of master branch before the commit
479
 
        :param new_revno: Revision number of the new commit
480
 
        """
481
 
        if not self.builder.updates_branch:
482
 
            self._process_pre_hooks(old_revno, new_revno)
483
 
 
484
 
            # Upload revision data to the master.
 
329
            self._emit_progress_update()
 
330
            # revision data is in the local branch now.
 
331
            
 
332
            # upload revision data to the master.
485
333
            # this will propagate merged revisions too if needed.
486
334
            if self.bound_branch:
487
 
                self._set_progress_stage("Uploading data to master branch")
488
 
                # 'commit' to the master first so a timeout here causes the
489
 
                # local branch to be out of date
490
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
491
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
492
 
                if self._lossy:
493
 
                    self.branch.fetch(self.master_branch, self.rev_id)
 
335
                self.master_branch.repository.fetch(self.branch.repository,
 
336
                                                    revision_id=self.rev_id)
 
337
                # now the master has the revision data
 
338
                # 'commit' to the master first so a timeout here causes the local
 
339
                # branch to be out of date
 
340
                self.master_branch.set_last_revision_info(new_revno,
 
341
                                                          self.rev_id)
494
342
 
495
343
            # and now do the commit locally.
496
344
            self.branch.set_last_revision_info(new_revno, self.rev_id)
497
 
        else:
498
 
            try:
499
 
                self._process_pre_hooks(old_revno, new_revno)
500
 
            except:
501
 
                # The commit builder will already have updated the branch,
502
 
                # revert it.
503
 
                self.branch.set_last_revision_info(old_revno, old_revid)
504
 
                raise
505
 
 
506
 
        # Merge local tags to remote
507
 
        if self.bound_branch:
508
 
            self._set_progress_stage("Merging tags to master branch")
509
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
510
 
                self.master_branch.tags)
511
 
            if tag_conflicts:
512
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
513
 
                note( gettext("Conflicting tags in bound branch:\n{0}".format(
514
 
                    "\n".join(warning_lines))) )
515
 
 
516
 
    def _select_reporter(self):
517
 
        """Select the CommitReporter to use."""
518
 
        if is_quiet():
519
 
            return NullCommitReporter()
520
 
        return ReportCommitToLog()
 
345
 
 
346
            rev_tree = self.builder.revision_tree()
 
347
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
348
            # now the work tree is up to date with the branch
 
349
            
 
350
            self.reporter.completed(new_revno, self.rev_id)
 
351
            # old style commit hooks - should be deprecated ? (obsoleted in
 
352
            # 0.15)
 
353
            if self.config.post_commit() is not None:
 
354
                hooks = self.config.post_commit().split(' ')
 
355
                # this would be nicer with twisted.python.reflect.namedAny
 
356
                for hook in hooks:
 
357
                    result = eval(hook + '(branch, rev_id)',
 
358
                                  {'branch':self.branch,
 
359
                                   'bzrlib':bzrlib,
 
360
                                   'rev_id':self.rev_id})
 
361
            # new style commit hooks:
 
362
            if not self.bound_branch:
 
363
                hook_master = self.branch
 
364
                hook_local = None
 
365
            else:
 
366
                hook_master = self.master_branch
 
367
                hook_local = self.branch
 
368
            # With bound branches, when the master is behind the local branch,
 
369
            # the 'old_revno' and old_revid values here are incorrect.
 
370
            # XXX: FIXME ^. RBC 20060206
 
371
            if self.parents:
 
372
                old_revid = self.parents[0]
 
373
            else:
 
374
                old_revid = bzrlib.revision.NULL_REVISION
 
375
            for hook in Branch.hooks['post_commit']:
 
376
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
377
                    self.rev_id)
 
378
            self._emit_progress_update()
 
379
        finally:
 
380
            self._cleanup()
 
381
        return self.rev_id
 
382
 
 
383
    def _any_real_changes(self):
 
384
        """Are there real changes between new_inventory and basis?
 
385
 
 
386
        For trees without rich roots, inv.root.revision changes every commit.
 
387
        But if that is the only change, we want to treat it as though there
 
388
        are *no* changes.
 
389
        """
 
390
        new_entries = self.builder.new_inventory.iter_entries()
 
391
        basis_entries = self.basis_inv.iter_entries()
 
392
        new_path, new_root_ie = new_entries.next()
 
393
        basis_path, basis_root_ie = basis_entries.next()
 
394
 
 
395
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
396
        def ie_equal_no_revision(this, other):
 
397
            return ((this.file_id == other.file_id)
 
398
                    and (this.name == other.name)
 
399
                    and (this.symlink_target == other.symlink_target)
 
400
                    and (this.text_sha1 == other.text_sha1)
 
401
                    and (this.text_size == other.text_size)
 
402
                    and (this.text_id == other.text_id)
 
403
                    and (this.parent_id == other.parent_id)
 
404
                    and (this.kind == other.kind)
 
405
                    and (this.executable == other.executable)
 
406
                    and (this.reference_revision == other.reference_revision)
 
407
                    )
 
408
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
409
            return True
 
410
 
 
411
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
412
            if new_ie != basis_ie:
 
413
                return True
 
414
 
 
415
        # No actual changes present
 
416
        return False
521
417
 
522
418
    def _check_pointless(self):
523
419
        if self.allow_pointless:
525
421
        # A merge with no effect on files
526
422
        if len(self.parents) > 1:
527
423
            return
528
 
        if self.builder.any_changes():
 
424
        # work around the fact that a newly-initted tree does differ from its
 
425
        # basis
 
426
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
 
427
            raise PointlessCommit()
 
428
        # Shortcut, if the number of entries changes, then we obviously have
 
429
        # a change
 
430
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
431
            return
 
432
        # If length == 1, then we only have the root entry. Which means
 
433
        # that there is no real difference (only the root could be different)
 
434
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
529
435
            return
530
436
        raise PointlessCommit()
531
437
 
532
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
438
    def _check_bound_branch(self):
533
439
        """Check to see if the local branch is bound.
534
440
 
535
441
        If it is bound, then most of the commit will actually be
540
446
            raise errors.LocalRequiresBoundBranch()
541
447
 
542
448
        if not self.local:
543
 
            self.master_branch = self.branch.get_master_branch(
544
 
                possible_master_transports)
 
449
            self.master_branch = self.branch.get_master_branch()
545
450
 
546
451
        if not self.master_branch:
547
452
            # make this branch the reference branch for out of date checks.
558
463
        #       commits to the remote branch if they would fit.
559
464
        #       But for now, just require remote to be identical
560
465
        #       to local.
561
 
 
 
466
        
562
467
        # Make sure the local branch is identical to the master
563
468
        master_info = self.master_branch.last_revision_info()
564
469
        local_info = self.branch.last_revision_info()
570
475
        # so grab the lock
571
476
        self.bound_branch = self.branch
572
477
        self.master_branch.lock_write()
573
 
        operation.add_cleanup(self.master_branch.unlock)
574
 
 
575
 
    def _check_out_of_date_tree(self):
576
 
        """Check that the working tree is up to date.
577
 
 
578
 
        :return: old_revision_number, old_revision_id, new_revision_number
579
 
            tuple
 
478
        self.master_locked = True
 
479
 
 
480
    def _cleanup(self):
 
481
        """Cleanup any open locks, progress bars etc."""
 
482
        cleanups = [self._cleanup_bound_branch,
 
483
                    self.basis_tree.unlock,
 
484
                    self.work_tree.unlock,
 
485
                    self.pb.finished]
 
486
        found_exception = None
 
487
        for cleanup in cleanups:
 
488
            try:
 
489
                cleanup()
 
490
            # we want every cleanup to run no matter what.
 
491
            # so we have a catchall here, but we will raise the
 
492
            # last encountered exception up the stack: and
 
493
            # typically this will be useful enough.
 
494
            except Exception, e:
 
495
                found_exception = e
 
496
        if found_exception is not None: 
 
497
            # don't do a plan raise, because the last exception may have been
 
498
            # trashed, e is our sure-to-work exception even though it loses the
 
499
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
500
            # exc_info and if its the same one do a plain raise otherwise 
 
501
            # 'raise e' as we do now.
 
502
            raise e
 
503
 
 
504
    def _cleanup_bound_branch(self):
 
505
        """Executed at the end of a try/finally to cleanup a bound branch.
 
506
 
 
507
        If the branch wasn't bound, this is a no-op.
 
508
        If it was, it resents self.branch to the local branch, instead
 
509
        of being the master.
580
510
        """
581
 
        try:
582
 
            first_tree_parent = self.work_tree.get_parent_ids()[0]
583
 
        except IndexError:
584
 
            # if there are no parents, treat our parent as 'None'
585
 
            # this is so that we still consider the master branch
586
 
            # - in a checkout scenario the tree may have no
587
 
            # parents but the branch may do.
588
 
            first_tree_parent = breezy.revision.NULL_REVISION
589
 
        old_revno, master_last = self.master_branch.last_revision_info()
590
 
        if master_last != first_tree_parent:
591
 
            if master_last != breezy.revision.NULL_REVISION:
592
 
                raise errors.OutOfDateTree(self.work_tree)
593
 
        if self.branch.repository.has_revision(first_tree_parent):
594
 
            new_revno = old_revno + 1
595
 
        else:
596
 
            # ghost parents never appear in revision history.
597
 
            new_revno = 1
598
 
        return old_revno, master_last, new_revno
599
 
 
600
 
    def _process_pre_hooks(self, old_revno, new_revno):
601
 
        """Process any registered pre commit hooks."""
602
 
        self._set_progress_stage("Running pre_commit hooks")
603
 
        self._process_hooks("pre_commit", old_revno, new_revno)
604
 
 
605
 
    def _process_post_hooks(self, old_revno, new_revno):
606
 
        """Process any registered post commit hooks."""
607
 
        # Process the post commit hooks, if any
608
 
        self._set_progress_stage("Running post_commit hooks")
609
 
        # old style commit hooks - should be deprecated ? (obsoleted in
610
 
        # 0.15^H^H^H^H 2.5.0)
611
 
        post_commit = self.config_stack.get('post_commit')
612
 
        if post_commit is not None:
613
 
            hooks = post_commit.split(' ')
614
 
            # this would be nicer with twisted.python.reflect.namedAny
615
 
            for hook in hooks:
616
 
                result = eval(hook + '(branch, rev_id)',
617
 
                              {'branch':self.branch,
618
 
                               'breezy':breezy,
619
 
                               'rev_id':self.rev_id})
620
 
        # process new style post commit hooks
621
 
        self._process_hooks("post_commit", old_revno, new_revno)
622
 
 
623
 
    def _process_hooks(self, hook_name, old_revno, new_revno):
624
 
        if not Branch.hooks[hook_name]:
625
 
            return
626
 
 
627
 
        # new style commit hooks:
628
511
        if not self.bound_branch:
629
 
            hook_master = self.branch
630
 
            hook_local = None
631
 
        else:
632
 
            hook_master = self.master_branch
633
 
            hook_local = self.branch
634
 
        # With bound branches, when the master is behind the local branch,
635
 
        # the 'old_revno' and old_revid values here are incorrect.
636
 
        # XXX: FIXME ^. RBC 20060206
637
 
        if self.parents:
638
 
            old_revid = self.parents[0]
639
 
        else:
640
 
            old_revid = breezy.revision.NULL_REVISION
641
 
 
642
 
        if hook_name == "pre_commit":
643
 
            future_tree = self.builder.revision_tree()
644
 
            tree_delta = future_tree.changes_from(self.basis_tree,
645
 
                                             include_root=True)
646
 
 
647
 
        for hook in Branch.hooks[hook_name]:
648
 
            # show the running hook in the progress bar. As hooks may
649
 
            # end up doing nothing (e.g. because they are not configured by
650
 
            # the user) this is still showing progress, not showing overall
651
 
            # actions - its up to each plugin to show a UI if it want's to
652
 
            # (such as 'Emailing diff to foo@example.com').
653
 
            self.pb_stage_name = "Running %s hooks [%s]" % \
654
 
                (hook_name, Branch.hooks.get_hook_name(hook))
655
 
            self._emit_progress()
656
 
            if 'hooks' in debug.debug_flags:
657
 
                mutter("Invoking commit hook: %r", hook)
658
 
            if hook_name == "post_commit":
659
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
660
 
                     self.rev_id)
661
 
            elif hook_name == "pre_commit":
662
 
                hook(hook_local, hook_master,
663
 
                     old_revno, old_revid, new_revno, self.rev_id,
664
 
                     tree_delta, future_tree)
665
 
 
666
 
    def _update_builder_with_changes(self):
667
 
        """Update the commit builder with the data about what has changed.
668
 
        """
669
 
        specific_files = self.specific_files
670
 
        mutter("Selecting files for commit with filter %r", specific_files)
671
 
 
672
 
        self._check_strict()
673
 
        iter_changes = self.work_tree.iter_changes(self.basis_tree,
674
 
            specific_files=specific_files)
675
 
        if self.exclude:
676
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
677
 
        iter_changes = self._filter_iter_changes(iter_changes)
678
 
        for file_id, path, fs_hash in self.builder.record_iter_changes(
679
 
            self.work_tree, self.basis_revid, iter_changes):
680
 
            self.work_tree._observed_sha1(file_id, path, fs_hash)
681
 
 
682
 
    def _filter_iter_changes(self, iter_changes):
683
 
        """Process iter_changes.
684
 
 
685
 
        This method reports on the changes in iter_changes to the user, and 
686
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
687
 
        entries. 'missing' entries have their
688
 
 
689
 
        :param iter_changes: An iter_changes to process.
690
 
        :return: A generator of changes.
691
 
        """
692
 
        reporter = self.reporter
693
 
        report_changes = reporter.is_verbose()
694
 
        deleted_paths = []
695
 
        for change in iter_changes:
696
 
            if report_changes:
697
 
                old_path = change[1][0]
698
 
                new_path = change[1][1]
699
 
                versioned = change[3][1]
700
 
            kind = change[6][1]
701
 
            versioned = change[3][1]
702
 
            if kind is None and versioned:
703
 
                # 'missing' path
704
 
                if report_changes:
705
 
                    reporter.missing(new_path)
706
 
                deleted_paths.append(change[1][1])
707
 
                # Reset the new path (None) and new versioned flag (False)
708
 
                change = (change[0], (change[1][0], None), change[2],
709
 
                    (change[3][0], False)) + change[4:]
710
 
                new_path = change[1][1]
711
 
                versioned = False
712
 
            elif kind == 'tree-reference':
713
 
                if self.recursive == 'down':
714
 
                    self._commit_nested_tree(change[0], change[1][1])
715
 
            if change[3][0] or change[3][1]:
716
 
                yield change
717
 
                if report_changes:
718
 
                    if new_path is None:
719
 
                        reporter.deleted(old_path)
720
 
                    elif old_path is None:
721
 
                        reporter.snapshot_change(gettext('added'), new_path)
722
 
                    elif old_path != new_path:
723
 
                        reporter.renamed(gettext('renamed'), old_path, new_path)
724
 
                    else:
725
 
                        if (new_path or 
726
 
                            self.work_tree.branch.repository._format.rich_root_data):
727
 
                            # Don't report on changes to '' in non rich root
728
 
                            # repositories.
729
 
                            reporter.snapshot_change(gettext('modified'), new_path)
730
 
            self._next_progress_entry()
731
 
        # Unversion files that were found to be deleted
732
 
        self.deleted_paths = deleted_paths
733
 
 
734
 
    def _check_strict(self):
735
 
        # XXX: when we use iter_changes this would likely be faster if
736
 
        # iter_changes would check for us (even in the presence of
737
 
        # selected_files).
738
 
        if self.strict:
739
 
            # raise an exception as soon as we find a single unknown.
740
 
            for unknown in self.work_tree.unknowns():
741
 
                raise StrictCommitFailed()
742
 
 
743
 
    def _commit_nested_tree(self, file_id, path):
744
 
        "Commit a nested tree."
745
 
        sub_tree = self.work_tree.get_nested_tree(path, file_id)
746
 
        # FIXME: be more comprehensive here:
747
 
        # this works when both trees are in --trees repository,
748
 
        # but when both are bound to a different repository,
749
 
        # it fails; a better way of approaching this is to
750
 
        # finally implement the explicit-caches approach design
751
 
        # a while back - RBC 20070306.
752
 
        if sub_tree.branch.repository.has_same_location(
753
 
            self.work_tree.branch.repository):
754
 
            sub_tree.branch.repository = \
755
 
                self.work_tree.branch.repository
756
 
        try:
757
 
            return sub_tree.commit(message=None, revprops=self.revprops,
758
 
                recursive=self.recursive,
759
 
                message_callback=self.message_callback,
760
 
                timestamp=self.timestamp, timezone=self.timezone,
761
 
                committer=self.committer,
762
 
                allow_pointless=self.allow_pointless,
763
 
                strict=self.strict, verbose=self.verbose,
764
 
                local=self.local, reporter=self.reporter)
765
 
        except PointlessCommit:
766
 
            return self.work_tree.get_reference_revision(path, file_id)
767
 
 
768
 
    def _set_progress_stage(self, name, counter=False):
769
 
        """Set the progress stage and emit an update to the progress bar."""
770
 
        self.pb_stage_name = name
771
 
        self.pb_stage_count += 1
772
 
        if counter:
773
 
            self.pb_entries_count = 0
774
 
        else:
775
 
            self.pb_entries_count = None
776
 
        self._emit_progress()
777
 
 
778
 
    def _next_progress_entry(self):
779
 
        """Emit an update to the progress bar and increment the entry count."""
780
 
        self.pb_entries_count += 1
781
 
        self._emit_progress()
782
 
 
783
 
    def _emit_progress(self):
784
 
        if self.pb_entries_count is not None:
785
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
786
 
                self.pb_entries_count)
787
 
        else:
788
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
789
 
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
512
            return
 
513
        if self.master_locked:
 
514
            self.master_branch.unlock()
 
515
 
 
516
    def _escape_commit_message(self):
 
517
        """Replace xml-incompatible control characters."""
 
518
        # FIXME: RBC 20060419 this should be done by the revision
 
519
        # serialiser not by commit. Then we can also add an unescaper
 
520
        # in the deserializer and start roundtripping revision messages
 
521
        # precisely. See repository_implementations/test_repository.py
 
522
        
 
523
        # Python strings can include characters that can't be
 
524
        # represented in well-formed XML; escape characters that
 
525
        # aren't listed in the XML specification
 
526
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
527
        self.message, escape_count = re.subn(
 
528
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
529
            lambda match: match.group(0).encode('unicode_escape'),
 
530
            self.message)
 
531
        if escape_count:
 
532
            self.reporter.escaped(escape_count, self.message)
 
533
 
 
534
    def _gather_parents(self):
 
535
        """Record the parents of a merge for merge detection."""
 
536
        # TODO: Make sure that this list doesn't contain duplicate 
 
537
        # entries and the order is preserved when doing this.
 
538
        self.parents = self.work_tree.get_parent_ids()
 
539
        self.parent_invs = [self.basis_inv]
 
540
        for revision in self.parents[1:]:
 
541
            if self.branch.repository.has_revision(revision):
 
542
                mutter('commit parent revision {%s}', revision)
 
543
                inventory = self.branch.repository.get_inventory(revision)
 
544
                self.parent_invs.append(inventory)
 
545
            else:
 
546
                mutter('commit parent ghost revision {%s}', revision)
 
547
 
 
548
    def _remove_deleted(self):
 
549
        """Remove deleted files from the working inventories.
 
550
 
 
551
        This is done prior to taking the working inventory as the
 
552
        basis for the new committed inventory.
 
553
 
 
554
        This returns true if any files
 
555
        *that existed in the basis inventory* were deleted.
 
556
        Files that were added and deleted
 
557
        in the working copy don't matter.
 
558
        """
 
559
        specific = self.specific_files
 
560
        deleted_ids = []
 
561
        deleted_paths = set()
 
562
        for path, ie in self.work_inv.iter_entries():
 
563
            if is_inside_any(deleted_paths, path):
 
564
                # The tree will delete the required ids recursively.
 
565
                continue
 
566
            if specific and not is_inside_any(specific, path):
 
567
                continue
 
568
            if not self.work_tree.has_filename(path):
 
569
                deleted_paths.add(path)
 
570
                self.reporter.missing(path)
 
571
                deleted_ids.append(ie.file_id)
 
572
        self.work_tree.unversion(deleted_ids)
 
573
 
 
574
    def _populate_new_inv(self):
 
575
        """Build revision inventory.
 
576
 
 
577
        This creates a new empty inventory. Depending on
 
578
        which files are selected for commit, and what is present in the
 
579
        current tree, the new inventory is populated. inventory entries 
 
580
        which are candidates for modification have their revision set to
 
581
        None; inventory entries that are carried over untouched have their
 
582
        revision set to their prior value.
 
583
        """
 
584
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
585
        # results to create a new inventory at the same time, which results
 
586
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
587
        # ADHB 11-07-2006
 
588
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
589
        assert self.work_inv.root is not None
 
590
        entries = self.work_inv.iter_entries()
 
591
        if not self.builder.record_root_entry:
 
592
            symbol_versioning.warn('CommitBuilders should support recording'
 
593
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
594
                stacklevel=1)
 
595
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
596
            entries.next()
 
597
            self._emit_progress_update()
 
598
        for path, new_ie in entries:
 
599
            self._emit_progress_update()
 
600
            file_id = new_ie.file_id
 
601
            try:
 
602
                kind = self.work_tree.kind(file_id)
 
603
                if kind == 'tree-reference' and self.recursive == 'down':
 
604
                    # nested tree: commit in it
 
605
                    sub_tree = WorkingTree.open(self.work_tree.abspath(path))
 
606
                    # FIXME: be more comprehensive here:
 
607
                    # this works when both trees are in --trees repository,
 
608
                    # but when both are bound to a different repository,
 
609
                    # it fails; a better way of approaching this is to 
 
610
                    # finally implement the explicit-caches approach design
 
611
                    # a while back - RBC 20070306.
 
612
                    if (sub_tree.branch.repository.bzrdir.root_transport.base
 
613
                        ==
 
614
                        self.work_tree.branch.repository.bzrdir.root_transport.base):
 
615
                        sub_tree.branch.repository = \
 
616
                            self.work_tree.branch.repository
 
617
                    try:
 
618
                        sub_tree.commit(message=None, revprops=self.revprops,
 
619
                            recursive=self.recursive,
 
620
                            message_callback=self.message_callback,
 
621
                            timestamp=self.timestamp, timezone=self.timezone,
 
622
                            committer=self.committer,
 
623
                            allow_pointless=self.allow_pointless,
 
624
                            strict=self.strict, verbose=self.verbose,
 
625
                            local=self.local, reporter=self.reporter)
 
626
                    except errors.PointlessCommit:
 
627
                        pass
 
628
                if kind != new_ie.kind:
 
629
                    new_ie = inventory.make_entry(kind, new_ie.name,
 
630
                                                  new_ie.parent_id, file_id)
 
631
            except errors.NoSuchFile:
 
632
                pass
 
633
            # mutter('check %s {%s}', path, file_id)
 
634
            if (not self.specific_files or 
 
635
                is_inside_or_parent_of_any(self.specific_files, path)):
 
636
                    # mutter('%s selected for commit', path)
 
637
                    ie = new_ie.copy()
 
638
                    ie.revision = None
 
639
            else:
 
640
                # mutter('%s not selected for commit', path)
 
641
                if self.basis_inv.has_id(file_id):
 
642
                    ie = self.basis_inv[file_id].copy()
 
643
                else:
 
644
                    # this entry is new and not being committed
 
645
                    continue
 
646
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
647
                path, self.work_tree)
 
648
            # describe the nature of the change that has occurred relative to
 
649
            # the basis inventory.
 
650
            if (self.basis_inv.has_id(ie.file_id)):
 
651
                basis_ie = self.basis_inv[ie.file_id]
 
652
            else:
 
653
                basis_ie = None
 
654
            change = ie.describe_change(basis_ie, ie)
 
655
            if change in (InventoryEntry.RENAMED, 
 
656
                InventoryEntry.MODIFIED_AND_RENAMED):
 
657
                old_path = self.basis_inv.id2path(ie.file_id)
 
658
                self.reporter.renamed(change, old_path, path)
 
659
            else:
 
660
                self.reporter.snapshot_change(change, path)
 
661
 
 
662
        if not self.specific_files:
 
663
            return
 
664
 
 
665
        # ignore removals that don't match filespec
 
666
        for path, new_ie in self.basis_inv.iter_entries():
 
667
            if new_ie.file_id in self.work_inv:
 
668
                continue
 
669
            if is_inside_any(self.specific_files, path):
 
670
                continue
 
671
            ie = new_ie.copy()
 
672
            ie.revision = None
 
673
            self.builder.record_entry_contents(ie, self.parent_invs, path,
 
674
                                               self.basis_tree)
 
675
 
 
676
    def _emit_progress_update(self):
 
677
        """Emit an update to the progress bar."""
 
678
        self.pb.update("Committing", self.pb_count, self.pb_total)
 
679
        self.pb_count += 1
 
680
 
 
681
    def _report_deletes(self):
 
682
        for path, ie in self.basis_inv.iter_entries():
 
683
            if ie.file_id not in self.builder.new_inventory:
 
684
                self.reporter.deleted(path)
 
685
 
 
686