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
from bzrlib.tree import EmptyTree
54
from bzrlib.delta import compare_trees
55
from bzrlib.trace import mutter
56
from bzrlib.errors import InvalidRevisionNumber
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))
86
113
def show_log(branch,
88
115
specific_fileid=None,
90
117
direction='reverse',
91
118
start_revision=None,
93
121
"""Write out human-readable log of commits to this branch.
124
152
if specific_fileid:
125
153
mutter('get log for file_id %r' % specific_fileid)
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:
155
if search is not None:
157
searchRE = re.compile(search, re.IGNORECASE)
161
which_revs = _enumerate_history(branch)
163
if start_revision is None:
165
elif start_revision < 1 or start_revision >= len(which_revs):
166
raise InvalidRevisionNumber(start_revision)
168
if end_revision is None:
169
end_revision = len(which_revs)
170
elif end_revision < 1 or end_revision >= len(which_revs):
171
raise InvalidRevisionNumber(end_revision)
173
# list indexes are 0-based; revisions are 1-based
174
cut_revs = which_revs[(start_revision-1):(end_revision)]
176
if direction == 'reverse':
178
elif direction == 'forward':
181
raise ValueError('invalid direction %r' % direction)
183
for revno, rev_id in cut_revs:
184
if verbose or specific_fileid:
185
delta = branch.get_revision_delta(revno)
141
187
if specific_fileid:
142
188
if not delta.touches_file_id(specific_fileid):
146
192
# although we calculated it, throw it away without display
195
rev = branch.get_revision(rev_id)
198
if not searchRE.search(rev.message):
149
201
lf.show(revno, rev, delta)
153
205
def deltas_for_log_dummy(branch, which_revs):
206
"""Return all the revisions without intermediate deltas.
208
Useful for log commands that won't need the delta information.
154
211
for revno, revision_id in which_revs:
155
212
yield revno, branch.get_revision(revision_id), None
158
215
def deltas_for_log_reverse(branch, which_revs):
159
"""Compute deltas for display in reverse log.
161
Given a sequence of (revno, revision_id) pairs, return
216
"""Compute deltas for display in latest-to-earliest order.
222
Sequence of (revno, revision_id) for the subset of history to examine
225
Sequence of (revno, rev, delta)
164
227
The delta is from the given revision to the next one in the
165
228
sequence, which makes sense if the log is being displayed from
166
229
newest to oldest.
168
from tree import EmptyTree
169
from diff import compare_trees
171
231
last_revno = last_revision_id = last_tree = None
172
232
for revno, revision_id in which_revs:
173
233
this_tree = branch.revision_tree(revision_id)
177
237
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
239
this_tree = EmptyTree(branch.get_root_id())
179
241
last_revno = revno
180
242
last_revision = this_revision
181
243
last_tree = this_tree
184
246
if last_revno == 1:
185
this_tree = EmptyTree()
247
this_tree = EmptyTree(branch.get_root_id())
187
249
this_revno = last_revno - 1
188
250
this_revision_id = branch.revision_history()[this_revno]
200
262
sequence, which makes sense if the log is being displayed from
201
263
newest to oldest.
203
from tree import EmptyTree
204
from diff import compare_trees
206
265
last_revno = last_revision_id = last_tree = None
266
prev_tree = EmptyTree(branch.get_root_id())
207
268
for revno, revision_id in which_revs:
208
269
this_tree = branch.revision_tree(revision_id)
209
270
this_revision = branch.get_revision(revision_id)
211
272
if not last_revno:
213
last_tree = EmptyTree()
274
last_tree = EmptyTree(branch.get_root_id())
215
276
last_revno = revno - 1
216
277
last_revision_id = branch.revision_history()[last_revno]
226
287
class LogFormatter(object):
227
288
"""Abstract class to display log messages."""
228
def __init__(self, to_file, show_ids=False, show_timezone=False):
289
def __init__(self, to_file, show_ids=False, show_timezone='original'):
229
290
self.to_file = to_file
230
291
self.show_ids = show_ids
231
292
self.show_timezone = show_timezone
295
def show(self, revno, rev, delta):
296
raise NotImplementedError('not implemented in abstract base')
246
311
if self.show_ids:
247
312
print >>to_file, 'revision-id:', rev.revision_id
248
313
print >>to_file, 'committer:', rev.committer
249
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
315
date_str = format_date(rev.timestamp,
318
print >>to_file, 'timestamp: %s' % date_str
252
320
print >>to_file, 'message:'
253
321
if not rev.message:
278
346
for l in rev.message.split('\n'):
279
347
print >>to_file, ' ' + l
349
# TODO: Why not show the modified files in a shorter form as
350
# well? rewrap them single lines of appropriate length
281
351
if delta != None:
282
352
delta.show(to_file, self.show_ids)
296
366
return FORMATTERS[name](*args, **kwargs)
297
367
except IndexError:
298
368
raise BzrCommandError("unknown log formatter: %r" % name)
370
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
371
# deprecated; for compatability
372
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
373
lf.show(revno, rev, delta)
added
removed
bzrlib/log.py
