← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

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