~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Patch Queue Manager
  • Date: 2015-09-30 16:43:21 UTC
  • mfrom: (6603.2.2 fix-keep-dirty)
  • Revision ID: pqm@pqm.ubuntu.com-20150930164321-ct2v2qnmvimqt8qf
(vila) Avoid associating dirty patch headers with the previous file in the
 patch. (Colin Watson)

Show diffs side-by-side

added added

removed removed

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