/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Ian Clatworthy
  • Date: 2007-09-18 07:14:35 UTC
  • mto: (2867.1.1 ianc-integration2)
  • mto: This revision was merged to the branch mainline in revision 2869.
  • Revision ID: ian.clatworthy@internode.on.net-20070918071435-cjetogmh16akg4v8
bzrdir.py code clean-ups

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 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
17
 
18
18
# The newly committed revision is going to have a shape corresponding
19
 
# 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
20
20
# working tree and that were in the predecessor are reported as
21
21
# removed --- this can include files that were either removed from the
22
22
# inventory or deleted in the working tree.  If they were only
25
25
# We then consider the remaining entries, which will be in the new
26
26
# version.  Directory entries are simply copied across.  File entries
27
27
# must be checked to see if a new version of the file should be
28
 
# recorded.  For each parent revision tree, we check to see what
 
28
# recorded.  For each parent revision inventory, we check to see what
29
29
# version of the file was present.  If the file was present in at
30
30
# least one tree, and if it was the same version in all the trees,
31
31
# then we can just refer to that version.  Otherwise, a new version
49
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
50
# the rest of the code; add a deprecation of the old name.
51
51
 
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
52
59
from bzrlib import (
53
60
    debug,
54
61
    errors,
55
 
    revision,
56
 
    trace,
 
62
    inventory,
57
63
    tree,
58
64
    )
59
65
from bzrlib.branch import Branch
60
 
from bzrlib.cleanup import OperationWithCleanups
61
66
import bzrlib.config
62
67
from bzrlib.errors import (BzrError, PointlessCommit,
63
68
                           ConflictsInTree,
64
69
                           StrictCommitFailed
65
70
                           )
66
 
from bzrlib.osutils import (get_user_encoding,
67
 
                            is_inside_any,
68
 
                            minimum_path_selection,
69
 
                            splitpath,
70
 
                            )
71
 
from bzrlib.trace import mutter, note, is_quiet
72
 
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
72
                            is_inside_or_parent_of_any,
 
73
                            quotefn, sha_file, split_lines)
 
74
from bzrlib.testament import Testament
 
75
from bzrlib.trace import mutter, note, warning, is_quiet
 
76
from bzrlib.xml5 import serializer_v5
 
77
from bzrlib.inventory import Inventory, InventoryEntry
73
78
from bzrlib import symbol_versioning
 
79
from bzrlib.symbol_versioning import (deprecated_passed,
 
80
        deprecated_function,
 
81
        DEPRECATED_PARAMETER)
 
82
from bzrlib.workingtree import WorkingTree
74
83
from bzrlib.urlutils import unescape_for_display
75
84
import bzrlib.ui
76
85
 
79
88
    """I report on progress of a commit."""
80
89
 
81
90
    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)
86
91
        pass
87
92
 
88
93
    def snapshot_change(self, change, path):
91
96
    def completed(self, revno, rev_id):
92
97
        pass
93
98
 
94
 
    def deleted(self, path):
 
99
    def deleted(self, file_id):
 
100
        pass
 
101
 
 
102
    def escaped(self, escape_count, message):
95
103
        pass
96
104
 
97
105
    def missing(self, path):
114
122
        note(format, *args)
115
123
 
116
124
    def snapshot_change(self, change, path):
117
 
        if path == '' and change in ('added', 'modified'):
 
125
        if change == 'unchanged':
 
126
            return
 
127
        if change == 'added' and path == '':
118
128
            return
119
129
        self._note("%s %s", change, path)
120
130
 
121
131
    def started(self, revno, rev_id, location=None):
122
132
        if location is not None:
123
 
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
133
            location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
124
134
        else:
125
 
            # When started was added, location was only made optional by
126
 
            # accident.  Matt Nordhoff 20071129
127
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
128
 
                                   "to started.", DeprecationWarning,
129
 
                                   stacklevel=2)
130
135
            location = ''
131
 
        self._note('Committing%s', location)
 
136
        self._note('Committing revision %d%s.', revno, location)
132
137
 
133
138
    def completed(self, revno, rev_id):
134
139
        self._note('Committed revision %d.', revno)
135
 
        # self._note goes to the console too; so while we want to log the
136
 
        # rev_id, we can't trivially only log it. (See bug 526425). Long
137
 
        # term we should rearrange the reporting structure, but for now
138
 
        # we just mutter seperately. We mutter the revid and revno together
139
 
        # so that concurrent bzr invocations won't lead to confusion.
140
 
        mutter('Committed revid %s as revno %d.', rev_id, revno)
141
 
 
142
 
    def deleted(self, path):
143
 
        self._note('deleted %s', path)
 
140
 
 
141
    def deleted(self, file_id):
 
142
        self._note('deleted %s', file_id)
 
143
 
 
144
    def escaped(self, escape_count, message):
 
145
        self._note("replaced %d control characters in message", escape_count)
144
146
 
145
147
    def missing(self, path):
146
148
        self._note('missing %s', path)
174
176
        self.reporter = reporter
175
177
        self.config = config
176
178
 
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
213
 
 
214
179
    def commit(self,
215
180
               message=None,
216
181
               timestamp=None,
227
192
               reporter=None,
228
193
               config=None,
229
194
               message_callback=None,
230
 
               recursive='down',
231
 
               exclude=None,
232
 
               possible_master_transports=None):
 
195
               recursive='down'):
233
196
        """Commit working copy as a new revision.
234
197
 
235
198
        :param message: the commit message (it or message_callback is required)
236
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
237
199
 
238
200
        :param timestamp: if not None, seconds-since-epoch for a
239
201
            postdated/predated commit.
240
202
 
241
 
        :param specific_files: If not None, commit only those files. An empty
242
 
            list means 'commit no files'.
 
203
        :param specific_files: If true, commit only those files.
243
204
 
244
205
        :param rev_id: If set, use this as the new revision id.
245
206
            Useful for test or import commands that need to tightly
259
220
        :param verbose: if True and the reporter is not None, report everything
260
221
        :param recursive: If set to 'down', commit in any subtrees that have
261
222
            pending changes of any sort during this commit.
262
 
        :param exclude: None or a list of relative paths to exclude from the
263
 
            commit. Pending changes to excluded files will be ignored by the
264
 
            commit.
265
223
        """
266
 
        operation = OperationWithCleanups(self._commit)
267
 
        self.revprops = revprops or {}
268
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
269
 
        self.config = config or self.config
270
 
        return operation.run(
271
 
               message=message,
272
 
               timestamp=timestamp,
273
 
               timezone=timezone,
274
 
               committer=committer,
275
 
               specific_files=specific_files,
276
 
               rev_id=rev_id,
277
 
               allow_pointless=allow_pointless,
278
 
               strict=strict,
279
 
               verbose=verbose,
280
 
               working_tree=working_tree,
281
 
               local=local,
282
 
               reporter=reporter,
283
 
               message_callback=message_callback,
284
 
               recursive=recursive,
285
 
               exclude=exclude,
286
 
               possible_master_transports=possible_master_transports)
287
 
 
288
 
    def _commit(self, operation, message, timestamp, timezone, committer,
289
 
            specific_files, rev_id, allow_pointless, strict, verbose,
290
 
            working_tree, local, reporter, message_callback, recursive,
291
 
            exclude, possible_master_transports):
292
224
        mutter('preparing to commit')
293
225
 
294
226
        if working_tree is None:
302
234
        if message_callback is None:
303
235
            if message is not None:
304
236
                if isinstance(message, str):
305
 
                    message = message.decode(get_user_encoding())
 
237
                    message = message.decode(bzrlib.user_encoding)
306
238
                message_callback = lambda x: message
307
239
            else:
308
240
                raise BzrError("The message or message_callback keyword"
309
241
                               " parameter is required for commit().")
310
242
 
311
243
        self.bound_branch = None
312
 
        self.any_entries_deleted = False
313
 
        if exclude is not None:
314
 
            self.exclude = sorted(
315
 
                minimum_path_selection(exclude))
316
 
        else:
317
 
            self.exclude = []
318
244
        self.local = local
319
245
        self.master_branch = None
320
 
        self.recursive = recursive
 
246
        self.master_locked = False
321
247
        self.rev_id = None
322
 
        # self.specific_files is None to indicate no filter, or any iterable to
323
 
        # indicate a filter - [] means no files at all, as per iter_changes.
324
 
        if specific_files is not None:
325
 
            self.specific_files = sorted(
326
 
                minimum_path_selection(specific_files))
327
 
        else:
328
 
            self.specific_files = None
329
 
            
 
248
        self.specific_files = specific_files
330
249
        self.allow_pointless = allow_pointless
 
250
        self.recursive = recursive
 
251
        self.revprops = revprops
331
252
        self.message_callback = message_callback
332
253
        self.timestamp = timestamp
333
254
        self.timezone = timezone
336
257
        self.verbose = verbose
337
258
 
338
259
        self.work_tree.lock_write()
339
 
        operation.add_cleanup(self.work_tree.unlock)
340
 
        self.parents = self.work_tree.get_parent_ids()
341
 
        # We can use record_iter_changes IFF iter_changes is compatible with
342
 
        # the command line parameters, and the repository has fast delta
343
 
        # generation. See bug 347649.
344
 
        self.use_record_iter_changes = (
345
 
            not self.exclude and 
346
 
            not self.branch.repository._format.supports_tree_reference and
347
 
            (self.branch.repository._format.fast_deltas or
348
 
             len(self.parents) < 2))
349
260
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
350
 
        operation.add_cleanup(self.pb.finished)
351
 
        self.basis_revid = self.work_tree.last_revision()
352
261
        self.basis_tree = self.work_tree.basis_tree()
353
262
        self.basis_tree.lock_read()
354
 
        operation.add_cleanup(self.basis_tree.unlock)
355
 
        # Cannot commit with conflicts present.
356
 
        if len(self.work_tree.conflicts()) > 0:
357
 
            raise ConflictsInTree
358
 
 
359
 
        # Setup the bound branch variables as needed.
360
 
        self._check_bound_branch(operation, possible_master_transports)
361
 
 
362
 
        # Check that the working tree is up to date
363
 
        old_revno, new_revno = self._check_out_of_date_tree()
364
 
 
365
 
        # Complete configuration setup
366
 
        if reporter is not None:
367
 
            self.reporter = reporter
368
 
        elif self.reporter is None:
369
 
            self.reporter = self._select_reporter()
370
 
        if self.config is None:
371
 
            self.config = self.branch.get_config()
372
 
 
373
 
        self._set_specific_file_ids()
374
 
 
375
 
        # Setup the progress bar. As the number of files that need to be
376
 
        # committed in unknown, progress is reported as stages.
377
 
        # We keep track of entries separately though and include that
378
 
        # information in the progress bar during the relevant stages.
379
 
        self.pb_stage_name = ""
380
 
        self.pb_stage_count = 0
381
 
        self.pb_stage_total = 5
382
 
        if self.bound_branch:
383
 
            self.pb_stage_total += 1
384
 
        self.pb.show_pct = False
385
 
        self.pb.show_spinner = False
386
 
        self.pb.show_eta = False
387
 
        self.pb.show_count = True
388
 
        self.pb.show_bar = True
389
 
 
390
 
        self._gather_parents()
391
 
        # After a merge, a selected file commit is not supported.
392
 
        # See 'bzr help merge' for an explanation as to why.
393
 
        if len(self.parents) > 1 and self.specific_files is not None:
394
 
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
395
 
        # Excludes are a form of selected file commit.
396
 
        if len(self.parents) > 1 and self.exclude:
397
 
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
398
 
 
399
 
        # Collect the changes
400
 
        self._set_progress_stage("Collecting changes", counter=True)
401
 
        self.builder = self.branch.get_commit_builder(self.parents,
402
 
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
403
 
 
404
263
        try:
405
 
            self.builder.will_record_deletes()
406
 
            # find the location being committed to
407
 
            if self.bound_branch:
408
 
                master_location = self.master_branch.base
409
 
            else:
410
 
                master_location = self.branch.base
411
 
 
412
 
            # report the start of the commit
413
 
            self.reporter.started(new_revno, self.rev_id, master_location)
414
 
 
415
 
            self._update_builder_with_changes()
416
 
            self._check_pointless()
417
 
 
418
 
            # TODO: Now the new inventory is known, check for conflicts.
419
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
420
 
            # weave lines, because nothing should be recorded until it is known
421
 
            # that commit will succeed.
422
 
            self._set_progress_stage("Saving data locally")
423
 
            self.builder.finish_inventory()
424
 
 
425
 
            # Prompt the user for a commit message if none provided
426
 
            message = message_callback(self)
427
 
            self.message = message
428
 
 
429
 
            # Add revision data to the local branch
430
 
            self.rev_id = self.builder.commit(self.message)
431
 
 
432
 
        except Exception, e:
433
 
            mutter("aborting commit write group because of exception:")
434
 
            trace.log_exception_quietly()
435
 
            note("aborting commit write group: %r" % (e,))
436
 
            self.builder.abort()
437
 
            raise
438
 
 
439
 
        self._process_pre_hooks(old_revno, new_revno)
440
 
 
441
 
        # Upload revision data to the master.
442
 
        # this will propagate merged revisions too if needed.
443
 
        if self.bound_branch:
444
 
            self._set_progress_stage("Uploading data to master branch")
445
 
            # 'commit' to the master first so a timeout here causes the
446
 
            # local branch to be out of date
447
 
            self.master_branch.import_last_revision_info(
448
 
                self.branch.repository, new_revno, self.rev_id)
449
 
 
450
 
        # and now do the commit locally.
451
 
        self.branch.set_last_revision_info(new_revno, self.rev_id)
452
 
 
453
 
        # Make the working tree be up to date with the branch. This
454
 
        # includes automatic changes scheduled to be made to the tree, such
455
 
        # as updating its basis and unversioning paths that were missing.
456
 
        self.work_tree.unversion(self.deleted_ids)
457
 
        self._set_progress_stage("Updating the working tree")
458
 
        self.work_tree.update_basis_by_delta(self.rev_id,
459
 
             self.builder.get_basis_delta())
460
 
        self.reporter.completed(new_revno, self.rev_id)
461
 
        self._process_post_hooks(old_revno, new_revno)
 
264
            # Cannot commit with conflicts present.
 
265
            if len(self.work_tree.conflicts()) > 0:
 
266
                raise ConflictsInTree
 
267
 
 
268
            # Setup the bound branch variables as needed.
 
269
            self._check_bound_branch()
 
270
 
 
271
            # Check that the working tree is up to date
 
272
            old_revno, new_revno = self._check_out_of_date_tree()
 
273
 
 
274
            # Complete configuration setup
 
275
            if reporter is not None:
 
276
                self.reporter = reporter
 
277
            elif self.reporter is None:
 
278
                self.reporter = self._select_reporter()
 
279
            if self.config is None:
 
280
                self.config = self.branch.get_config()
 
281
 
 
282
            # If provided, ensure the specified files are versioned
 
283
            if specific_files is not None:
 
284
                # Note: We don't actually need the IDs here. This routine
 
285
                # is being called because it raises PathNotVerisonedError
 
286
                # as a side effect of finding the IDs.
 
287
                # XXX: Dont we have filter_unversioned to do this more
 
288
                # cheaply?
 
289
                tree.find_ids_across_trees(specific_files,
 
290
                                           [self.basis_tree, self.work_tree])
 
291
 
 
292
            # Setup the progress bar. As the number of files that need to be
 
293
            # committed in unknown, progress is reported as stages.
 
294
            # We keep track of entries separately though and include that
 
295
            # information in the progress bar during the relevant stages.
 
296
            self.pb_stage_name = ""
 
297
            self.pb_stage_count = 0
 
298
            self.pb_stage_total = 5
 
299
            if self.bound_branch:
 
300
                self.pb_stage_total += 1
 
301
            self.pb.show_pct = False
 
302
            self.pb.show_spinner = False
 
303
            self.pb.show_eta = False
 
304
            self.pb.show_count = True
 
305
            self.pb.show_bar = True
 
306
 
 
307
            # After a merge, a selected file commit is not supported.
 
308
            # See 'bzr help merge' for an explanation as to why.
 
309
            self.basis_inv = self.basis_tree.inventory
 
310
            self._gather_parents()
 
311
            if len(self.parents) > 1 and self.specific_files:
 
312
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
313
 
 
314
            # Collect the changes
 
315
            self._set_progress_stage("Collecting changes",
 
316
                    entries_title="Directory")
 
317
            self.builder = self.branch.get_commit_builder(self.parents,
 
318
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
319
            
 
320
            try:
 
321
                # find the location being committed to
 
322
                if self.bound_branch:
 
323
                    master_location = self.master_branch.base
 
324
                else:
 
325
                    master_location = self.branch.base
 
326
 
 
327
                # report the start of the commit
 
328
                self.reporter.started(new_revno, self.rev_id, master_location)
 
329
 
 
330
                self._update_builder_with_changes()
 
331
                self._check_pointless()
 
332
 
 
333
                # TODO: Now the new inventory is known, check for conflicts.
 
334
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
335
                # weave lines, because nothing should be recorded until it is known
 
336
                # that commit will succeed.
 
337
                self._set_progress_stage("Saving data locally")
 
338
                self.builder.finish_inventory()
 
339
 
 
340
                # Prompt the user for a commit message if none provided
 
341
                message = message_callback(self)
 
342
                assert isinstance(message, unicode), type(message)
 
343
                self.message = message
 
344
                self._escape_commit_message()
 
345
 
 
346
                # Add revision data to the local branch
 
347
                self.rev_id = self.builder.commit(self.message)
 
348
 
 
349
            except:
 
350
                self.builder.abort()
 
351
                raise
 
352
 
 
353
            self._process_pre_hooks(old_revno, new_revno)
 
354
 
 
355
            # Upload revision data to the master.
 
356
            # this will propagate merged revisions too if needed.
 
357
            if self.bound_branch:
 
358
                self._set_progress_stage("Uploading data to master branch")
 
359
                self.master_branch.repository.fetch(self.branch.repository,
 
360
                                                    revision_id=self.rev_id)
 
361
                # now the master has the revision data
 
362
                # 'commit' to the master first so a timeout here causes the
 
363
                # local branch to be out of date
 
364
                self.master_branch.set_last_revision_info(new_revno,
 
365
                                                          self.rev_id)
 
366
 
 
367
            # and now do the commit locally.
 
368
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
369
 
 
370
            # Make the working tree up to date with the branch
 
371
            self._set_progress_stage("Updating the working tree")
 
372
            rev_tree = self.builder.revision_tree()
 
373
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
374
            self.reporter.completed(new_revno, self.rev_id)
 
375
            self._process_post_hooks(old_revno, new_revno)
 
376
        finally:
 
377
            self._cleanup()
462
378
        return self.rev_id
463
379
 
464
380
    def _select_reporter(self):
467
383
            return NullCommitReporter()
468
384
        return ReportCommitToLog()
469
385
 
 
386
    def _any_real_changes(self):
 
387
        """Are there real changes between new_inventory and basis?
 
388
 
 
389
        For trees without rich roots, inv.root.revision changes every commit.
 
390
        But if that is the only change, we want to treat it as though there
 
391
        are *no* changes.
 
392
        """
 
393
        new_entries = self.builder.new_inventory.iter_entries()
 
394
        basis_entries = self.basis_inv.iter_entries()
 
395
        new_path, new_root_ie = new_entries.next()
 
396
        basis_path, basis_root_ie = basis_entries.next()
 
397
 
 
398
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
399
        def ie_equal_no_revision(this, other):
 
400
            return ((this.file_id == other.file_id)
 
401
                    and (this.name == other.name)
 
402
                    and (this.symlink_target == other.symlink_target)
 
403
                    and (this.text_sha1 == other.text_sha1)
 
404
                    and (this.text_size == other.text_size)
 
405
                    and (this.text_id == other.text_id)
 
406
                    and (this.parent_id == other.parent_id)
 
407
                    and (this.kind == other.kind)
 
408
                    and (this.executable == other.executable)
 
409
                    and (this.reference_revision == other.reference_revision)
 
410
                    )
 
411
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
412
            return True
 
413
 
 
414
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
415
            if new_ie != basis_ie:
 
416
                return True
 
417
 
 
418
        # No actual changes present
 
419
        return False
 
420
 
470
421
    def _check_pointless(self):
471
422
        if self.allow_pointless:
472
423
            return
473
424
        # A merge with no effect on files
474
425
        if len(self.parents) > 1:
475
426
            return
476
 
        # TODO: we could simplify this by using self.builder.basis_delta.
477
 
 
478
 
        # The initial commit adds a root directory, but this in itself is not
479
 
        # a worthwhile commit.
480
 
        if (self.basis_revid == revision.NULL_REVISION and
481
 
            ((self.builder.new_inventory is not None and
482
 
             len(self.builder.new_inventory) == 1) or
483
 
            len(self.builder._basis_delta) == 1)):
 
427
        # work around the fact that a newly-initted tree does differ from its
 
428
        # basis
 
429
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
484
430
            raise PointlessCommit()
485
 
        if self.builder.any_changes():
 
431
        # Shortcut, if the number of entries changes, then we obviously have
 
432
        # a change
 
433
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
434
            return
 
435
        # If length == 1, then we only have the root entry. Which means
 
436
        # that there is no real difference (only the root could be different)
 
437
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
486
438
            return
487
439
        raise PointlessCommit()
488
440
 
489
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
441
    def _check_bound_branch(self):
490
442
        """Check to see if the local branch is bound.
491
443
 
492
444
        If it is bound, then most of the commit will actually be
497
449
            raise errors.LocalRequiresBoundBranch()
498
450
 
499
451
        if not self.local:
500
 
            self.master_branch = self.branch.get_master_branch(
501
 
                possible_master_transports)
 
452
            self.master_branch = self.branch.get_master_branch()
502
453
 
503
454
        if not self.master_branch:
504
455
            # make this branch the reference branch for out of date checks.
515
466
        #       commits to the remote branch if they would fit.
516
467
        #       But for now, just require remote to be identical
517
468
        #       to local.
518
 
 
 
469
        
519
470
        # Make sure the local branch is identical to the master
520
471
        master_info = self.master_branch.last_revision_info()
521
472
        local_info = self.branch.last_revision_info()
527
478
        # so grab the lock
528
479
        self.bound_branch = self.branch
529
480
        self.master_branch.lock_write()
530
 
        operation.add_cleanup(self.master_branch.unlock)
 
481
        self.master_locked = True
531
482
 
532
483
    def _check_out_of_date_tree(self):
533
484
        """Check that the working tree is up to date.
578
529
    def _process_hooks(self, hook_name, old_revno, new_revno):
579
530
        if not Branch.hooks[hook_name]:
580
531
            return
581
 
 
 
532
        
582
533
        # new style commit hooks:
583
534
        if not self.bound_branch:
584
535
            hook_master = self.branch
593
544
            old_revid = self.parents[0]
594
545
        else:
595
546
            old_revid = bzrlib.revision.NULL_REVISION
596
 
 
 
547
        
597
548
        if hook_name == "pre_commit":
598
549
            future_tree = self.builder.revision_tree()
599
550
            tree_delta = future_tree.changes_from(self.basis_tree,
600
551
                                             include_root=True)
601
 
 
 
552
        
602
553
        for hook in Branch.hooks[hook_name]:
603
554
            # show the running hook in the progress bar. As hooks may
604
555
            # end up doing nothing (e.g. because they are not configured by
618
569
                     old_revno, old_revid, new_revno, self.rev_id,
619
570
                     tree_delta, future_tree)
620
571
 
 
572
    def _cleanup(self):
 
573
        """Cleanup any open locks, progress bars etc."""
 
574
        cleanups = [self._cleanup_bound_branch,
 
575
                    self.basis_tree.unlock,
 
576
                    self.work_tree.unlock,
 
577
                    self.pb.finished]
 
578
        found_exception = None
 
579
        for cleanup in cleanups:
 
580
            try:
 
581
                cleanup()
 
582
            # we want every cleanup to run no matter what.
 
583
            # so we have a catchall here, but we will raise the
 
584
            # last encountered exception up the stack: and
 
585
            # typically this will be useful enough.
 
586
            except Exception, e:
 
587
                found_exception = e
 
588
        if found_exception is not None: 
 
589
            # don't do a plan raise, because the last exception may have been
 
590
            # trashed, e is our sure-to-work exception even though it loses the
 
591
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
592
            # exc_info and if its the same one do a plain raise otherwise 
 
593
            # 'raise e' as we do now.
 
594
            raise e
 
595
 
 
596
    def _cleanup_bound_branch(self):
 
597
        """Executed at the end of a try/finally to cleanup a bound branch.
 
598
 
 
599
        If the branch wasn't bound, this is a no-op.
 
600
        If it was, it resents self.branch to the local branch, instead
 
601
        of being the master.
 
602
        """
 
603
        if not self.bound_branch:
 
604
            return
 
605
        if self.master_locked:
 
606
            self.master_branch.unlock()
 
607
 
 
608
    def _escape_commit_message(self):
 
609
        """Replace xml-incompatible control characters."""
 
610
        # FIXME: RBC 20060419 this should be done by the revision
 
611
        # serialiser not by commit. Then we can also add an unescaper
 
612
        # in the deserializer and start roundtripping revision messages
 
613
        # precisely. See repository_implementations/test_repository.py
 
614
        
 
615
        # Python strings can include characters that can't be
 
616
        # represented in well-formed XML; escape characters that
 
617
        # aren't listed in the XML specification
 
618
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
619
        self.message, escape_count = re.subn(
 
620
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
621
            lambda match: match.group(0).encode('unicode_escape'),
 
622
            self.message)
 
623
        if escape_count:
 
624
            self.reporter.escaped(escape_count, self.message)
 
625
 
621
626
    def _gather_parents(self):
622
627
        """Record the parents of a merge for merge detection."""
623
 
        # TODO: Make sure that this list doesn't contain duplicate
 
628
        # TODO: Make sure that this list doesn't contain duplicate 
624
629
        # entries and the order is preserved when doing this.
625
 
        if self.use_record_iter_changes:
626
 
            return
627
 
        self.basis_inv = self.basis_tree.inventory
 
630
        self.parents = self.work_tree.get_parent_ids()
628
631
        self.parent_invs = [self.basis_inv]
629
632
        for revision in self.parents[1:]:
630
633
            if self.branch.repository.has_revision(revision):
637
640
    def _update_builder_with_changes(self):
638
641
        """Update the commit builder with the data about what has changed.
639
642
        """
640
 
        exclude = self.exclude
641
 
        specific_files = self.specific_files
642
 
        mutter("Selecting files for commit with filter %s", specific_files)
643
 
 
644
 
        self._check_strict()
645
 
        if self.use_record_iter_changes:
646
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
647
 
                specific_files=specific_files)
648
 
            iter_changes = self._filter_iter_changes(iter_changes)
649
 
            for file_id, path, fs_hash in self.builder.record_iter_changes(
650
 
                self.work_tree, self.basis_revid, iter_changes):
651
 
                self.work_tree._observed_sha1(file_id, path, fs_hash)
652
 
        else:
653
 
            # Build the new inventory
654
 
            self._populate_from_inventory()
655
 
            self._record_unselected()
656
 
            self._report_and_accumulate_deletes()
657
 
 
658
 
    def _filter_iter_changes(self, iter_changes):
659
 
        """Process iter_changes.
660
 
 
661
 
        This method reports on the changes in iter_changes to the user, and 
662
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
663
 
        entries. 'missing' entries have their
664
 
 
665
 
        :param iter_changes: An iter_changes to process.
666
 
        :return: A generator of changes.
667
 
        """
668
 
        reporter = self.reporter
669
 
        report_changes = reporter.is_verbose()
670
 
        deleted_ids = []
671
 
        for change in iter_changes:
672
 
            if report_changes:
673
 
                old_path = change[1][0]
674
 
                new_path = change[1][1]
675
 
                versioned = change[3][1]
676
 
            kind = change[6][1]
677
 
            versioned = change[3][1]
678
 
            if kind is None and versioned:
679
 
                # 'missing' path
680
 
                if report_changes:
681
 
                    reporter.missing(new_path)
682
 
                deleted_ids.append(change[0])
683
 
                # Reset the new path (None) and new versioned flag (False)
684
 
                change = (change[0], (change[1][0], None), change[2],
685
 
                    (change[3][0], False)) + change[4:]
686
 
            elif kind == 'tree-reference':
687
 
                if self.recursive == 'down':
688
 
                    self._commit_nested_tree(change[0], change[1][1])
689
 
            if change[3][0] or change[3][1]:
690
 
                yield change
691
 
                if report_changes:
692
 
                    if new_path is None:
693
 
                        reporter.deleted(old_path)
694
 
                    elif old_path is None:
695
 
                        reporter.snapshot_change('added', new_path)
696
 
                    elif old_path != new_path:
697
 
                        reporter.renamed('renamed', old_path, new_path)
698
 
                    else:
699
 
                        if (new_path or 
700
 
                            self.work_tree.branch.repository._format.rich_root_data):
701
 
                            # Don't report on changes to '' in non rich root
702
 
                            # repositories.
703
 
                            reporter.snapshot_change('modified', new_path)
704
 
            self._next_progress_entry()
705
 
        # Unversion IDs that were found to be deleted
706
 
        self.deleted_ids = deleted_ids
707
 
 
708
 
    def _record_unselected(self):
709
 
        # If specific files are selected, then all un-selected files must be
710
 
        # recorded in their previous state. For more details, see
711
 
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
712
 
        if self.specific_files or self.exclude:
713
 
            specific_files = self.specific_files or []
714
 
            for path, old_ie in self.basis_inv.iter_entries():
715
 
                if old_ie.file_id in self.builder.new_inventory:
716
 
                    # already added - skip.
717
 
                    continue
718
 
                if (is_inside_any(specific_files, path)
719
 
                    and not is_inside_any(self.exclude, path)):
720
 
                    # was inside the selected path, and not excluded - if not
721
 
                    # present it has been deleted so skip.
722
 
                    continue
723
 
                # From here down it was either not selected, or was excluded:
724
 
                # We preserve the entry unaltered.
725
 
                ie = old_ie.copy()
726
 
                # Note: specific file commits after a merge are currently
727
 
                # prohibited. This test is for sanity/safety in case it's
728
 
                # required after that changes.
729
 
                if len(self.parents) > 1:
730
 
                    ie.revision = None
731
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
732
 
                    self.basis_tree, None)
733
 
 
734
 
    def _report_and_accumulate_deletes(self):
735
 
        if (isinstance(self.basis_inv, Inventory)
736
 
            and isinstance(self.builder.new_inventory, Inventory)):
737
 
            # the older Inventory classes provide a _byid dict, and building a
738
 
            # set from the keys of this dict is substantially faster than even
739
 
            # getting a set of ids from the inventory
740
 
            #
741
 
            # <lifeless> set(dict) is roughly the same speed as
742
 
            # set(iter(dict)) and both are significantly slower than
743
 
            # set(dict.keys())
744
 
            deleted_ids = set(self.basis_inv._byid.keys()) - \
745
 
               set(self.builder.new_inventory._byid.keys())
746
 
        else:
747
 
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
748
 
        if deleted_ids:
749
 
            self.any_entries_deleted = True
750
 
            deleted = [(self.basis_tree.id2path(file_id), file_id)
751
 
                for file_id in deleted_ids]
752
 
            deleted.sort()
753
 
            # XXX: this is not quite directory-order sorting
754
 
            for path, file_id in deleted:
755
 
                self.builder.record_delete(path, file_id)
756
 
                self.reporter.deleted(path)
757
 
 
758
 
    def _check_strict(self):
759
 
        # XXX: when we use iter_changes this would likely be faster if
760
 
        # iter_changes would check for us (even in the presence of
761
 
        # selected_files).
762
 
        if self.strict:
763
 
            # raise an exception as soon as we find a single unknown.
764
 
            for unknown in self.work_tree.unknowns():
765
 
                raise StrictCommitFailed()
766
 
 
767
 
    def _populate_from_inventory(self):
768
 
        """Populate the CommitBuilder by walking the working tree inventory."""
769
643
        # Build the revision inventory.
770
644
        #
771
645
        # This starts by creating a new empty inventory. Depending on
772
646
        # which files are selected for commit, and what is present in the
773
 
        # current tree, the new inventory is populated. inventory entries
 
647
        # current tree, the new inventory is populated. inventory entries 
774
648
        # which are candidates for modification have their revision set to
775
649
        # None; inventory entries that are carried over untouched have their
776
650
        # revision set to their prior value.
781
655
        # ADHB 11-07-2006
782
656
 
783
657
        specific_files = self.specific_files
784
 
        exclude = self.exclude
 
658
        mutter("Selecting files for commit with filter %s", specific_files)
 
659
 
 
660
        # Check and warn about old CommitBuilders
 
661
        if not self.builder.record_root_entry:
 
662
            symbol_versioning.warn('CommitBuilders should support recording'
 
663
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
664
                stacklevel=1)
 
665
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
666
 
 
667
        # Build the new inventory
 
668
        self._populate_from_inventory(specific_files)
 
669
 
 
670
        # If specific files are selected, then all un-selected files must be
 
671
        # recorded in their previous state. For more details, see
 
672
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
673
        if specific_files:
 
674
            for path, new_ie in self.basis_inv.iter_entries():
 
675
                if new_ie.file_id in self.builder.new_inventory:
 
676
                    continue
 
677
                if is_inside_any(specific_files, path):
 
678
                    continue
 
679
                ie = new_ie.copy()
 
680
                ie.revision = None
 
681
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
682
                                                   self.basis_tree)
 
683
 
 
684
        # Report what was deleted.
 
685
        if self.reporter.is_verbose():
 
686
            for path, ie in self.basis_inv.iter_entries():
 
687
                if ie.file_id not in self.builder.new_inventory:
 
688
                    self.reporter.deleted(path)
 
689
 
 
690
    def _populate_from_inventory(self, specific_files):
 
691
        """Populate the CommitBuilder by walking the working tree inventory."""
 
692
        if self.strict:
 
693
            # raise an exception as soon as we find a single unknown.
 
694
            for unknown in self.work_tree.unknowns():
 
695
                raise StrictCommitFailed()
 
696
               
785
697
        report_changes = self.reporter.is_verbose()
786
698
        deleted_ids = []
787
 
        # A tree of paths that have been deleted. E.g. if foo/bar has been
788
 
        # deleted, then we have {'foo':{'bar':{}}}
789
 
        deleted_paths = {}
790
 
        # XXX: Note that entries may have the wrong kind because the entry does
791
 
        # not reflect the status on disk.
 
699
        deleted_paths = set()
792
700
        work_inv = self.work_tree.inventory
793
 
        # NB: entries will include entries within the excluded ids/paths
794
 
        # because iter_entries_by_dir has no 'exclude' facility today.
795
 
        entries = work_inv.iter_entries_by_dir(
796
 
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
701
        assert work_inv.root is not None
 
702
        entries = work_inv.iter_entries_by_dir()
 
703
        if not self.builder.record_root_entry:
 
704
            entries.next()
797
705
        for path, existing_ie in entries:
798
706
            file_id = existing_ie.file_id
799
707
            name = existing_ie.name
800
708
            parent_id = existing_ie.parent_id
801
709
            kind = existing_ie.kind
 
710
            if kind == 'directory':
 
711
                self._next_progress_entry()
 
712
 
802
713
            # Skip files that have been deleted from the working tree.
803
 
            # The deleted path ids are also recorded so they can be explicitly
804
 
            # unversioned later.
805
 
            if deleted_paths:
806
 
                path_segments = splitpath(path)
807
 
                deleted_dict = deleted_paths
808
 
                for segment in path_segments:
809
 
                    deleted_dict = deleted_dict.get(segment, None)
810
 
                    if not deleted_dict:
811
 
                        # We either took a path not present in the dict
812
 
                        # (deleted_dict was None), or we've reached an empty
813
 
                        # child dir in the dict, so are now a sub-path.
814
 
                        break
815
 
                else:
816
 
                    deleted_dict = None
817
 
                if deleted_dict is not None:
818
 
                    # the path has a deleted parent, do not add it.
819
 
                    continue
820
 
            if exclude and is_inside_any(exclude, path):
821
 
                # Skip excluded paths. Excluded paths are processed by
822
 
                # _update_builder_with_changes.
 
714
            # The deleted files/directories are also recorded so they
 
715
            # can be explicitly unversioned later. Note that when a
 
716
            # filter of specific files is given, we must only skip/record
 
717
            # deleted files matching that filter.
 
718
            if is_inside_any(deleted_paths, path):
823
719
                continue
824
 
            content_summary = self.work_tree.path_content_summary(path)
825
 
            kind = content_summary[0]
826
 
            # Note that when a filter of specific files is given, we must only
827
 
            # skip/record deleted files matching that filter.
828
720
            if not specific_files or is_inside_any(specific_files, path):
829
 
                if kind == 'missing':
830
 
                    if not deleted_paths:
831
 
                        # path won't have been split yet.
832
 
                        path_segments = splitpath(path)
833
 
                    deleted_dict = deleted_paths
834
 
                    for segment in path_segments:
835
 
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
721
                if not self.work_tree.has_filename(path):
 
722
                    deleted_paths.add(path)
836
723
                    self.reporter.missing(path)
837
 
                    self._next_progress_entry()
838
724
                    deleted_ids.append(file_id)
839
725
                    continue
840
 
            # TODO: have the builder do the nested commit just-in-time IF and
841
 
            # only if needed.
842
 
            if kind == 'tree-reference':
843
 
                # enforce repository nested tree policy.
844
 
                if (not self.work_tree.supports_tree_reference() or
845
 
                    # repository does not support it either.
846
 
                    not self.branch.repository._format.supports_tree_reference):
847
 
                    kind = 'directory'
848
 
                    content_summary = (kind, None, None, None)
849
 
                elif self.recursive == 'down':
850
 
                    nested_revision_id = self._commit_nested_tree(
851
 
                        file_id, path)
852
 
                    content_summary = (kind, None, None, nested_revision_id)
853
 
                else:
854
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
855
 
                    content_summary = (kind, None, None, nested_revision_id)
 
726
            try:
 
727
                kind = self.work_tree.kind(file_id)
 
728
                # TODO: specific_files filtering before nested tree processing
 
729
                if kind == 'tree-reference' and self.recursive == 'down':
 
730
                    self._commit_nested_tree(file_id, path)
 
731
            except errors.NoSuchFile:
 
732
                pass
856
733
 
857
734
            # Record an entry for this item
858
735
            # Note: I don't particularly want to have the existing_ie
859
736
            # parameter but the test suite currently (28-Jun-07) breaks
860
737
            # without it thanks to a unicode normalisation issue. :-(
861
 
            definitely_changed = kind != existing_ie.kind
 
738
            definitely_changed = kind != existing_ie.kind 
862
739
            self._record_entry(path, file_id, specific_files, kind, name,
863
 
                parent_id, definitely_changed, existing_ie, report_changes,
864
 
                content_summary)
 
740
                parent_id, definitely_changed, existing_ie, report_changes)
865
741
 
866
742
        # Unversion IDs that were found to be deleted
867
 
        self.deleted_ids = deleted_ids
 
743
        self.work_tree.unversion(deleted_ids)
868
744
 
869
745
    def _commit_nested_tree(self, file_id, path):
870
746
        "Commit a nested tree."
872
748
        # FIXME: be more comprehensive here:
873
749
        # this works when both trees are in --trees repository,
874
750
        # but when both are bound to a different repository,
875
 
        # it fails; a better way of approaching this is to
 
751
        # it fails; a better way of approaching this is to 
876
752
        # finally implement the explicit-caches approach design
877
753
        # a while back - RBC 20070306.
878
754
        if sub_tree.branch.repository.has_same_location(
880
756
            sub_tree.branch.repository = \
881
757
                self.work_tree.branch.repository
882
758
        try:
883
 
            return sub_tree.commit(message=None, revprops=self.revprops,
 
759
            sub_tree.commit(message=None, revprops=self.revprops,
884
760
                recursive=self.recursive,
885
761
                message_callback=self.message_callback,
886
762
                timestamp=self.timestamp, timezone=self.timezone,
889
765
                strict=self.strict, verbose=self.verbose,
890
766
                local=self.local, reporter=self.reporter)
891
767
        except errors.PointlessCommit:
892
 
            return self.work_tree.get_reference_revision(file_id)
 
768
            pass
893
769
 
894
770
    def _record_entry(self, path, file_id, specific_files, kind, name,
895
 
        parent_id, definitely_changed, existing_ie, report_changes,
896
 
        content_summary):
 
771
            parent_id, definitely_changed, existing_ie=None,
 
772
            report_changes=True):
897
773
        "Record the new inventory entry for a path if any."
898
774
        # mutter('check %s {%s}', path, file_id)
899
 
        # mutter('%s selected for commit', path)
900
 
        if definitely_changed or existing_ie is None:
901
 
            ie = make_entry(kind, name, parent_id, file_id)
 
775
        if (not specific_files or 
 
776
            is_inside_or_parent_of_any(specific_files, path)):
 
777
                # mutter('%s selected for commit', path)
 
778
                if definitely_changed or existing_ie is None:
 
779
                    ie = inventory.make_entry(kind, name, parent_id, file_id)
 
780
                else:
 
781
                    ie = existing_ie.copy()
 
782
                    ie.revision = None
902
783
        else:
903
 
            ie = existing_ie.copy()
904
 
            ie.revision = None
905
 
        # For carried over entries we don't care about the fs hash - the repo
906
 
        # isn't generating a sha, so we're not saving computation time.
907
 
        _, _, fs_hash = self.builder.record_entry_contents(
908
 
            ie, self.parent_invs, path, self.work_tree, content_summary)
909
 
        if report_changes:
910
 
            self._report_change(ie, path)
911
 
        if fs_hash:
912
 
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
784
            # mutter('%s not selected for commit', path)
 
785
            if self.basis_inv.has_id(file_id):
 
786
                ie = self.basis_inv[file_id].copy()
 
787
            else:
 
788
                # this entry is new and not being committed
 
789
                ie = None
 
790
        if ie is not None:
 
791
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
792
                path, self.work_tree)
 
793
            if report_changes:
 
794
                self._report_change(ie, path)
913
795
        return ie
914
796
 
915
797
    def _report_change(self, ie, path):
923
805
        else:
924
806
            basis_ie = None
925
807
        change = ie.describe_change(basis_ie, ie)
926
 
        if change in (InventoryEntry.RENAMED,
 
808
        if change in (InventoryEntry.RENAMED, 
927
809
            InventoryEntry.MODIFIED_AND_RENAMED):
928
810
            old_path = self.basis_inv.id2path(ie.file_id)
929
811
            self.reporter.renamed(change, old_path, path)
930
 
            self._next_progress_entry()
931
812
        else:
932
 
            if change == 'unchanged':
933
 
                return
934
813
            self.reporter.snapshot_change(change, path)
935
 
            self._next_progress_entry()
936
814
 
937
 
    def _set_progress_stage(self, name, counter=False):
 
815
    def _set_progress_stage(self, name, entries_title=None):
938
816
        """Set the progress stage and emit an update to the progress bar."""
939
817
        self.pb_stage_name = name
940
818
        self.pb_stage_count += 1
941
 
        if counter:
 
819
        self.pb_entries_title = entries_title
 
820
        if entries_title is not None:
942
821
            self.pb_entries_count = 0
943
 
        else:
944
 
            self.pb_entries_count = None
 
822
            self.pb_entries_total = '?'
945
823
        self._emit_progress()
946
824
 
947
825
    def _next_progress_entry(self):
950
828
        self._emit_progress()
951
829
 
952
830
    def _emit_progress(self):
953
 
        if self.pb_entries_count is not None:
954
 
            text = "%s [%d] - Stage" % (self.pb_stage_name,
955
 
                self.pb_entries_count)
 
831
        if self.pb_entries_title:
 
832
            if self.pb_entries_total == '?':
 
833
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
834
                    self.pb_entries_title, self.pb_entries_count)
 
835
            else:
 
836
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
837
                    self.pb_entries_title, self.pb_entries_count,
 
838
                    str(self.pb_entries_total))
956
839
        else:
957
 
            text = "%s - Stage" % (self.pb_stage_name, )
 
840
            text = "%s - Stage" % (self.pb_stage_name)
958
841
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
959
842
 
960
 
    def _set_specific_file_ids(self):
961
 
        """populate self.specific_file_ids if we will use it."""
962
 
        if not self.use_record_iter_changes:
963
 
            # If provided, ensure the specified files are versioned
964
 
            if self.specific_files is not None:
965
 
                # Note: This routine is being called because it raises
966
 
                # PathNotVersionedError as a side effect of finding the IDs. We
967
 
                # later use the ids we found as input to the working tree
968
 
                # inventory iterator, so we only consider those ids rather than
969
 
                # examining the whole tree again.
970
 
                # XXX: Dont we have filter_unversioned to do this more
971
 
                # cheaply?
972
 
                self.specific_file_ids = tree.find_ids_across_trees(
973
 
                    self.specific_files, [self.basis_tree, self.work_tree])
974
 
            else:
975
 
                self.specific_file_ids = None