29
29
* with file-ids and revision-ids shown
31
* from last to first or (not anymore) from first to last;
32
the default is "reversed" because it shows the likely most
33
relevant and interesting information first
35
* (not yet) in XML format
31
Logs are actually written out through an abstract LogFormatter
32
interface, which allows for different preferred formats. Plugins can
35
Logs can be produced in either forward (oldest->newest) or reverse
36
(newest->oldest) order.
38
Logs can be filtered to show only revisions matching a particular
39
search string, or within a particular range of revisions. The range
40
can be given as date/times, which are reduced to revisions before
43
In verbose mode we show a summary of what changed in each particular
44
revision. Note that this is the delta for changes in that revision
45
relative to its mainline parent, not the delta relative to the last
46
logged revision. So for example if you ask for a verbose log of
47
changes touching hello.c you will get a list of those revisions also
48
listing other things that were changed in the same revision, but not
49
all the changes since the previous revision that touched hello.c.
39
from trace import mutter
53
from bzrlib.tree import EmptyTree
54
from bzrlib.delta import compare_trees
55
from bzrlib.trace import mutter
41
58
def find_touching_revisions(branch, file_id):
42
59
"""Yield a description of revisions which affect the file_id.
103
def _enumerate_history(branch):
106
for rev_id in branch.revision_history():
107
rh.append((revno, rev_id))
112
def _get_revision_delta(branch, revno):
113
"""Return the delta for a mainline revision.
115
This is used to show summaries in verbose logs, and also for finding
116
revisions which touch a given file."""
117
# FIXME: The current version is very inefficient; it retrieves all revisions
118
# twice and reads the weave twice. We ought to keep revisions in memory
119
# in case they're used again, either in a general cache or perhaps
121
# XXX: What are we supposed to do when showing a summary for something
122
# other than a mainline revision. The delta to it's first parent, or
123
# (more useful) the delta to a nominated other revision.
124
return branch.get_revision_delta(revno)
86
127
def show_log(branch,
88
129
specific_fileid=None,
134
which_revs = branch.enum_history(direction)
135
which_revs = [x for x in which_revs if (
136
(start_revision is None or x[0] >= start_revision)
137
and (end_revision is None or x[0] <= end_revision))]
139
if not (verbose or specific_fileid):
140
# no need to know what changed between revisions
141
with_deltas = deltas_for_log_dummy(branch, which_revs)
142
elif direction == 'reverse':
143
with_deltas = deltas_for_log_reverse(branch, which_revs)
145
with_deltas = deltas_for_log_forward(branch, which_revs)
147
for revno, rev, delta in with_deltas:
175
which_revs = _enumerate_history(branch)
177
if start_revision is None:
180
branch.check_real_revno(start_revision)
182
if end_revision is None:
183
end_revision = len(which_revs)
185
branch.check_real_revno(end_revision)
187
# list indexes are 0-based; revisions are 1-based
188
cut_revs = which_revs[(start_revision-1):(end_revision)]
190
if direction == 'reverse':
192
elif direction == 'forward':
195
raise ValueError('invalid direction %r' % direction)
197
for revno, rev_id in cut_revs:
198
if verbose or specific_fileid:
199
delta = _get_revision_delta(branch, revno)
148
201
if specific_fileid:
149
202
if not delta.touches_file_id(specific_fileid):
153
206
# although we calculated it, throw it away without display
156
if searchRE is None or searchRE.search(rev.message):
157
lf.show(revno, rev, delta)
209
rev = branch.get_revision(rev_id)
212
if not searchRE.search(rev.message):
215
lf.show(revno, rev, delta)
161
219
def deltas_for_log_dummy(branch, which_revs):
220
"""Return all the revisions without intermediate deltas.
222
Useful for log commands that won't need the delta information.
162
225
for revno, revision_id in which_revs:
163
226
yield revno, branch.get_revision(revision_id), None
166
229
def deltas_for_log_reverse(branch, which_revs):
167
"""Compute deltas for display in reverse log.
169
Given a sequence of (revno, revision_id) pairs, return
230
"""Compute deltas for display in latest-to-earliest order.
236
Sequence of (revno, revision_id) for the subset of history to examine
239
Sequence of (revno, rev, delta)
172
241
The delta is from the given revision to the next one in the
173
242
sequence, which makes sense if the log is being displayed from
174
243
newest to oldest.
176
from tree import EmptyTree
177
from diff import compare_trees
179
245
last_revno = last_revision_id = last_tree = None
180
246
for revno, revision_id in which_revs:
181
247
this_tree = branch.revision_tree(revision_id)
210
276
sequence, which makes sense if the log is being displayed from
211
277
newest to oldest.
213
from tree import EmptyTree
214
from diff import compare_trees
216
279
last_revno = last_revision_id = last_tree = None
217
280
prev_tree = EmptyTree(branch.get_root_id())
238
301
class LogFormatter(object):
239
302
"""Abstract class to display log messages."""
240
def __init__(self, to_file, show_ids=False, show_timezone=False):
303
def __init__(self, to_file, show_ids=False, show_timezone='original'):
241
304
self.to_file = to_file
242
305
self.show_ids = show_ids
243
306
self.show_timezone = show_timezone
309
def show(self, revno, rev, delta):
310
raise NotImplementedError('not implemented in abstract base')
250
313
class LongLogFormatter(LogFormatter):
251
314
def show(self, revno, rev, delta):
252
315
from osutils import format_date
257
320
print >>to_file, 'revno:', revno
258
321
if self.show_ids:
259
322
print >>to_file, 'revision-id:', rev.revision_id
324
for parent_id in rev.parent_ids:
325
print >>to_file, 'parent:', parent_id
260
327
print >>to_file, 'committer:', rev.committer
261
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
329
date_str = format_date(rev.timestamp,
332
print >>to_file, 'timestamp: %s' % date_str
264
334
print >>to_file, 'message:'
265
335
if not rev.message:
290
360
for l in rev.message.split('\n'):
291
361
print >>to_file, ' ' + l
363
# TODO: Why not show the modified files in a shorter form as
364
# well? rewrap them single lines of appropriate length
293
365
if delta != None:
294
366
delta.show(to_file, self.show_ids)
304
376
def log_formatter(name, *args, **kwargs):
377
"""Construct a formatter from arguments.
379
name -- Name of the formatter to construct; currently 'long' and
380
'short' are supported.
305
382
from bzrlib.errors import BzrCommandError
308
384
return FORMATTERS[name](*args, **kwargs)
309
385
except IndexError:
310
386
raise BzrCommandError("unknown log formatter: %r" % name)
388
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
389
# deprecated; for compatability
390
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
391
lf.show(revno, rev, delta)
added
removed
bzrlib/log.py
