29
29
* with file-ids and revision-ids shown
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.
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
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
39
from trace import mutter
60
41
def find_touching_revisions(branch, file_id):
61
42
"""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)
125
86
def show_log(branch,
127
88
specific_fileid=None,
129
90
direction='reverse',
130
91
start_revision=None,
133
93
"""Write out human-readable log of commits to this branch.
153
113
If not None, only show revisions <= end_revision
157
_show_log(branch, lf, specific_fileid, verbose, direction,
158
start_revision, end_revision, search)
162
def _show_log(branch,
164
specific_fileid=None,
170
"""Worker function for show_log - see show_log."""
171
115
from bzrlib.osutils import format_date
172
116
from bzrlib.errors import BzrCheckError
173
117
from bzrlib.textui import show_status
180
124
if specific_fileid:
181
125
mutter('get log for file_id %r' % specific_fileid)
183
if search is not None:
185
searchRE = re.compile(search, re.IGNORECASE)
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)
127
which_revs = branch.enum_history(direction)
128
which_revs = [x for x in which_revs if (
129
(start_revision is None or x[0] >= start_revision)
130
and (end_revision is None or x[0] <= end_revision))]
132
if not (verbose or specific_fileid):
133
# no need to know what changed between revisions
134
with_deltas = deltas_for_log_dummy(branch, which_revs)
135
elif direction == 'reverse':
136
with_deltas = deltas_for_log_reverse(branch, which_revs)
138
with_deltas = deltas_for_log_forward(branch, which_revs)
140
for revno, rev, delta in with_deltas:
216
141
if specific_fileid:
217
142
if not delta.touches_file_id(specific_fileid):
221
146
# although we calculated it, throw it away without display
224
rev = branch.get_revision(rev_id)
227
if not searchRE.search(rev.message):
230
149
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)
252
153
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.
258
154
for revno, revision_id in which_revs:
259
155
yield revno, branch.get_revision(revision_id), None
262
158
def deltas_for_log_reverse(branch, which_revs):
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)
159
"""Compute deltas for display in reverse log.
161
Given a sequence of (revno, revision_id) pairs, return
274
164
The delta is from the given revision to the next one in the
275
165
sequence, which makes sense if the log is being displayed from
276
166
newest to oldest.
168
from tree import EmptyTree
169
from diff import compare_trees
278
171
last_revno = last_revision_id = last_tree = None
279
172
for revno, revision_id in which_revs:
280
173
this_tree = branch.revision_tree(revision_id)
284
177
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
286
this_tree = EmptyTree(branch.get_root_id())
288
179
last_revno = revno
289
180
last_revision = this_revision
290
181
last_tree = this_tree
293
184
if last_revno == 1:
294
this_tree = EmptyTree(branch.get_root_id())
185
this_tree = EmptyTree()
296
187
this_revno = last_revno - 1
297
188
this_revision_id = branch.revision_history()[this_revno]
309
200
sequence, which makes sense if the log is being displayed from
310
201
newest to oldest.
203
from tree import EmptyTree
204
from diff import compare_trees
312
206
last_revno = last_revision_id = last_tree = None
313
prev_tree = EmptyTree(branch.get_root_id())
315
207
for revno, revision_id in which_revs:
316
208
this_tree = branch.revision_tree(revision_id)
317
209
this_revision = branch.get_revision(revision_id)
319
211
if not last_revno:
321
last_tree = EmptyTree(branch.get_root_id())
213
last_tree = EmptyTree()
323
215
last_revno = revno - 1
324
216
last_revision_id = branch.revision_history()[last_revno]
334
226
class LogFormatter(object):
335
227
"""Abstract class to display log messages."""
336
def __init__(self, to_file, show_ids=False, show_timezone='original'):
228
def __init__(self, to_file, show_ids=False, show_timezone=False):
337
229
self.to_file = to_file
338
230
self.show_ids = show_ids
339
231
self.show_timezone = show_timezone
342
def show(self, revno, rev, delta):
343
raise NotImplementedError('not implemented in abstract base')
346
238
class LongLogFormatter(LogFormatter):
347
239
def show(self, revno, rev, delta):
348
240
from osutils import format_date
353
245
print >>to_file, 'revno:', revno
354
246
if self.show_ids:
355
247
print >>to_file, 'revision-id:', rev.revision_id
357
for parent_id in rev.parent_ids:
358
print >>to_file, 'parent:', parent_id
360
248
print >>to_file, 'committer:', rev.committer
362
date_str = format_date(rev.timestamp,
365
print >>to_file, 'timestamp: %s' % date_str
249
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
367
252
print >>to_file, 'message:'
368
253
if not rev.message:
374
259
if delta != None:
375
260
delta.show(to_file, self.show_ids)
377
def show_merge(self, rev):
378
from osutils import format_date
380
to_file = self.to_file
384
print >>to_file, indent+'-' * 60
385
print >>to_file, indent+'merged:', rev.revision_id
387
for parent_id in rev.parent_ids:
388
print >>to_file, indent+'parent:', parent_id
390
print >>to_file, indent+'committer:', rev.committer
392
date_str = format_date(rev.timestamp,
395
print >>to_file, indent+'timestamp: %s' % date_str
397
print >>to_file, indent+'message:'
399
print >>to_file, indent+' (no message)'
401
for l in rev.message.split('\n'):
402
print >>to_file, indent+' ' + l
405
264
class ShortLogFormatter(LogFormatter):
420
278
for l in rev.message.split('\n'):
421
279
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
425
281
if delta != None:
426
282
delta.show(to_file, self.show_ids)
429
class LineLogFormatter(LogFormatter):
430
def truncate(self, str, max_len):
431
if len(str) <= max_len:
433
return str[:max_len-3]+'...'
435
def date_string(self, rev):
436
from bzrlib.osutils import format_date
437
return format_date(rev.timestamp, rev.timezone or 0,
438
self.show_timezone, date_fmt="%Y-%m-%d",
441
def message(self, rev):
443
return '(no message)'
447
def short_committer(self, rev):
448
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
450
def show(self, revno, rev, delta):
451
print >> self.to_file, self.log_string(rev, 79)
453
def log_string(self, rev, max_chars):
454
out = [self.truncate(self.short_committer(rev), 20)]
455
out.append(self.date_string(rev))
456
out.append(self.message(rev).replace('\n', ' '))
457
return self.truncate(" ".join(out).rstrip('\n'), max_chars)
459
def line_log(rev, max_chars):
460
lf = LineLogFormatter(None)
461
return lf.log_string(rev, max_chars)
463
287
FORMATTERS = {'long': LongLogFormatter,
464
288
'short': ShortLogFormatter,
465
'line': LineLogFormatter,
469
292
def log_formatter(name, *args, **kwargs):
470
"""Construct a formatter from arguments.
472
name -- Name of the formatter to construct; currently 'long', 'short' and
473
'line' are supported.
475
293
from bzrlib.errors import BzrCommandError
477
296
return FORMATTERS[name](*args, **kwargs)
478
297
except IndexError:
479
298
raise BzrCommandError("unknown log formatter: %r" % name)
481
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
482
# deprecated; for compatability
483
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
484
lf.show(revno, rev, delta)
added
removed
bzrlib/log.py
