1
# Copyright (C) 2005-2010 Canonical Ltd
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24
revision as _mod_revision,
26
import bzrlib.errors as errors
27
from bzrlib.trace import mutter, warning
29
# TODO: when showing single-line logs, truncate to the width of the terminal
30
# if known, but only if really going to the terminal (not into a file)
33
def report_changes(to_file, old, new, specific_files,
34
show_short_reporter, show_long_callback,
35
short=False, want_unchanged=False,
36
want_unversioned=False, show_ids=False):
37
"""Display summary of changes.
39
This compares two trees with regards to a list of files, and delegates
40
the display to underlying elements.
42
For short output, it creates an iterator on all changes, and lets a given
43
reporter display these changes.
45
For stantard output, it creates a delta of the changes, and forwards it
48
:param to_file: If set, write to this file (default stdout.)
49
:param old: Start tree for the comparison
50
:param end: End tree for the comparison
51
:param specific_files: If set, a list of filenames whose status should be
52
shown. It is an error to give a filename that is not in the working
53
tree, or in the working inventory or in the basis inventory.
54
:param show_short_reporter: Reporter in charge of display for short output
55
:param show_long_callback: Callback in charge of display for normal output
56
:param short: If True, gives short SVN-style status lines.
57
:param want_unchanged: Deprecated parameter. If set, includes unchanged
59
:param show_ids: If set, includes each file's id.
60
:param want_unversioned: If False, only shows versioned files.
64
changes = new.iter_changes(old, want_unchanged, specific_files,
65
require_versioned=False, want_unversioned=want_unversioned)
66
_mod_delta.report_changes(changes, show_short_reporter)
69
delta = new.changes_from(old, want_unchanged=want_unchanged,
70
specific_files=specific_files,
71
want_unversioned=want_unversioned)
72
# filter out unknown files. We may want a tree method for
74
delta.unversioned = [unversioned for unversioned in
75
delta.unversioned if not new.is_ignored(unversioned[0])]
76
show_long_callback(to_file, delta,
78
show_unchanged=want_unchanged)
81
def show_tree_status(wt, show_unchanged=None,
90
show_long_callback=_mod_delta.report_delta):
91
"""Display summary of changes.
93
By default this compares the working tree to a previous revision.
94
If the revision argument is given, summarizes changes between the
95
working tree and another, or between two revisions.
97
The result is written out as Unicode and to_file should be able
100
If showing the status of a working tree, extra information is included
101
about unknown files, conflicts, and pending merges.
103
:param show_unchanged: Deprecated parameter. If set, includes unchanged
105
:param specific_files: If set, a list of filenames whose status should be
106
shown. It is an error to give a filename that is not in the working
107
tree, or in the working inventory or in the basis inventory.
108
:param show_ids: If set, includes each file's id.
109
:param to_file: If set, write to this file (default stdout.)
110
:param show_pending: If set, write pending merges.
111
:param revision: If None, compare latest revision with working tree
112
If not None, it must be a RevisionSpec list.
113
If one revision, compare with working tree.
114
If two revisions, show status between first and second.
115
:param short: If True, gives short SVN-style status lines.
116
:param verbose: If True, show all merged revisions, not just
118
:param versioned: If True, only shows versioned files.
119
:param show_long_callback: A callback: message = show_long_callback(to_file, delta,
120
show_ids, show_unchanged, indent, filter), only used with the long output
122
if show_unchanged is not None:
123
warn("show_tree_status with show_unchanged has been deprecated "
124
"since bzrlib 0.9", DeprecationWarning, stacklevel=2)
131
new_is_working_tree = True
133
if wt.last_revision() != wt.branch.last_revision():
134
warning("working tree is out of date, run 'bzr update'")
136
old = new.basis_tree()
137
elif len(revision) > 0:
139
old = revision[0].as_tree(wt.branch)
140
except errors.NoSuchRevision, e:
141
raise errors.BzrCommandError(str(e))
142
if (len(revision) > 1) and (revision[1].spec is not None):
144
new = revision[1].as_tree(wt.branch)
145
new_is_working_tree = False
146
except errors.NoSuchRevision, e:
147
raise errors.BzrCommandError(str(e))
153
specific_files, nonexistents \
154
= _filter_nonexistent(specific_files, old, new)
155
want_unversioned = not versioned
157
# Reporter used for short outputs
158
reporter = _mod_delta._ChangeReporter(output_file=to_file,
159
unversioned_filter=new.is_ignored)
160
report_changes(to_file, old, new, specific_files,
161
reporter, show_long_callback,
162
short=short, want_unchanged=show_unchanged,
163
want_unversioned=want_unversioned, show_ids=show_ids)
165
# show the ignored files among specific files (i.e. show the files
166
# identified from input that we choose to ignore).
167
if specific_files is not None:
168
# Ignored files is sorted because specific_files is already sorted
169
ignored_files = [specific for specific in
170
specific_files if new.is_ignored(specific)]
171
if len(ignored_files) > 0 and not short:
172
to_file.write("ignored:\n")
176
for ignored_file in ignored_files:
177
to_file.write("%s %s\n" % (prefix, ignored_file))
179
# show the new conflicts only for now. XXX: get them from the
181
conflicts = new.conflicts()
182
if specific_files is not None:
183
conflicts = conflicts.select_conflicts(new, specific_files,
184
ignore_misses=True, recurse=True)[1]
185
if len(conflicts) > 0 and not short:
186
to_file.write("conflicts:\n")
187
for conflict in conflicts:
192
to_file.write("%s %s\n" % (prefix, conflict))
193
# Show files that were requested but don't exist (and are
194
# not versioned). We don't involve delta in this; these
195
# paths are really the province of just the status
196
# command, since they have more to do with how it was
197
# invoked than with the tree it's operating on.
198
if nonexistents and not short:
199
to_file.write("nonexistent:\n")
200
for nonexistent in nonexistents:
201
# We could calculate prefix outside the loop but, given
202
# how rarely this ought to happen, it's OK and arguably
203
# slightly faster to do it here (ala conflicts above)
208
to_file.write("%s %s\n" % (prefix, nonexistent))
209
if (new_is_working_tree and show_pending):
210
show_pending_merges(new, to_file, short, verbose=verbose)
212
raise errors.PathsDoNotExist(nonexistents)
220
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
221
"""Get an iterator which will return the revisions in merge sorted order.
223
This will build up a list of all nodes, such that only nodes in the list
224
are referenced. It then uses MergeSorter to return them in 'merge-sorted'
227
:param revision_ids: A set of revision_ids
228
:param parent_map: The parent information for each node. Revisions which
229
are considered ghosts should not be present in the map.
230
:return: iterator from MergeSorter.iter_topo_order()
232
# MergeSorter requires that all nodes be present in the graph, so get rid
233
# of any references pointing outside of this graph.
235
for revision_id in revision_ids:
236
if revision_id not in parent_map: # ghost
237
parent_graph[revision_id] = []
239
# Only include parents which are in this sub-graph
240
parent_graph[revision_id] = [p for p in parent_map[revision_id]
241
if p in revision_ids]
242
sorter = tsort.MergeSorter(parent_graph, tip_revision)
243
return sorter.iter_topo_order()
246
def show_pending_merges(new, to_file, short=False, verbose=False):
247
"""Write out a display of pending merges in a working tree."""
248
parents = new.get_parent_ids()
252
term_width = osutils.terminal_width()
253
if term_width is not None:
254
# we need one extra space for terminals that wrap on last char
255
term_width = term_width - 1
263
def show_log_message(rev, prefix):
264
if term_width is None:
267
width = term_width - len(prefix)
268
log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
269
to_file.write(log_message + '\n')
271
pending = parents[1:]
273
last_revision = parents[0]
276
to_file.write('pending merges:\n')
278
to_file.write('pending merge tips:'
279
' (use -v to see all merge revisions)\n')
280
graph = branch.repository.get_graph()
281
other_revisions = [last_revision]
282
log_formatter = log.LineLogFormatter(to_file)
283
for merge in pending:
285
rev = branch.repository.get_revisions([merge])[0]
286
except errors.NoSuchRevision:
287
# If we are missing a revision, just print out the revision id
288
to_file.write(first_prefix + '(ghost) ' + merge + '\n')
289
other_revisions.append(merge)
292
# Log the merge, as it gets a slightly different formatting
293
show_log_message(rev, first_prefix)
297
# Find all of the revisions in the merge source, which are not in the
298
# last committed revision.
299
merge_extra = graph.find_unique_ancestors(merge, other_revisions)
300
other_revisions.append(merge)
301
merge_extra.discard(_mod_revision.NULL_REVISION)
303
# Get a handle to all of the revisions we will need
305
revisions = dict((rev.revision_id, rev) for rev in
306
branch.repository.get_revisions(merge_extra))
307
except errors.NoSuchRevision:
308
# One of the sub nodes is a ghost, check each one
310
for revision_id in merge_extra:
312
rev = branch.repository.get_revisions([revision_id])[0]
313
except errors.NoSuchRevision:
314
revisions[revision_id] = None
316
revisions[revision_id] = rev
318
# Display the revisions brought in by this merge.
319
rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
320
branch.repository.get_parent_map(merge_extra))
321
# Skip the first node
322
num, first, depth, eom = rev_id_iterator.next()
324
raise AssertionError('Somehow we misunderstood how'
325
' iter_topo_order works %s != %s' % (first, merge))
326
for num, sub_merge, depth, eom in rev_id_iterator:
327
rev = revisions[sub_merge]
329
to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
331
show_log_message(revisions[sub_merge], sub_prefix)
334
def _filter_nonexistent(orig_paths, old_tree, new_tree):
335
"""Convert orig_paths to two sorted lists and return them.
337
The first is orig_paths paths minus the items in the second list,
338
and the second list is paths that are not in either inventory or
339
tree (they don't qualify if they exist in the tree's inventory, or
340
if they exist in the tree but are not versioned.)
342
If either of the two lists is empty, return it as an empty list.
344
This can be used by operations such as bzr status that can accept
345
unknown or ignored files.
347
mutter("check paths: %r", orig_paths)
349
return orig_paths, []
350
s = old_tree.filter_unversioned_files(orig_paths)
351
s = new_tree.filter_unversioned_files(s)
352
nonexistent = [path for path in s if not new_tree.has_filename(path)]
353
remaining = [path for path in orig_paths if not path in nonexistent]
354
# Sorting the 'remaining' list doesn't have much effect in
355
# practice, since the various status output sections will sort
356
# their groups individually. But for consistency of this
357
# function's API, it's better to sort both than just 'nonexistent'.
358
return sorted(remaining), sorted(nonexistent)
added
removed
bzrlib/status.py
