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
from bzrlib.tree import EmptyTree
54
from bzrlib.delta import compare_trees
55
from bzrlib.trace import mutter
39
from trace import mutter
58
41
def find_touching_revisions(branch, file_id):
59
42
"""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)
127
86
def show_log(branch,
129
87
specific_fileid=None,
88
show_timezone='original',
131
92
direction='reverse',
132
93
start_revision=None,
135
95
"""Write out human-readable log of commits to this branch.
138
LogFormatter object to show the output.
141
98
If true, list only the commits affecting the specified
142
99
file, rather than all commits.
102
'original' (committer's timezone),
103
'utc' (universal time), or
104
'local' (local user's timezone)
145
107
If true show added/changed/deleted/renamed files.
110
If true, show revision and file ids.
113
File to send log to; by default stdout.
148
116
'reverse' (default) is latest to earliest;
149
117
'forward' is earliest to latest.
155
123
If not None, only show revisions <= end_revision
157
from bzrlib.osutils import format_date
158
from bzrlib.errors import BzrCheckError
159
from bzrlib.textui import show_status
161
from warnings import warn
125
from osutils import format_date
126
from errors import BzrCheckError
127
from textui import show_status
163
if not isinstance(lf, LogFormatter):
164
warn("not a LogFormatter instance: %r" % lf)
166
130
if specific_fileid:
167
131
mutter('get log for file_id %r' % specific_fileid)
169
if search is not None:
171
searchRE = re.compile(search, re.IGNORECASE)
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)
137
which_revs = branch.enum_history(direction)
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
raise NotImplementedError("sorry, verbose forward logs not done yet")
147
for revno, rev, delta in with_deltas:
201
148
if specific_fileid:
202
149
if not delta.touches_file_id(specific_fileid):
152
if start_revision is not None and revno < start_revision:
155
if end_revision is not None and revno > end_revision:
206
159
# although we calculated it, throw it away without display
209
rev = branch.get_revision(rev_id)
212
if not searchRE.search(rev.message):
215
lf.show(revno, rev, delta)
162
show_one_log(revno, rev, delta, show_ids, to_file, show_timezone)
219
166
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.
225
167
for revno, revision_id in which_revs:
226
168
yield revno, branch.get_revision(revision_id), None
229
171
def deltas_for_log_reverse(branch, which_revs):
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
"""Compute deltas for display in reverse log.
174
Given a sequence of (revno, revision_id) pairs, return
241
177
The delta is from the given revision to the next one in the
242
178
sequence, which makes sense if the log is being displayed from
243
179
newest to oldest.
181
from tree import EmptyTree
182
from diff import compare_trees
245
184
last_revno = last_revision_id = last_tree = None
246
185
for revno, revision_id in which_revs:
247
186
this_tree = branch.revision_tree(revision_id)
251
190
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
253
this_tree = EmptyTree(branch.get_root_id())
255
192
last_revno = revno
256
193
last_revision = this_revision
257
194
last_tree = this_tree
261
this_tree = EmptyTree(branch.get_root_id())
263
this_revno = last_revno - 1
264
this_revision_id = branch.revision_history()[this_revno]
265
this_tree = branch.revision_tree(this_revision_id)
197
this_tree = EmptyTree()
266
198
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
269
def deltas_for_log_forward(branch, which_revs):
270
"""Compute deltas for display in forward log.
272
Given a sequence of (revno, revision_id) pairs, return
275
The delta is from the given revision to the next one in the
276
sequence, which makes sense if the log is being displayed from
279
last_revno = last_revision_id = last_tree = None
280
prev_tree = EmptyTree(branch.get_root_id())
282
for revno, revision_id in which_revs:
283
this_tree = branch.revision_tree(revision_id)
284
this_revision = branch.get_revision(revision_id)
288
last_tree = EmptyTree(branch.get_root_id())
290
last_revno = revno - 1
291
last_revision_id = branch.revision_history()[last_revno]
292
last_tree = branch.revision_tree(last_revision_id)
294
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
297
last_revision = this_revision
298
last_tree = this_tree
301
class LogFormatter(object):
302
"""Abstract class to display log messages."""
303
def __init__(self, to_file, show_ids=False, show_timezone='original'):
304
self.to_file = to_file
305
self.show_ids = show_ids
306
self.show_timezone = show_timezone
309
def show(self, revno, rev, delta):
310
raise NotImplementedError('not implemented in abstract base')
203
def show_one_log(revno, rev, delta, show_ids, to_file, show_timezone):
204
from osutils import format_date
313
class LongLogFormatter(LogFormatter):
314
def show(self, revno, rev, delta):
315
from osutils import format_date
317
to_file = self.to_file
319
print >>to_file, '-' * 60
320
print >>to_file, 'revno:', revno
322
print >>to_file, 'revision-id:', rev.revision_id
324
for parent_id in rev.parent_ids:
325
print >>to_file, 'parent:', parent_id
327
print >>to_file, 'committer:', rev.committer
329
date_str = format_date(rev.timestamp,
332
print >>to_file, 'timestamp: %s' % date_str
334
print >>to_file, 'message:'
336
print >>to_file, ' (no message)'
338
for l in rev.message.split('\n'):
339
print >>to_file, ' ' + l
342
delta.show(to_file, self.show_ids)
346
class ShortLogFormatter(LogFormatter):
347
def show(self, revno, rev, delta):
348
from bzrlib.osutils import format_date
350
to_file = self.to_file
352
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
353
format_date(rev.timestamp, rev.timezone or 0,
356
print >>to_file, ' revision-id:', rev.revision_id
358
print >>to_file, ' (no message)'
360
for l in rev.message.split('\n'):
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
366
delta.show(to_file, self.show_ids)
371
FORMATTERS = {'long': LongLogFormatter,
372
'short': ShortLogFormatter,
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.
382
from bzrlib.errors import BzrCommandError
384
return FORMATTERS[name](*args, **kwargs)
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)
206
print >>to_file, '-' * 60
207
print >>to_file, 'revno:', revno
209
print >>to_file, 'revision-id:', rev.revision_id
210
print >>to_file, 'committer:', rev.committer
211
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
214
print >>to_file, 'message:'
216
print >>to_file, ' (no message)'
218
for l in rev.message.split('\n'):
219
print >>to_file, ' ' + l
222
delta.show(to_file, show_ids)
added
removed
bzrlib/log.py
