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
60
def find_touching_revisions(branch, file_id):
42
61
"""Yield a description of revisions which affect the file_id.
105
def _enumerate_history(branch):
108
for rev_id in branch.revision_history():
109
rh.append((revno, rev_id))
114
def _get_revision_delta(branch, revno):
115
"""Return the delta for a mainline revision.
117
This is used to show summaries in verbose logs, and also for finding
118
revisions which touch a given file."""
119
# XXX: What are we supposed to do when showing a summary for something
120
# other than a mainline revision. The delta to it's first parent, or
121
# (more useful) the delta to a nominated other revision.
122
return branch.get_revision_delta(revno)
86
125
def show_log(branch,
88
127
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:
189
which_revs = _enumerate_history(branch)
191
if start_revision is None:
194
branch.check_real_revno(start_revision)
196
if end_revision is None:
197
end_revision = len(which_revs)
199
branch.check_real_revno(end_revision)
201
# list indexes are 0-based; revisions are 1-based
202
cut_revs = which_revs[(start_revision-1):(end_revision)]
204
if direction == 'reverse':
206
elif direction == 'forward':
209
raise ValueError('invalid direction %r' % direction)
211
revision_history = branch.revision_history()
212
for revno, rev_id in cut_revs:
213
if verbose or specific_fileid:
214
delta = _get_revision_delta(branch, revno)
148
216
if specific_fileid:
149
217
if not delta.touches_file_id(specific_fileid):
153
221
# 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)
224
rev = branch.get_revision(rev_id)
227
if not searchRE.search(rev.message):
230
lf.show(revno, rev, delta)
231
if hasattr(lf, 'show_merge'):
235
# revno is 1 based, so -2 to get back 1 less.
236
excludes = set(branch.get_ancestry(revision_history[revno - 2]))
237
pending = list(rev.parent_ids)
239
rev_id = pending.pop()
240
if rev_id in excludes:
242
# prevent showing merged revs twice if they multi-path.
245
rev = branch.get_revision(rev_id)
246
except errors.NoSuchRevision:
248
pending.extend(rev.parent_ids)
161
252
def deltas_for_log_dummy(branch, which_revs):
253
"""Return all the revisions without intermediate deltas.
255
Useful for log commands that won't need the delta information.
162
258
for revno, revision_id in which_revs:
163
259
yield revno, branch.get_revision(revision_id), None
166
262
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
263
"""Compute deltas for display in latest-to-earliest order.
269
Sequence of (revno, revision_id) for the subset of history to examine
272
Sequence of (revno, rev, delta)
172
274
The delta is from the given revision to the next one in the
173
275
sequence, which makes sense if the log is being displayed from
174
276
newest to oldest.
176
from tree import EmptyTree
177
from diff import compare_trees
179
278
last_revno = last_revision_id = last_tree = None
180
279
for revno, revision_id in which_revs:
181
280
this_tree = branch.revision_tree(revision_id)
238
334
class LogFormatter(object):
239
335
"""Abstract class to display log messages."""
240
def __init__(self, to_file, show_ids=False, show_timezone=False):
336
def __init__(self, to_file, show_ids=False, show_timezone='original'):
241
337
self.to_file = to_file
242
338
self.show_ids = show_ids
243
339
self.show_timezone = show_timezone
342
def show(self, revno, rev, delta):
343
raise NotImplementedError('not implemented in abstract base')
345
def short_committer(self, rev):
346
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
250
349
class LongLogFormatter(LogFormatter):
251
350
def show(self, revno, rev, delta):
351
return self._show_helper(revno=revno, rev=rev)
353
def show_merge(self, rev):
354
return self._show_helper(rev=rev, indent=' ', merged=True)
356
def _show_helper(self, rev=None, revno=None, indent='', merged=False):
252
357
from osutils import format_date
254
359
to_file = self.to_file
256
print >>to_file, '-' * 60
257
print >>to_file, 'revno:', revno
362
print >>to_file, indent+'-' * 60
363
if revno is not None:
364
print >>to_file, 'revno:', revno
366
print >>to_file, indent+'merged:', rev.revision_id
368
print >>to_file, indent+'revision-id:', rev.revision_id
258
369
if self.show_ids:
259
print >>to_file, 'revision-id:', rev.revision_id
260
print >>to_file, 'committer:', rev.committer
261
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
264
print >>to_file, 'message:'
370
for parent_id in rev.parent_ids:
371
print >>to_file, indent+'parent:', parent_id
373
print >>to_file, indent+'committer:', rev.committer
375
print >>to_file, indent+'branch nick: %s' % \
376
rev.properties['branch-nick']
380
date_str = format_date(rev.timestamp,
383
print >>to_file, indent+'timestamp: %s' % date_str
385
print >>to_file, indent+'message:'
265
386
if not rev.message:
266
print >>to_file, ' (no message)'
387
print >>to_file, indent+' (no message)'
268
389
for l in rev.message.split('\n'):
269
print >>to_file, ' ' + l
272
delta.show(to_file, self.show_ids)
390
print >>to_file, indent+' ' + l
276
393
class ShortLogFormatter(LogFormatter):
278
395
from bzrlib.osutils import format_date
280
397
to_file = self.to_file
282
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
398
date_str = format_date(rev.timestamp, rev.timezone or 0,
400
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
283
401
format_date(rev.timestamp, rev.timezone or 0,
402
self.show_timezone, date_fmt="%Y-%m-%d",
285
404
if self.show_ids:
286
405
print >>to_file, ' revision-id:', rev.revision_id
287
406
if not rev.message:
290
409
for l in rev.message.split('\n'):
291
410
print >>to_file, ' ' + l
412
# TODO: Why not show the modified files in a shorter form as
413
# well? rewrap them single lines of appropriate length
293
414
if delta != None:
294
415
delta.show(to_file, self.show_ids)
418
class LineLogFormatter(LogFormatter):
419
def truncate(self, str, max_len):
420
if len(str) <= max_len:
422
return str[:max_len-3]+'...'
424
def date_string(self, rev):
425
from bzrlib.osutils import format_date
426
return format_date(rev.timestamp, rev.timezone or 0,
427
self.show_timezone, date_fmt="%Y-%m-%d",
430
def message(self, rev):
432
return '(no message)'
436
def show(self, revno, rev, delta):
437
print >> self.to_file, self.log_string(rev, 79)
439
def log_string(self, rev, max_chars):
440
out = [self.truncate(self.short_committer(rev), 20)]
441
out.append(self.date_string(rev))
442
out.append(self.message(rev).replace('\n', ' '))
443
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
445
def line_log(rev, max_chars):
446
lf = LineLogFormatter(None)
447
return lf.log_string(rev, max_chars)
299
449
FORMATTERS = {'long': LongLogFormatter,
300
450
'short': ShortLogFormatter,
451
'line': LineLogFormatter,
304
455
def log_formatter(name, *args, **kwargs):
456
"""Construct a formatter from arguments.
458
name -- Name of the formatter to construct; currently 'long', 'short' and
459
'line' are supported.
305
461
from bzrlib.errors import BzrCommandError
308
463
return FORMATTERS[name](*args, **kwargs)
309
464
except IndexError:
310
465
raise BzrCommandError("unknown log formatter: %r" % name)
467
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
468
# deprecated; for compatability
469
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
470
lf.show(revno, rev, delta)
472
def show_changed_revisions(branch, old_rh, new_rh, to_file=None, log_format='long'):
473
"""Show the change in revision history comparing the old revision history to the new one.
475
:param branch: The branch where the revisions exist
476
:param old_rh: The old revision history
477
:param new_rh: The new revision history
478
:param to_file: A file to write the results to. If None, stdout will be used
484
to_file = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
485
lf = log_formatter(log_format,
488
show_timezone='original')
490
# This is the first index which is different between
493
for i in xrange(max(len(new_rh),
497
or new_rh[i] != old_rh[i]):
502
to_file.write('Nothing seems to have changed\n')
504
## TODO: It might be nice to do something like show_log
505
## and show the merged entries. But since this is the
506
## removed revisions, it shouldn't be as important
507
if base_idx < len(old_rh):
508
to_file.write('*'*60)
509
to_file.write('\nRemoved Revisions:\n')
510
for i in range(base_idx, len(old_rh)):
511
rev = branch.get_revision(old_rh[i])
512
lf.show(i+1, rev, None)
513
to_file.write('*'*60)
514
to_file.write('\n\n')
515
if base_idx < len(new_rh):
516
to_file.write('Added Revisions:\n')
522
start_revision=base_idx+1,
523
end_revision=len(new_rh),
added
removed
bzrlib/log.py
