1
# Copyright (C) 2005 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Code to show logs of changes.
21
Various flavors of log can be produced:
23
* for one file, or the whole tree, and (not done yet) for
24
files in a given directory
26
* in "verbose" mode with a description of what changed from one
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.
53
from bzrlib.tree import EmptyTree
54
from bzrlib.delta import compare_trees
55
from bzrlib.trace import mutter
58
def find_touching_revisions(branch, file_id):
59
"""Yield a description of revisions which affect the file_id.
61
Each returned element is (revno, revision_id, description)
63
This is the list of revisions where the file is either added,
64
modified, renamed or deleted.
66
TODO: Perhaps some way to limit this to only particular revisions,
67
or to traverse a non-mainline set of revisions?
72
for revision_id in branch.revision_history():
73
this_inv = branch.get_revision_inventory(revision_id)
74
if file_id in this_inv:
75
this_ie = this_inv[file_id]
76
this_path = this_inv.id2path(file_id)
78
this_ie = this_path = None
80
# now we know how it was last time, and how it is in this revision.
81
# are those two states effectively the same or not?
83
if not this_ie and not last_ie:
84
# not present in either
86
elif this_ie and not last_ie:
87
yield revno, revision_id, "added " + this_path
88
elif not this_ie and last_ie:
90
yield revno, revision_id, "deleted " + last_path
91
elif this_path != last_path:
92
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
93
elif (this_ie.text_size != last_ie.text_size
94
or this_ie.text_sha1 != last_ie.text_sha1):
95
yield revno, revision_id, "modified " + this_path
103
def _enumerate_history(branch):
106
for rev_id in branch.revision_history():
107
rh.append((revno, rev_id))
114
specific_fileid=None,
120
"""Write out human-readable log of commits to this branch.
123
LogFormatter object to show the output.
126
If true, list only the commits affecting the specified
127
file, rather than all commits.
130
If true show added/changed/deleted/renamed files.
133
'reverse' (default) is latest to earliest;
134
'forward' is earliest to latest.
137
If not None, only show revisions >= start_revision
140
If not None, only show revisions <= end_revision
142
from bzrlib.osutils import format_date
143
from bzrlib.errors import BzrCheckError
144
from bzrlib.textui import show_status
146
from warnings import warn
148
if not isinstance(lf, LogFormatter):
149
warn("not a LogFormatter instance: %r" % lf)
152
mutter('get log for file_id %r' % specific_fileid)
154
if search is not None:
156
searchRE = re.compile(search, re.IGNORECASE)
160
which_revs = _enumerate_history(branch)
162
if start_revision is None:
165
branch.check_real_revno(start_revision)
167
if end_revision is None:
168
end_revision = len(which_revs)
170
branch.check_real_revno(end_revision)
172
# list indexes are 0-based; revisions are 1-based
173
cut_revs = which_revs[(start_revision-1):(end_revision)]
175
if direction == 'reverse':
177
elif direction == 'forward':
180
raise ValueError('invalid direction %r' % direction)
182
for revno, rev_id in cut_revs:
183
if verbose or specific_fileid:
184
delta = branch.get_revision_delta(revno)
187
if not delta.touches_file_id(specific_fileid):
191
# although we calculated it, throw it away without display
194
rev = branch.get_revision(rev_id)
197
if not searchRE.search(rev.message):
200
lf.show(revno, rev, delta)
204
def deltas_for_log_dummy(branch, which_revs):
205
"""Return all the revisions without intermediate deltas.
207
Useful for log commands that won't need the delta information.
210
for revno, revision_id in which_revs:
211
yield revno, branch.get_revision(revision_id), None
214
def deltas_for_log_reverse(branch, which_revs):
215
"""Compute deltas for display in latest-to-earliest order.
221
Sequence of (revno, revision_id) for the subset of history to examine
224
Sequence of (revno, rev, delta)
226
The delta is from the given revision to the next one in the
227
sequence, which makes sense if the log is being displayed from
230
last_revno = last_revision_id = last_tree = None
231
for revno, revision_id in which_revs:
232
this_tree = branch.revision_tree(revision_id)
233
this_revision = branch.get_revision(revision_id)
236
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
238
this_tree = EmptyTree(branch.get_root_id())
241
last_revision = this_revision
242
last_tree = this_tree
246
this_tree = EmptyTree(branch.get_root_id())
248
this_revno = last_revno - 1
249
this_revision_id = branch.revision_history()[this_revno]
250
this_tree = branch.revision_tree(this_revision_id)
251
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
254
def deltas_for_log_forward(branch, which_revs):
255
"""Compute deltas for display in forward log.
257
Given a sequence of (revno, revision_id) pairs, return
260
The delta is from the given revision to the next one in the
261
sequence, which makes sense if the log is being displayed from
264
last_revno = last_revision_id = last_tree = None
265
prev_tree = EmptyTree(branch.get_root_id())
267
for revno, revision_id in which_revs:
268
this_tree = branch.revision_tree(revision_id)
269
this_revision = branch.get_revision(revision_id)
273
last_tree = EmptyTree(branch.get_root_id())
275
last_revno = revno - 1
276
last_revision_id = branch.revision_history()[last_revno]
277
last_tree = branch.revision_tree(last_revision_id)
279
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
282
last_revision = this_revision
283
last_tree = this_tree
286
class LogFormatter(object):
287
"""Abstract class to display log messages."""
288
def __init__(self, to_file, show_ids=False, show_timezone='original'):
289
self.to_file = to_file
290
self.show_ids = show_ids
291
self.show_timezone = show_timezone
294
def show(self, revno, rev, delta):
295
raise NotImplementedError('not implemented in abstract base')
302
class LongLogFormatter(LogFormatter):
303
def show(self, revno, rev, delta):
304
from osutils import format_date
306
to_file = self.to_file
308
print >>to_file, '-' * 60
309
print >>to_file, 'revno:', revno
311
print >>to_file, 'revision-id:', rev.revision_id
313
for parent_id in rev.parent_ids:
314
print >>to_file, 'parent:', parent_id
316
print >>to_file, 'committer:', rev.committer
318
date_str = format_date(rev.timestamp,
321
print >>to_file, 'timestamp: %s' % date_str
323
print >>to_file, 'message:'
325
print >>to_file, ' (no message)'
327
for l in rev.message.split('\n'):
328
print >>to_file, ' ' + l
331
delta.show(to_file, self.show_ids)
335
class ShortLogFormatter(LogFormatter):
336
def show(self, revno, rev, delta):
337
from bzrlib.osutils import format_date
339
to_file = self.to_file
341
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
342
format_date(rev.timestamp, rev.timezone or 0,
345
print >>to_file, ' revision-id:', rev.revision_id
347
print >>to_file, ' (no message)'
349
for l in rev.message.split('\n'):
350
print >>to_file, ' ' + l
352
# TODO: Why not show the modified files in a shorter form as
353
# well? rewrap them single lines of appropriate length
355
delta.show(to_file, self.show_ids)
360
FORMATTERS = {'long': LongLogFormatter,
361
'short': ShortLogFormatter,
365
def log_formatter(name, *args, **kwargs):
366
from bzrlib.errors import BzrCommandError
369
return FORMATTERS[name](*args, **kwargs)
371
raise BzrCommandError("unknown log formatter: %r" % name)
373
def show_one_log(revno, rev, delta, verbose, to_file, show_timezone):
374
# deprecated; for compatability
375
lf = LongLogFormatter(to_file=to_file, show_timezone=show_timezone)
376
lf.show(revno, rev, delta)
added
removed
bzrlib/log.py
