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
* 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
39
from trace import mutter
41
def find_touching_revisions(branch, file_id):
42
"""Yield a description of revisions which affect the file_id.
44
Each returned element is (revno, revision_id, description)
46
This is the list of revisions where the file is either added,
47
modified, renamed or deleted.
49
TODO: Perhaps some way to limit this to only particular revisions,
50
or to traverse a non-mainline set of revisions?
55
for revision_id in branch.revision_history():
56
this_inv = branch.get_revision_inventory(revision_id)
57
if file_id in this_inv:
58
this_ie = this_inv[file_id]
59
this_path = this_inv.id2path(file_id)
61
this_ie = this_path = None
63
# now we know how it was last time, and how it is in this revision.
64
# are those two states effectively the same or not?
66
if not this_ie and not last_ie:
67
# not present in either
69
elif this_ie and not last_ie:
70
yield revno, revision_id, "added " + this_path
71
elif not this_ie and last_ie:
73
yield revno, revision_id, "deleted " + last_path
74
elif this_path != last_path:
75
yield revno, revision_id, ("renamed %s => %s" % (last_path, this_path))
76
elif (this_ie.text_size != last_ie.text_size
77
or this_ie.text_sha1 != last_ie.text_sha1):
78
yield revno, revision_id, "modified " + this_path
93
"""Write out human-readable log of commits to this branch.
96
LogFormatter object to show the output.
99
If true, list only the commits affecting the specified
100
file, rather than all commits.
103
If true show added/changed/deleted/renamed files.
106
'reverse' (default) is latest to earliest;
107
'forward' is earliest to latest.
110
If not None, only show revisions >= start_revision
113
If not None, only show revisions <= end_revision
115
from bzrlib.osutils import format_date
116
from bzrlib.errors import BzrCheckError
117
from bzrlib.textui import show_status
119
from warnings import warn
121
if not isinstance(lf, LogFormatter):
122
warn("not a LogFormatter instance: %r" % lf)
125
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:
142
if not delta.touches_file_id(specific_fileid):
146
# although we calculated it, throw it away without display
149
lf.show(revno, rev, delta)
153
def deltas_for_log_dummy(branch, which_revs):
154
for revno, revision_id in which_revs:
155
yield revno, branch.get_revision(revision_id), None
158
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
164
The delta is from the given revision to the next one in the
165
sequence, which makes sense if the log is being displayed from
168
from tree import EmptyTree
169
from diff import compare_trees
171
last_revno = last_revision_id = last_tree = None
172
for revno, revision_id in which_revs:
173
this_tree = branch.revision_tree(revision_id)
174
this_revision = branch.get_revision(revision_id)
177
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
180
last_revision = this_revision
181
last_tree = this_tree
185
this_tree = EmptyTree()
187
this_revno = last_revno - 1
188
this_revision_id = branch.revision_history()[this_revno]
189
this_tree = branch.revision_tree(this_revision_id)
190
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
193
def deltas_for_log_forward(branch, which_revs):
194
"""Compute deltas for display in forward log.
196
Given a sequence of (revno, revision_id) pairs, return
199
The delta is from the given revision to the next one in the
200
sequence, which makes sense if the log is being displayed from
203
from tree import EmptyTree
204
from diff import compare_trees
206
last_revno = last_revision_id = last_tree = None
207
for revno, revision_id in which_revs:
208
this_tree = branch.revision_tree(revision_id)
209
this_revision = branch.get_revision(revision_id)
213
last_tree = EmptyTree()
215
last_revno = revno - 1
216
last_revision_id = branch.revision_history()[last_revno]
217
last_tree = branch.revision_tree(last_revision_id)
219
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
222
last_revision = this_revision
223
last_tree = this_tree
226
class LogFormatter(object):
227
"""Abstract class to display log messages."""
228
def __init__(self, to_file, show_ids=False, show_timezone=False):
229
self.to_file = to_file
230
self.show_ids = show_ids
231
self.show_timezone = show_timezone
238
class LongLogFormatter(LogFormatter):
239
def show(self, revno, rev, delta):
240
from osutils import format_date
242
to_file = self.to_file
244
print >>to_file, '-' * 60
245
print >>to_file, 'revno:', revno
247
print >>to_file, 'revision-id:', rev.revision_id
248
print >>to_file, 'committer:', rev.committer
249
print >>to_file, 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0,
252
print >>to_file, 'message:'
254
print >>to_file, ' (no message)'
256
for l in rev.message.split('\n'):
257
print >>to_file, ' ' + l
260
delta.show(to_file, self.show_ids)
264
class ShortLogFormatter(LogFormatter):
265
def show(self, revno, rev, delta):
266
from bzrlib.osutils import format_date
268
to_file = self.to_file
270
print >>to_file, "%5d %s\t%s" % (revno, rev.committer,
271
format_date(rev.timestamp, rev.timezone or 0,
274
print >>to_file, ' revision-id:', rev.revision_id
276
print >>to_file, ' (no message)'
278
for l in rev.message.split('\n'):
279
print >>to_file, ' ' + l
282
delta.show(to_file, self.show_ids)
287
FORMATTERS = {'long': LongLogFormatter,
288
'short': ShortLogFormatter,
292
def log_formatter(name, *args, **kwargs):
293
from bzrlib.errors import BzrCommandError
296
return FORMATTERS[name](*args, **kwargs)
298
raise BzrCommandError("unknown log formatter: %r" % name)
added
removed
bzrlib/log.py
