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
88
specific_fileid=None,
131
90
direction='reverse',
132
91
start_revision=None,
135
93
"""Write out human-readable log of commits to this branch.
166
124
if specific_fileid:
167
125
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)
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:
201
141
if specific_fileid:
202
142
if not delta.touches_file_id(specific_fileid):
206
146
# although we calculated it, throw it away without display
209
rev = branch.get_revision(rev_id)
212
if not searchRE.search(rev.message):
215
149
lf.show(revno, rev, delta)
219
153
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
154
for revno, revision_id in which_revs:
226
155
yield revno, branch.get_revision(revision_id), None
229
158
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)
159
"""Compute deltas for display in reverse log.
161
Given a sequence of (revno, revision_id) pairs, return
241
164
The delta is from the given revision to the next one in the
242
165
sequence, which makes sense if the log is being displayed from
243
166
newest to oldest.
168
from tree import EmptyTree
169
from diff import compare_trees
245
171
last_revno = last_revision_id = last_tree = None
246
172
for revno, revision_id in which_revs:
247
173
this_tree = branch.revision_tree(revision_id)
251
177
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
253
this_tree = EmptyTree(branch.get_root_id())
255
179
last_revno = revno
256
180
last_revision = this_revision
257
181
last_tree = this_tree
260
184
if last_revno == 1:
261
this_tree = EmptyTree(branch.get_root_id())
185
this_tree = EmptyTree()
263
187
this_revno = last_revno - 1
264
188
this_revision_id = branch.revision_history()[this_revno]
276
200
sequence, which makes sense if the log is being displayed from
277
201
newest to oldest.
203
from tree import EmptyTree
204
from diff import compare_trees
279
206
last_revno = last_revision_id = last_tree = None
280
prev_tree = EmptyTree(branch.get_root_id())
282
207
for revno, revision_id in which_revs:
283
208
this_tree = branch.revision_tree(revision_id)
284
209
this_revision = branch.get_revision(revision_id)
286
211
if not last_revno:
288
last_tree = EmptyTree(branch.get_root_id())
213
last_tree = EmptyTree()
290
215
last_revno = revno - 1
291
216
last_revision_id = branch.revision_history()[last_revno]
301
226
class LogFormatter(object):
302
227
"""Abstract class to display log messages."""
303
def __init__(self, to_file, show_ids=False, show_timezone='original'):
228
def __init__(self, to_file, show_ids=False, show_timezone=False):
304
229
self.to_file = to_file
305
230
self.show_ids = show_ids
306
231
self.show_timezone = show_timezone
309
def show(self, revno, rev, delta):
310
raise NotImplementedError('not implemented in abstract base')
313
238
class LongLogFormatter(LogFormatter):
314
239
def show(self, revno, rev, delta):
315
240
from osutils import format_date
320
245
print >>to_file, 'revno:', revno
321
246
if self.show_ids:
322
247
print >>to_file, 'revision-id:', rev.revision_id
324
for parent_id in rev.parent_ids:
325
print >>to_file, 'parent:', parent_id
327
248
print >>to_file, 'committer:', rev.committer
329
date_str = format_date(rev.timestamp,
332
print >>to_file, 'timestamp: %s' % date_str
249
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
334
252
print >>to_file, 'message:'
335
253
if not rev.message:
360
278
for l in rev.message.split('\n'):
361
279
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
365
281
if delta != None:
366
282
delta.show(to_file, self.show_ids)
376
292
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
293
from bzrlib.errors import BzrCommandError
384
296
return FORMATTERS[name](*args, **kwargs)
385
297
except IndexError:
386
298
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
