~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:16:53 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813141653-3cbrp00xowq58zv1
Added mini tutorial

Show diffs side-by-side

added added

removed removed

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