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
import bzrlib.errors as errors
54
from bzrlib.tree import EmptyTree
55
from bzrlib.delta import compare_trees
56
from bzrlib.trace import mutter
41
59
def find_touching_revisions(branch, file_id):
42
60
"""Yield a description of revisions which affect the file_id.
104
def _enumerate_history(branch):
107
for rev_id in branch.revision_history():
108
rh.append((revno, rev_id))
113
def _get_revision_delta(branch, revno):
114
"""Return the delta for a mainline revision.
116
This is used to show summaries in verbose logs, and also for finding
117
revisions which touch a given file."""
118
# XXX: What are we supposed to do when showing a summary for something
119
# other than a mainline revision. The delta to it's first parent, or
120
# (more useful) the delta to a nominated other revision.
121
return branch.get_revision_delta(revno)
86
124
def show_log(branch,
88
126
specific_fileid=None,
114
152
If not None, only show revisions <= end_revision
156
_show_log(branch, lf, specific_fileid, verbose, direction,
157
start_revision, end_revision, search)
161
def _show_log(branch,
163
specific_fileid=None,
169
"""Worker function for show_log - see show_log."""
116
170
from bzrlib.osutils import format_date
117
171
from bzrlib.errors import BzrCheckError
118
172
from bzrlib.textui import show_status
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:
188
which_revs = _enumerate_history(branch)
190
if start_revision is None:
193
branch.check_real_revno(start_revision)
195
if end_revision is None:
196
end_revision = len(which_revs)
198
branch.check_real_revno(end_revision)
200
# list indexes are 0-based; revisions are 1-based
201
cut_revs = which_revs[(start_revision-1):(end_revision)]
203
if direction == 'reverse':
205
elif direction == 'forward':
208
raise ValueError('invalid direction %r' % direction)
210
revision_history = branch.revision_history()
211
for revno, rev_id in cut_revs:
212
if verbose or specific_fileid:
213
delta = _get_revision_delta(branch, revno)
148
215
if specific_fileid:
149
216
if not delta.touches_file_id(specific_fileid):
153
220
# 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)
223
rev = branch.get_revision(rev_id)
226
if not searchRE.search(rev.message):
229
lf.show(revno, rev, delta)
233
# revno is 1 based, so -2 to get back 1 less.
234
excludes = set(branch.get_ancestry(revision_history[revno - 2]))
235
pending = list(rev.parent_ids)
237
rev_id = pending.pop()
238
if rev_id in excludes:
240
# prevent showing merged revs twice if they multi-path.
243
rev = branch.get_revision(rev_id)
244
except errors.NoSuchRevision:
246
pending.extend(rev.parent_ids)
161
250
def deltas_for_log_dummy(branch, which_revs):
251
"""Return all the revisions without intermediate deltas.
253
Useful for log commands that won't need the delta information.
162
256
for revno, revision_id in which_revs:
163
257
yield revno, branch.get_revision(revision_id), None
166
260
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
261
"""Compute deltas for display in latest-to-earliest order.
267
Sequence of (revno, revision_id) for the subset of history to examine
270
Sequence of (revno, rev, delta)
172
272
The delta is from the given revision to the next one in the
173
273
sequence, which makes sense if the log is being displayed from
174
274
newest to oldest.
176
from tree import EmptyTree
177
from diff import compare_trees
179
276
last_revno = last_revision_id = last_tree = None
180
277
for revno, revision_id in which_revs:
181
278
this_tree = branch.revision_tree(revision_id)
210
307
sequence, which makes sense if the log is being displayed from
211
308
newest to oldest.
213
from tree import EmptyTree
214
from diff import compare_trees
216
310
last_revno = last_revision_id = last_tree = None
217
311
prev_tree = EmptyTree(branch.get_root_id())
238
332
class LogFormatter(object):
239
333
"""Abstract class to display log messages."""
240
def __init__(self, to_file, show_ids=False, show_timezone=False):
334
def __init__(self, to_file, show_ids=False, show_timezone='original'):
241
335
self.to_file = to_file
242
336
self.show_ids = show_ids
243
337
self.show_timezone = show_timezone
340
def show(self, revno, rev, delta):
341
raise NotImplementedError('not implemented in abstract base')
343
def show_merge(self, rev):
250
347
class LongLogFormatter(LogFormatter):
251
348
def show(self, revno, rev, delta):
252
349
from osutils import format_date
257
354
print >>to_file, 'revno:', revno
258
355
if self.show_ids:
259
356
print >>to_file, 'revision-id:', rev.revision_id
358
for parent_id in rev.parent_ids:
359
print >>to_file, 'parent:', parent_id
260
361
print >>to_file, 'committer:', rev.committer
261
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
363
date_str = format_date(rev.timestamp,
366
print >>to_file, 'timestamp: %s' % date_str
264
368
print >>to_file, 'message:'
265
369
if not rev.message:
271
375
if delta != None:
272
376
delta.show(to_file, self.show_ids)
378
def show_merge(self, rev):
379
from osutils import format_date
381
to_file = self.to_file
385
print >>to_file, indent+'-' * 60
386
print >>to_file, indent+'merged:', rev.revision_id
388
for parent_id in rev.parent_ids:
389
print >>to_file, indent+'parent:', parent_id
391
print >>to_file, indent+'committer:', rev.committer
393
date_str = format_date(rev.timestamp,
396
print >>to_file, indent+'timestamp: %s' % date_str
398
print >>to_file, indent+'message:'
400
print >>to_file, indent+' (no message)'
402
for l in rev.message.split('\n'):
403
print >>to_file, indent+' ' + l
276
406
class ShortLogFormatter(LogFormatter):
290
420
for l in rev.message.split('\n'):
291
421
print >>to_file, ' ' + l
423
# TODO: Why not show the modified files in a shorter form as
424
# well? rewrap them single lines of appropriate length
293
425
if delta != None:
294
426
delta.show(to_file, self.show_ids)
304
436
def log_formatter(name, *args, **kwargs):
437
"""Construct a formatter from arguments.
439
name -- Name of the formatter to construct; currently 'long' and
440
'short' are supported.
305
442
from bzrlib.errors import BzrCommandError
308
444
return FORMATTERS[name](*args, **kwargs)
309
445
except IndexError:
310
446
raise BzrCommandError("unknown log formatter: %r" % name)
448
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
449
# deprecated; for compatability
450
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
451
lf.show(revno, rev, delta)
added
removed
bzrlib/log.py
