~bzr-pqm/bzr/bzr.dev

2374.2.2 by John Arbash Meinel
Fix the small bug that ie.snapshot() didn't think about kind changes.
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
485 by Martin Pool
- move commit code into its own module
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
1248 by Martin Pool
- new weave based cleanup [broken]
7
#
485 by Martin Pool
- move commit code into its own module
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
1248 by Martin Pool
- new weave based cleanup [broken]
12
#
485 by Martin Pool
- move commit code into its own module
13
# You should have received a copy of the GNU General Public License
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
16
17
1248 by Martin Pool
- new weave based cleanup [broken]
18
# 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
# working tree and that were in the predecessor are reported as
21
# removed --- this can include files that were either removed from the
22
# inventory or deleted in the working tree.  If they were only
23
# deleted from disk, they are removed from the working inventory.
24
25
# We then consider the remaining entries, which will be in the new
26
# version.  Directory entries are simply copied across.  File entries
27
# 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
# version of the file was present.  If the file was present in at
30
# least one tree, and if it was the same version in all the trees,
31
# then we can just refer to that version.  Otherwise, a new version
32
# representing the merger of the file versions must be added.
33
34
# TODO: Update hashcache before and after - or does the WorkingTree
35
# look after that?
1245 by Martin Pool
doc
36
1339 by Martin Pool
- doc
37
# TODO: Rather than mashing together the ancestry and storing it back,
38
# perhaps the weave should have single method which does it all in one
39
# go, avoiding a lot of redundant work.
1335 by Martin Pool
doc
40
1341 by Martin Pool
- doc
41
# TODO: Perhaps give a warning if one of the revisions marked as
42
# merged is already in the ancestry, and then don't record it as a
43
# distinct parent.
44
1343 by Martin Pool
- fix up test for merge of trees
45
# TODO: If the file is newly merged but unchanged from the version it
46
# merges from, then it should still be reported as newly added
47
# relative to the basis revision.
48
1910.7.17 by Andrew Bennetts
Various cosmetic changes.
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
# the rest of the code; add a deprecation of the old name.
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
51
1189 by Martin Pool
- BROKEN: partial support for commit into weave
52
import os
1390 by Robert Collins
pair programming worx... merge integration and weave
53
import re
1189 by Martin Pool
- BROKEN: partial support for commit into weave
54
import sys
1188 by Martin Pool
- clean up imports in commit code
55
import time
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
56
57
from cStringIO import StringIO
1188 by Martin Pool
- clean up imports in commit code
58
1551.8.30 by Aaron Bentley
Tweak from review comments
59
from bzrlib import (
2560.1.4 by Robert Collins
Allow -Dhooks to get the hooks invoked during commit logged.
60
    debug,
1551.8.30 by Aaron Bentley
Tweak from review comments
61
    errors,
1959.4.2 by Aaron Bentley
Merge bzr.dev
62
    inventory,
1551.8.30 by Aaron Bentley
Tweak from review comments
63
    tree,
64
    )
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
65
from bzrlib.branch import Branch
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
66
import bzrlib.config
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
67
from bzrlib.errors import (BzrError, PointlessCommit,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
68
                           ConflictsInTree,
69
                           StrictCommitFailed
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
70
                           )
1740.3.10 by Jelmer Vernooij
Fix some minor issues pointed out by j-a-m.
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)
1442.1.62 by Robert Collins
Allow creation of testaments from uncommitted data, and use that to get signatures before committing revisions.
74
from bzrlib.testament import Testament
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
75
from bzrlib.trace import mutter, note, warning
1189 by Martin Pool
- BROKEN: partial support for commit into weave
76
from bzrlib.xml5 import serializer_v5
1731.1.33 by Aaron Bentley
Revert no-special-root changes
77
from bzrlib.inventory import Inventory, InventoryEntry
1910.2.9 by Aaron Bentley
Inroduce assertDeprecated, and use it to test old commitbuilder API
78
from bzrlib import symbol_versioning
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
79
from bzrlib.symbol_versioning import (deprecated_passed,
1773.4.3 by Martin Pool
[merge] bzr.dev
80
        deprecated_function,
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
81
        DEPRECATED_PARAMETER)
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
82
from bzrlib.workingtree import WorkingTree
2094.3.5 by John Arbash Meinel
Fix imports to ensure modules are loaded before they are used
83
import bzrlib.ui
1189 by Martin Pool
- BROKEN: partial support for commit into weave
84
85
86
class NullCommitReporter(object):
87
    """I report on progress of a commit."""
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
88
89
    def snapshot_change(self, change, path):
90
        pass
91
92
    def completed(self, revno, rev_id):
93
        pass
94
95
    def deleted(self, file_id):
96
        pass
97
98
    def escaped(self, escape_count, message):
99
        pass
100
101
    def missing(self, path):
102
        pass
1189 by Martin Pool
- BROKEN: partial support for commit into weave
103
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
104
    def renamed(self, change, old_path, new_path):
105
        pass
106
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
107
1189 by Martin Pool
- BROKEN: partial support for commit into weave
108
class ReportCommitToLog(NullCommitReporter):
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
109
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
110
    def _note(self, format, *args):
111
        """Output a message.
112
2522.2.3 by Ian Clatworthy
Revert logging just to stderr in commit as broke unicode filenames (#120930)
113
        Subclasses may choose to override this method.
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
114
        """
2522.2.3 by Ian Clatworthy
Revert logging just to stderr in commit as broke unicode filenames (#120930)
115
        note(format, *args)
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
116
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
117
    def snapshot_change(self, change, path):
1616.1.4 by Martin Pool
Verbose commit shouldn't talk about every unchanged file.
118
        if change == 'unchanged':
119
            return
1731.1.45 by Aaron Bentley
Merge bzr.dev
120
        if change == 'added' and path == '':
121
            return
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
122
        self._note("%s %s", change, path)
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
123
124
    def completed(self, revno, rev_id):
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
125
        self._note('Committed revision %d.', revno)
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
126
    
127
    def deleted(self, file_id):
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
128
        self._note('deleted %s', file_id)
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
129
130
    def escaped(self, escape_count, message):
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
131
        self._note("replaced %d control characters in message", escape_count)
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
132
133
    def missing(self, path):
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
134
        self._note('missing %s', path)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
135
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
136
    def renamed(self, change, old_path, new_path):
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
137
        self._note('%s %s => %s', change, old_path, new_path)
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
138
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
139
1189 by Martin Pool
- BROKEN: partial support for commit into weave
140
class Commit(object):
141
    """Task of committing a new revision.
142
143
    This is a MethodObject: it accumulates state as the commit is
144
    prepared, and then it is discarded.  It doesn't represent
145
    historical revisions, just the act of recording a new one.
146
147
            missing_ids
148
            Modified to hold a list of files that have been deleted from
149
            the working directory; these should be removed from the
150
            working inventory.
485 by Martin Pool
- move commit code into its own module
151
    """
1189 by Martin Pool
- BROKEN: partial support for commit into weave
152
    def __init__(self,
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
153
                 reporter=None,
154
                 config=None):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
155
        if reporter is not None:
156
            self.reporter = reporter
157
        else:
158
            self.reporter = NullCommitReporter()
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
159
        self.config = config
1189 by Martin Pool
- BROKEN: partial support for commit into weave
160
        
161
    def commit(self,
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
162
               message=None,
1189 by Martin Pool
- BROKEN: partial support for commit into weave
163
               timestamp=None,
164
               timezone=None,
165
               committer=None,
166
               specific_files=None,
167
               rev_id=None,
1276 by Martin Pool
- make Branch.commit accept (and ignore) verbose argument
168
               allow_pointless=True,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
169
               strict=False,
1185.16.35 by Martin Pool
- stub for revision properties
170
               verbose=False,
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
171
               revprops=None,
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
172
               working_tree=None,
1607.1.5 by Robert Collins
Make commit verbose mode work!.
173
               local=False,
174
               reporter=None,
2149.1.1 by Aaron Bentley
Provide a message_callback parameter to tree.commit
175
               config=None,
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
176
               message_callback=None,
177
               recursive='down'):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
178
        """Commit working copy as a new revision.
179
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
180
        :param message: the commit message (it or message_callback is required)
181
182
        :param timestamp: if not None, seconds-since-epoch for a
183
            postdated/predated commit.
184
185
        :param specific_files: If true, commit only those files.
186
187
        :param rev_id: If set, use this as the new revision id.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
188
            Useful for test or import commands that need to tightly
189
            control what revisions are assigned.  If you duplicate
190
            a revision id that exists elsewhere it is your own fault.
191
            If null (default), a time/random revision id is generated.
1253 by Martin Pool
- test that pointless commits are trapped
192
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
193
        :param allow_pointless: If true (default), commit even if nothing
1253 by Martin Pool
- test that pointless commits are trapped
194
            has changed and no merges are recorded.
1185.16.35 by Martin Pool
- stub for revision properties
195
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
196
        :param strict: If true, don't allow a commit if the working tree
1185.16.65 by mbp at sourcefrog
- new commit --strict option
197
            contains unknown files.
198
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
199
        :param revprops: Properties for new revision
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
200
        :param local: Perform a local only commit.
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
201
        :param recursive: If set to 'down', commit in any subtrees that have
202
            pending changes of any sort during this commit.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
203
        """
1285 by Martin Pool
- fix bug in committing files that are renamed but not modified
204
        mutter('preparing to commit')
1189 by Martin Pool
- BROKEN: partial support for commit into weave
205
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
206
        if working_tree is None:
207
            raise BzrError("working_tree must be passed into commit().")
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
208
        else:
209
            self.work_tree = working_tree
210
            self.branch = self.work_tree.branch
2100.3.14 by Aaron Bentley
Test workingtree4 format, prevent use with old repos
211
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
212
                if not self.branch.repository.supports_rich_root():
213
                    raise errors.RootNotRich()
2149.1.1 by Aaron Bentley
Provide a message_callback parameter to tree.commit
214
        if message_callback is None:
2149.1.3 by Aaron Bentley
Updates from review comments
215
            if message is not None:
216
                if isinstance(message, str):
217
                    message = message.decode(bzrlib.user_encoding)
218
                message_callback = lambda x: message
2149.1.1 by Aaron Bentley
Provide a message_callback parameter to tree.commit
219
            else:
2149.1.3 by Aaron Bentley
Updates from review comments
220
                raise BzrError("The message or message_callback keyword"
221
                               " parameter is required for commit().")
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
222
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
223
        self.bound_branch = None
1587.1.9 by Robert Collins
Local commits do no alter or access the master branch.
224
        self.local = local
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
225
        self.master_branch = None
1614.1.1 by Aaron Bentley
Fixed master locking in commit
226
        self.master_locked = False
1740.3.10 by Jelmer Vernooij
Fix some minor issues pointed out by j-a-m.
227
        self.rev_id = None
1189 by Martin Pool
- BROKEN: partial support for commit into weave
228
        self.specific_files = specific_files
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
229
        self.allow_pointless = allow_pointless
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
230
        self.recursive = recursive
231
        self.revprops = revprops
232
        self.message_callback = message_callback
233
        self.timestamp = timestamp
234
        self.timezone = timezone
235
        self.committer = committer
236
        self.strict = strict
237
        self.verbose = verbose
1189 by Martin Pool
- BROKEN: partial support for commit into weave
238
1607.1.5 by Robert Collins
Make commit verbose mode work!.
239
        if reporter is None and self.reporter is None:
240
            self.reporter = NullCommitReporter()
1607.1.8 by Robert Collins
Integrate latest bzr.dev.
241
        elif reporter is not None:
1607.1.5 by Robert Collins
Make commit verbose mode work!.
242
            self.reporter = reporter
243
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
244
        self.work_tree.lock_write()
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
245
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
2255.2.25 by John Arbash Meinel
DirstateRevisionTrees need to be read_locked before they will work as BasisTree
246
        self.basis_tree = self.work_tree.basis_tree()
247
        self.basis_tree.lock_read()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
248
        try:
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
249
            # Cannot commit with conflicts present.
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
250
            if len(self.work_tree.conflicts()) > 0:
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
251
                raise ConflictsInTree
252
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
253
            # Setup the bound branch variables as needed.
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
254
            self._check_bound_branch()
255
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
256
            # Check that the working tree is up to date
257
            old_revno,new_revno = self._check_out_of_date_tree()
258
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
259
            if strict:
260
                # raise an exception as soon as we find a single unknown.
261
                for unknown in self.work_tree.unknowns():
262
                    raise StrictCommitFailed()
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
263
                   
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
264
            if self.config is None:
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
265
                self.config = self.branch.get_config()
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
266
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
267
            # If provided, ensure the specified files are versioned
1551.8.29 by Aaron Bentley
Stop accepting non-existant files in commit (#50793)
268
            if specific_files is not None:
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
269
                # Note: We don't actually need the IDs here. This routine
270
                # is being called because it raises PathNotVerisonedError
271
                # as a side effect of finding the IDs.
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
272
                # XXX: Dont we have filter_unversioned to do this more
273
                # cheaply?
274
                tree.find_ids_across_trees(specific_files,
1551.8.29 by Aaron Bentley
Stop accepting non-existant files in commit (#50793)
275
                                           [self.basis_tree, self.work_tree])
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
276
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
277
            # Setup the progress bar. As the number of files that need to be
278
            # committed in unknown, progress is reported as stages.
279
            # We keep track of entries separately though and include that
280
            # information in the progress bar during the relevant stages.
281
            self.pb_stage_name = ""
282
            self.pb_stage_count = 0
283
            self.pb_stage_total = 4
284
            if self.bound_branch:
285
                self.pb_stage_total += 1
286
            self.pb.show_pct = False
287
            self.pb.show_spinner = False
288
            self.pb.show_eta = False
289
            self.pb.show_count = True
2589.1.1 by Ian Clatworthy
(Ian Clatworthy) Make the progress bar visible again in commit
290
            self.pb.show_bar = True
1189 by Martin Pool
- BROKEN: partial support for commit into weave
291
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
292
            # After a merge, a selected file commit is not supported.
293
            # See 'bzr help merge' for an explanation as to why.
294
            self.basis_inv = self.basis_tree.inventory
1223 by Martin Pool
- store inventories in weave
295
            self._gather_parents()
1344 by Martin Pool
- disallow selected-file commit of merges
296
            if len(self.parents) > 1 and self.specific_files:
1551.15.9 by Aaron Bentley
Better error for selected-file commit of merges
297
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
1927.2.1 by Robert Collins
Alter set_pending_merges to shove the left most merge into the trees last-revision if that is not set. Related bugfixes include basis_tree handling ghosts, de-duping the merges with the last-revision and update changing where and how it adds its pending merge.
298
            
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
299
            # Collect the changes
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
300
            self._emit_progress_set_stage("Collecting changes", show_entries=True)
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
301
            self.builder = self.branch.get_commit_builder(self.parents,
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
302
                self.config, timestamp, timezone, committer, revprops, rev_id)
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
303
            self._update_builder_with_changes()
1910.2.37 by Aaron Bentley
Handle empty commits, fix test
304
            self._check_pointless()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
305
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
306
            # TODO: Now the new inventory is known, check for conflicts.
1910.2.3 by Aaron Bentley
All tests pass
307
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
308
            # weave lines, because nothing should be recorded until it is known
309
            # that commit will succeed.
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
310
            self._emit_progress_set_stage("Saving data locally")
1740.3.8 by Jelmer Vernooij
Move make_revision() to commit builder.
311
            self.builder.finish_inventory()
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
312
313
            # Prompt the user for a commit message if none provided
2149.1.3 by Aaron Bentley
Updates from review comments
314
            message = message_callback(self)
2149.1.1 by Aaron Bentley
Provide a message_callback parameter to tree.commit
315
            assert isinstance(message, unicode), type(message)
316
            self.message = message
317
            self._escape_commit_message()
318
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
319
            # Add revision data to the local branch
1740.3.9 by Jelmer Vernooij
Make the commit message the first argument of CommitBuilder.commit().
320
            self.rev_id = self.builder.commit(self.message)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
321
            
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
322
            # Upload revision data to the master.
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
323
            # this will propagate merged revisions too if needed.
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
324
            if self.bound_branch:
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
325
                self._emit_progress_set_stage("Uploading data to master branch")
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
326
                self.master_branch.repository.fetch(self.branch.repository,
327
                                                    revision_id=self.rev_id)
328
                # now the master has the revision data
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
329
                # 'commit' to the master first so a timeout here causes the
330
                # local branch to be out of date
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
331
                self.master_branch.set_last_revision_info(new_revno,
332
                                                          self.rev_id)
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
333
334
            # and now do the commit locally.
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
335
            self.branch.set_last_revision_info(new_revno, self.rev_id)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
336
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
337
            # Make the working tree up to date with the branch
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
338
            self._emit_progress_set_stage("Updating the working tree")
2041.1.5 by John Arbash Meinel
CommitBuilder.get_tree => CommitBuilder.revision_tree
339
            rev_tree = self.builder.revision_tree()
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
340
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
341
            self.reporter.completed(new_revno, self.rev_id)
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
342
            self._process_hooks(old_revno, new_revno)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
343
        finally:
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
344
            self._cleanup()
1773.1.1 by Robert Collins
Teach WorkingTree.commit to return the committed revision id.
345
        return self.rev_id
1189 by Martin Pool
- BROKEN: partial support for commit into weave
346
2044.1.1 by Robert Collins
(Robert Collins) Forward merge from 0.11rc2 NEWS and performance-regression fix.
347
    def _any_real_changes(self):
348
        """Are there real changes between new_inventory and basis?
349
350
        For trees without rich roots, inv.root.revision changes every commit.
351
        But if that is the only change, we want to treat it as though there
352
        are *no* changes.
353
        """
354
        new_entries = self.builder.new_inventory.iter_entries()
355
        basis_entries = self.basis_inv.iter_entries()
356
        new_path, new_root_ie = new_entries.next()
357
        basis_path, basis_root_ie = basis_entries.next()
358
359
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
360
        def ie_equal_no_revision(this, other):
361
            return ((this.file_id == other.file_id)
362
                    and (this.name == other.name)
363
                    and (this.symlink_target == other.symlink_target)
364
                    and (this.text_sha1 == other.text_sha1)
365
                    and (this.text_size == other.text_size)
366
                    and (this.text_id == other.text_id)
367
                    and (this.parent_id == other.parent_id)
368
                    and (this.kind == other.kind)
369
                    and (this.executable == other.executable)
2255.2.220 by Robert Collins
Fix failing detection of changes restricted to subtrees causing spurious pointless commit errors.
370
                    and (this.reference_revision == other.reference_revision)
2044.1.1 by Robert Collins
(Robert Collins) Forward merge from 0.11rc2 NEWS and performance-regression fix.
371
                    )
372
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
373
            return True
374
375
        for new_ie, basis_ie in zip(new_entries, basis_entries):
376
            if new_ie != basis_ie:
377
                return True
378
379
        # No actual changes present
380
        return False
381
1910.2.37 by Aaron Bentley
Handle empty commits, fix test
382
    def _check_pointless(self):
383
        if self.allow_pointless:
384
            return
385
        # A merge with no effect on files
386
        if len(self.parents) > 1:
387
            return
388
        # work around the fact that a newly-initted tree does differ from its
389
        # basis
1731.1.49 by Aaron Bentley
Merge bzr.dev
390
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
391
            raise PointlessCommit()
2044.1.1 by Robert Collins
(Robert Collins) Forward merge from 0.11rc2 NEWS and performance-regression fix.
392
        # Shortcut, if the number of entries changes, then we obviously have
393
        # a change
1910.2.37 by Aaron Bentley
Handle empty commits, fix test
394
        if len(self.builder.new_inventory) != len(self.basis_inv):
395
            return
2044.1.1 by Robert Collins
(Robert Collins) Forward merge from 0.11rc2 NEWS and performance-regression fix.
396
        # If length == 1, then we only have the root entry. Which means
397
        # that there is no real difference (only the root could be different)
398
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
1910.2.37 by Aaron Bentley
Handle empty commits, fix test
399
            return
400
        raise PointlessCommit()
401
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
402
    def _check_bound_branch(self):
403
        """Check to see if the local branch is bound.
404
405
        If it is bound, then most of the commit will actually be
406
        done using the remote branch as the target branch.
407
        Only at the end will the local branch be updated.
408
        """
1587.1.9 by Robert Collins
Local commits do no alter or access the master branch.
409
        if self.local and not self.branch.get_bound_location():
410
            raise errors.LocalRequiresBoundBranch()
411
412
        if not self.local:
413
            self.master_branch = self.branch.get_master_branch()
414
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
415
        if not self.master_branch:
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
416
            # make this branch the reference branch for out of date checks.
417
            self.master_branch = self.branch
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
418
            return
419
420
        # If the master branch is bound, we must fail
421
        master_bound_location = self.master_branch.get_bound_location()
422
        if master_bound_location:
1505.1.27 by John Arbash Meinel
Adding tests against an sftp branch.
423
            raise errors.CommitToDoubleBoundBranch(self.branch,
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
424
                    self.master_branch, master_bound_location)
425
426
        # TODO: jam 20051230 We could automatically push local
427
        #       commits to the remote branch if they would fit.
428
        #       But for now, just require remote to be identical
429
        #       to local.
430
        
431
        # Make sure the local branch is identical to the master
2249.4.2 by Wouter van Heyst
Convert callers of Branch.revision_history() to Branch.last_revision_info() where sensible.
432
        master_info = self.master_branch.last_revision_info()
433
        local_info = self.branch.last_revision_info()
434
        if local_info != master_info:
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
435
            raise errors.BoundBranchOutOfDate(self.branch,
436
                    self.master_branch)
437
438
        # Now things are ready to change the master branch
439
        # so grab the lock
440
        self.bound_branch = self.branch
441
        self.master_branch.lock_write()
1614.1.1 by Aaron Bentley
Fixed master locking in commit
442
        self.master_locked = True
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
443
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
444
    def _check_out_of_date_tree(self):
445
        """Check that the working tree is up to date.
446
447
        :return: old_revision_number,new_revision_number tuple
448
        """
449
        try:
450
            first_tree_parent = self.work_tree.get_parent_ids()[0]
451
        except IndexError:
452
            # if there are no parents, treat our parent as 'None'
453
            # this is so that we still consider the master branch
454
            # - in a checkout scenario the tree may have no
455
            # parents but the branch may do.
456
            first_tree_parent = bzrlib.revision.NULL_REVISION
457
        old_revno, master_last = self.master_branch.last_revision_info()
458
        if master_last != first_tree_parent:
459
            if master_last != bzrlib.revision.NULL_REVISION:
460
                raise errors.OutOfDateTree(self.work_tree)
461
        if self.branch.repository.has_revision(first_tree_parent):
462
            new_revno = old_revno + 1
463
        else:
464
            # ghost parents never appear in revision history.
465
            new_revno = 1
466
        return old_revno,new_revno
467
468
    def _process_hooks(self, old_revno, new_revno):
469
        """Process any registered commit hooks."""
2553.1.2 by Robert Collins
Show hook names during commit.
470
        # Process the post commit hooks, if any
471
        self._emit_progress_set_stage("Running post commit hooks")
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
472
        # old style commit hooks - should be deprecated ? (obsoleted in
473
        # 0.15)
474
        if self.config.post_commit() is not None:
475
            hooks = self.config.post_commit().split(' ')
476
            # this would be nicer with twisted.python.reflect.namedAny
477
            for hook in hooks:
478
                result = eval(hook + '(branch, rev_id)',
479
                              {'branch':self.branch,
480
                               'bzrlib':bzrlib,
481
                               'rev_id':self.rev_id})
482
        # new style commit hooks:
483
        if not self.bound_branch:
484
            hook_master = self.branch
485
            hook_local = None
486
        else:
487
            hook_master = self.master_branch
488
            hook_local = self.branch
489
        # With bound branches, when the master is behind the local branch,
490
        # the 'old_revno' and old_revid values here are incorrect.
491
        # XXX: FIXME ^. RBC 20060206
492
        if self.parents:
493
            old_revid = self.parents[0]
494
        else:
495
            old_revid = bzrlib.revision.NULL_REVISION
496
        for hook in Branch.hooks['post_commit']:
2553.1.3 by Robert Collins
Increase docs in response to review feedback.
497
            # show the running hook in the progress bar. As hooks may
498
            # end up doing nothing (e.g. because they are not configured by
499
            # the user) this is still showing progress, not showing overall
500
            # actions - its up to each plugin to show a UI if it want's to
501
            # (such as 'Emailing diff to foo@example.com').
2553.1.2 by Robert Collins
Show hook names during commit.
502
            self.pb_stage_name = "Running post commit hooks [%s]" % \
503
                Branch.hooks.get_hook_name(hook)
504
            self._emit_progress()
2560.1.4 by Robert Collins
Allow -Dhooks to get the hooks invoked during commit logged.
505
            if 'hooks' in debug.debug_flags:
506
                mutter("Invoking commit hook: %r", hook)
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
507
            hook(hook_local, hook_master, old_revno, old_revid, new_revno,
508
                self.rev_id)
509
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
510
    def _cleanup(self):
511
        """Cleanup any open locks, progress bars etc."""
512
        cleanups = [self._cleanup_bound_branch,
2255.2.25 by John Arbash Meinel
DirstateRevisionTrees need to be read_locked before they will work as BasisTree
513
                    self.basis_tree.unlock,
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
514
                    self.work_tree.unlock,
515
                    self.pb.finished]
516
        found_exception = None
517
        for cleanup in cleanups:
518
            try:
519
                cleanup()
520
            # we want every cleanup to run no matter what.
521
            # so we have a catchall here, but we will raise the
522
            # last encountered exception up the stack: and
523
            # typically this will be useful enough.
524
            except Exception, e:
525
                found_exception = e
526
        if found_exception is not None: 
1759.2.2 by Jelmer Vernooij
Revert some of my spelling fixes and fix some typos after review by Aaron.
527
            # don't do a plan raise, because the last exception may have been
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
528
            # trashed, e is our sure-to-work exception even though it loses the
529
            # full traceback. XXX: RBC 20060421 perhaps we could check the
530
            # exc_info and if its the same one do a plain raise otherwise 
531
            # 'raise e' as we do now.
532
            raise e
533
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
534
    def _cleanup_bound_branch(self):
535
        """Executed at the end of a try/finally to cleanup a bound branch.
536
537
        If the branch wasn't bound, this is a no-op.
538
        If it was, it resents self.branch to the local branch, instead
539
        of being the master.
540
        """
541
        if not self.bound_branch:
542
            return
1614.1.1 by Aaron Bentley
Fixed master locking in commit
543
        if self.master_locked:
544
            self.master_branch.unlock()
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
545
1390 by Robert Collins
pair programming worx... merge integration and weave
546
    def _escape_commit_message(self):
547
        """Replace xml-incompatible control characters."""
1666.1.6 by Robert Collins
Make knit the default format.
548
        # FIXME: RBC 20060419 this should be done by the revision
549
        # serialiser not by commit. Then we can also add an unescaper
550
        # in the deserializer and start roundtripping revision messages
551
        # precisely. See repository_implementations/test_repository.py
552
        
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
553
        # Python strings can include characters that can't be
554
        # represented in well-formed XML; escape characters that
555
        # aren't listed in the XML specification
556
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
1390 by Robert Collins
pair programming worx... merge integration and weave
557
        self.message, escape_count = re.subn(
1393.4.2 by Harald Meland
Cleanup + better test of commit-msg control character escape code.
558
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
559
            lambda match: match.group(0).encode('unicode_escape'),
1390 by Robert Collins
pair programming worx... merge integration and weave
560
            self.message)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
561
        if escape_count:
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
562
            self.reporter.escaped(escape_count, self.message)
1223 by Martin Pool
- store inventories in weave
563
564
    def _gather_parents(self):
1092.2.25 by Robert Collins
support ghosts in commits
565
        """Record the parents of a merge for merge detection."""
1740.3.6 by Jelmer Vernooij
Move inventory writing to the commit builder.
566
        # TODO: Make sure that this list doesn't contain duplicate 
567
        # entries and the order is preserved when doing this.
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
568
        self.parents = self.work_tree.get_parent_ids()
2283.2.1 by John Arbash Meinel
Avoid deserializing an inventory we have already parsed.
569
        self.parent_invs = [self.basis_inv]
570
        for revision in self.parents[1:]:
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
571
            if self.branch.repository.has_revision(revision):
1927.2.1 by Robert Collins
Alter set_pending_merges to shove the left most merge into the trees last-revision if that is not set. Related bugfixes include basis_tree handling ghosts, de-duping the merges with the last-revision and update changing where and how it adds its pending merge.
572
                mutter('commit parent revision {%s}', revision)
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
573
                inventory = self.branch.repository.get_inventory(revision)
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
574
                self.parent_invs.append(inventory)
1927.2.1 by Robert Collins
Alter set_pending_merges to shove the left most merge into the trees last-revision if that is not set. Related bugfixes include basis_tree handling ghosts, de-duping the merges with the last-revision and update changing where and how it adds its pending merge.
575
            else:
576
                mutter('commit parent ghost revision {%s}', revision)
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
577
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
578
    def _update_builder_with_changes(self):
579
        """Update the commit builder with the data about what has changed.
580
        """
581
        # Build the revision inventory.
582
        #
583
        # This starts by creating a new empty inventory. Depending on
584
        # which files are selected for commit, and what is present in the
585
        # current tree, the new inventory is populated. inventory entries 
586
        # which are candidates for modification have their revision set to
587
        # None; inventory entries that are carried over untouched have their
588
        # revision set to their prior value.
589
        #
1551.7.24 by Aaron Bentley
Ensure commit respects file spec when committing removals
590
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
591
        # results to create a new inventory at the same time, which results
1852.10.3 by Robert Collins
Remove all uses of compare_trees and replace with Tree.changes_from throughout bzrlib.
592
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
1551.7.24 by Aaron Bentley
Ensure commit respects file spec when committing removals
593
        # ADHB 11-07-2006
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
594
595
        specific_files = self.specific_files
596
        mutter("Selecting files for commit with filter %s", specific_files)
597
        work_inv = self.work_tree.inventory
598
        assert work_inv.root is not None
599
        self.pb_entries_total = len(work_inv)
600
601
        # Check and warn about old CommitBuilders
1551.15.39 by Aaron Bentley
Fix commit ordering (#94975)
602
        entries = work_inv.iter_entries_by_dir()
1910.2.4 by Aaron Bentley
Support old CommitBuilders
603
        if not self.builder.record_root_entry:
1910.2.9 by Aaron Bentley
Inroduce assertDeprecated, and use it to test old commitbuilder API
604
            symbol_versioning.warn('CommitBuilders should support recording'
605
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
606
                stacklevel=1)
1910.2.4 by Aaron Bentley
Support old CommitBuilders
607
            self.builder.new_inventory.add(self.basis_inv.root.copy())
608
            entries.next()
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
609
610
        deleted_ids = []
611
        deleted_paths = set()
1910.2.4 by Aaron Bentley
Support old CommitBuilders
612
        for path, new_ie in entries:
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
613
            self._emit_progress_next_entry()
1249 by Martin Pool
- improvements to weave commit [broken]
614
            file_id = new_ie.file_id
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
615
616
            # Skip files that have been deleted from the working tree.
617
            # The deleted files/directories are also recorded so they
618
            # can be explicitly unversioned later. Note that when a
619
            # filter of specific files is given, we must only skip/record
620
            # deleted files matching that filter.
621
            if is_inside_any(deleted_paths, path):
622
                continue
623
            if not specific_files or is_inside_any(specific_files, path):
624
                if not self.work_tree.has_filename(path):
625
                    deleted_paths.add(path)
626
                    self.reporter.missing(path)
627
                    deleted_ids.append(file_id)
628
                    continue
1959.4.2 by Aaron Bentley
Merge bzr.dev
629
            try:
630
                kind = self.work_tree.kind(file_id)
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
631
                if kind == 'tree-reference' and self.recursive == 'down':
632
                    # nested tree: commit in it
633
                    sub_tree = WorkingTree.open(self.work_tree.abspath(path))
634
                    # FIXME: be more comprehensive here:
635
                    # this works when both trees are in --trees repository,
636
                    # but when both are bound to a different repository,
637
                    # it fails; a better way of approaching this is to 
638
                    # finally implement the explicit-caches approach design
639
                    # a while back - RBC 20070306.
640
                    if (sub_tree.branch.repository.bzrdir.root_transport.base
641
                        ==
642
                        self.work_tree.branch.repository.bzrdir.root_transport.base):
643
                        sub_tree.branch.repository = \
644
                            self.work_tree.branch.repository
645
                    try:
646
                        sub_tree.commit(message=None, revprops=self.revprops,
647
                            recursive=self.recursive,
648
                            message_callback=self.message_callback,
649
                            timestamp=self.timestamp, timezone=self.timezone,
650
                            committer=self.committer,
651
                            allow_pointless=self.allow_pointless,
652
                            strict=self.strict, verbose=self.verbose,
653
                            local=self.local, reporter=self.reporter)
654
                    except errors.PointlessCommit:
655
                        pass
1959.4.2 by Aaron Bentley
Merge bzr.dev
656
                if kind != new_ie.kind:
1959.4.4 by Aaron Bentley
Trim trailing whitespace
657
                    new_ie = inventory.make_entry(kind, new_ie.name,
1959.4.2 by Aaron Bentley
Merge bzr.dev
658
                                                  new_ie.parent_id, file_id)
659
            except errors.NoSuchFile:
660
                pass
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
661
            # mutter('check %s {%s}', path, file_id)
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
662
            if (not specific_files or 
663
                is_inside_or_parent_of_any(specific_files, path)):
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
664
                    # mutter('%s selected for commit', path)
1740.3.6 by Jelmer Vernooij
Move inventory writing to the commit builder.
665
                    ie = new_ie.copy()
666
                    ie.revision = None
1740.3.5 by Jelmer Vernooij
Simplify inventory population code by using is_inside_or_parent_of_any()
667
            else:
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
668
                # mutter('%s not selected for commit', path)
1740.3.6 by Jelmer Vernooij
Move inventory writing to the commit builder.
669
                if self.basis_inv.has_id(file_id):
670
                    ie = self.basis_inv[file_id].copy()
671
                else:
672
                    # this entry is new and not being committed
673
                    continue
1731.1.62 by Aaron Bentley
Changes from review comments
674
            self.builder.record_entry_contents(ie, self.parent_invs, 
675
                path, self.work_tree)
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
676
            # describe the nature of the change that has occurred relative to
1740.3.6 by Jelmer Vernooij
Move inventory writing to the commit builder.
677
            # the basis inventory.
678
            if (self.basis_inv.has_id(ie.file_id)):
679
                basis_ie = self.basis_inv[ie.file_id]
680
            else:
681
                basis_ie = None
682
            change = ie.describe_change(basis_ie, ie)
683
            if change in (InventoryEntry.RENAMED, 
684
                InventoryEntry.MODIFIED_AND_RENAMED):
685
                old_path = self.basis_inv.id2path(ie.file_id)
686
                self.reporter.renamed(change, old_path, path)
687
            else:
688
                self.reporter.snapshot_change(change, path)
1416 by Robert Collins
when committing a specific file, include all its parents
689
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
690
        # Unversion IDs that were found to be deleted
691
        self.work_tree.unversion(deleted_ids)
692
693
        # If specific files/directories were nominated, it is possible
694
        # that some data from outside those needs to be preserved from
695
        # the basis tree. For example, if a file x is moved from out of
696
        # directory foo into directory bar and the user requests
697
        # ``commit foo``, then information about bar/x must also be
698
        # recorded.
699
        if specific_files:
700
            for path, new_ie in self.basis_inv.iter_entries():
701
                if new_ie.file_id in work_inv:
702
                    continue
703
                if is_inside_any(specific_files, path):
704
                    continue
705
                ie = new_ie.copy()
706
                ie.revision = None
707
                self.builder.record_entry_contents(ie, self.parent_invs, path,
708
                                                   self.basis_tree)
709
710
        # Report what was deleted. We could skip this when no deletes are
711
        # detected to gain a performance win, but it arguably serves as a
712
        # 'safety check' by informing the user whenever anything disappears.
713
        for path, ie in self.basis_inv.iter_entries():
714
            if ie.file_id not in self.builder.new_inventory:
715
                self.reporter.deleted(path)
1551.7.24 by Aaron Bentley
Ensure commit respects file spec when committing removals
716
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
717
    def _emit_progress_set_stage(self, name, show_entries=False):
718
        """Set the progress stage and emit an update to the progress bar."""
719
        self.pb_stage_name = name
720
        self.pb_stage_count += 1
721
        self.pb_entries_show = show_entries
722
        if show_entries:
723
            self.pb_entries_count = 0
724
            self.pb_entries_total = '?'
725
        self._emit_progress()
726
727
    def _emit_progress_next_entry(self):
728
        """Emit an update to the progress bar and increment the file count."""
729
        self.pb_entries_count += 1
730
        self._emit_progress()
731
732
    def _emit_progress(self):
733
        if self.pb_entries_show:
734
            text = "%s [Entry %d/%s] - Stage" % (self.pb_stage_name,
735
                self.pb_entries_count,str(self.pb_entries_total))
736
        else:
737
            text = "%s - Stage" % (self.pb_stage_name)
738
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
739