/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-07-13 06:21:59 UTC
  • mto: (2647.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2648.
  • Revision ID: ian.clatworthy@internode.on.net-20070713062159-kh1kde034wcrkygr
more abentley feedback: use get_nested_tree and include file_id

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