120
154
direction='reverse',
121
155
start_revision=None,
122
156
end_revision=None,
124
160
"""Write out human-readable log of commits to this branch.
127
LogFormatter object to show the output.
130
If true, list only the commits affecting the specified
131
file, rather than all commits.
134
If true show added/changed/deleted/renamed files.
137
'reverse' (default) is latest to earliest;
138
'forward' is earliest to latest.
141
If not None, only show revisions >= start_revision
144
If not None, only show revisions <= end_revision
148
_show_log(branch, lf, specific_fileid, verbose, direction,
149
start_revision, end_revision, search)
153
def _show_log(branch,
155
specific_fileid=None,
161
"""Worker function for show_log - see show_log."""
162
from bzrlib.osutils import format_date
163
from bzrlib.errors import BzrCheckError
165
from warnings import warn
167
if not isinstance(lf, LogFormatter):
168
warn("not a LogFormatter instance: %r" % lf)
162
This function is being retained for backwards compatibility but
163
should not be extended with new parameters. Use the new Logger class
164
instead, eg. Logger(branch, rqst).show(lf), adding parameters to the
165
make_log_request_dict function.
167
:param lf: The LogFormatter object showing the output.
169
:param specific_fileid: If not None, list only the commits affecting the
170
specified file, rather than all commits.
172
:param verbose: If True show added/changed/deleted/renamed files.
174
:param direction: 'reverse' (default) is latest to earliest; 'forward' is
177
:param start_revision: If not None, only show revisions >= start_revision
179
:param end_revision: If not None, only show revisions <= end_revision
181
:param search: If not None, only show revisions with matching commit
184
:param limit: If set, shows only 'limit' revisions, all revisions are shown
187
:param show_diff: If True, output a diff after each revision.
189
# Convert old-style parameters to new-style parameters
190
if specific_fileid is not None:
191
file_ids = [specific_fileid]
196
delta_type = 'partial'
203
diff_type = 'partial'
209
# Build the request and execute it
210
rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
211
start_revision=start_revision, end_revision=end_revision,
212
limit=limit, message_search=search,
213
delta_type=delta_type, diff_type=diff_type)
214
Logger(branch, rqst).show(lf)
217
# Note: This needs to be kept this in sync with the defaults in
218
# make_log_request_dict() below
219
_DEFAULT_REQUEST_PARAMS = {
220
'direction': 'reverse',
222
'generate_tags': True,
223
'_match_using_deltas': True,
227
def make_log_request_dict(direction='reverse', specific_fileids=None,
228
start_revision=None, end_revision=None, limit=None,
229
message_search=None, levels=1, generate_tags=True, delta_type=None,
230
diff_type=None, _match_using_deltas=True):
231
"""Convenience function for making a logging request dictionary.
233
Using this function may make code slightly safer by ensuring
234
parameters have the correct names. It also provides a reference
235
point for documenting the supported parameters.
237
:param direction: 'reverse' (default) is latest to earliest;
238
'forward' is earliest to latest.
240
:param specific_fileids: If not None, only include revisions
241
affecting the specified files, rather than all revisions.
243
:param start_revision: If not None, only generate
244
revisions >= start_revision
246
:param end_revision: If not None, only generate
247
revisions <= end_revision
249
:param limit: If set, generate only 'limit' revisions, all revisions
250
are shown if None or 0.
252
:param message_search: If not None, only include revisions with
253
matching commit messages
255
:param levels: the number of levels of revisions to
256
generate; 1 for just the mainline; 0 for all levels.
258
:param generate_tags: If True, include tags for matched revisions.
260
:param delta_type: Either 'full', 'partial' or None.
261
'full' means generate the complete delta - adds/deletes/modifies/etc;
262
'partial' means filter the delta using specific_fileids;
263
None means do not generate any delta.
265
:param diff_type: Either 'full', 'partial' or None.
266
'full' means generate the complete diff - adds/deletes/modifies/etc;
267
'partial' means filter the diff using specific_fileids;
268
None means do not generate any diff.
270
:param _match_using_deltas: a private parameter controlling the
271
algorithm used for matching specific_fileids. This parameter
272
may be removed in the future so bzrlib client code should NOT
276
'direction': direction,
277
'specific_fileids': specific_fileids,
278
'start_revision': start_revision,
279
'end_revision': end_revision,
281
'message_search': message_search,
283
'generate_tags': generate_tags,
284
'delta_type': delta_type,
285
'diff_type': diff_type,
286
# Add 'private' attributes for features that may be deprecated
287
'_match_using_deltas': _match_using_deltas,
291
def _apply_log_request_defaults(rqst):
292
"""Apply default values to a request dictionary."""
293
result = _DEFAULT_REQUEST_PARAMS
299
class LogGenerator(object):
300
"""A generator of log revisions."""
302
def iter_log_revisions(self):
303
"""Iterate over LogRevision objects.
305
:return: An iterator yielding LogRevision objects.
307
raise NotImplementedError(self.iter_log_revisions)
310
class Logger(object):
311
"""An object that generates, formats and displays a log."""
313
def __init__(self, branch, rqst):
316
:param branch: the branch to log
317
:param rqst: A dictionary specifying the query parameters.
318
See make_log_request_dict() for supported values.
321
self.rqst = _apply_log_request_defaults(rqst)
326
:param lf: The LogFormatter object to send the output to.
328
if not isinstance(lf, LogFormatter):
329
warn("not a LogFormatter instance: %r" % lf)
331
self.branch.lock_read()
333
if getattr(lf, 'begin_log', None):
336
if getattr(lf, 'end_log', None):
341
def _show_body(self, lf):
342
"""Show the main log output.
344
Subclasses may wish to override this.
346
# Tweak the LogRequest based on what the LogFormatter can handle.
347
# (There's no point generating stuff if the formatter can't display it.)
349
rqst['levels'] = lf.get_levels()
350
if not getattr(lf, 'supports_tags', False):
351
rqst['generate_tags'] = False
352
if not getattr(lf, 'supports_delta', False):
353
rqst['delta_type'] = None
354
if not getattr(lf, 'supports_diff', False):
355
rqst['diff_type'] = None
357
# Find and print the interesting revisions
358
generator = self._generator_factory(self.branch, rqst)
359
for lr in generator.iter_log_revisions():
363
def _generator_factory(self, branch, rqst):
364
"""Make the LogGenerator object to use.
366
Subclasses may wish to override this.
368
return _DefaultLogGenerator(branch, rqst)
371
class _StartNotLinearAncestor(Exception):
372
"""Raised when a start revision is not found walking left-hand history."""
375
class _DefaultLogGenerator(LogGenerator):
376
"""The default generator of log revisions."""
378
def __init__(self, branch, rqst):
381
if rqst.get('generate_tags') and branch.supports_tags():
382
self.rev_tag_dict = branch.tags.get_reverse_tag_dict()
384
self.rev_tag_dict = {}
386
def iter_log_revisions(self):
387
"""Iterate over LogRevision objects.
389
:return: An iterator yielding LogRevision objects.
392
levels = rqst.get('levels')
393
limit = rqst.get('limit')
394
diff_type = rqst.get('diff_type')
396
revision_iterator = self._create_log_revision_iterator()
397
for revs in revision_iterator:
398
for (rev_id, revno, merge_depth), rev, delta in revs:
399
# 0 levels means show everything; merge_depth counts from 0
400
if levels != 0 and merge_depth >= levels:
402
if diff_type is None:
405
diff = self._format_diff(rev, rev_id, diff_type)
406
yield LogRevision(rev, revno, merge_depth, delta,
407
self.rev_tag_dict.get(rev_id), diff)
410
if log_count >= limit:
413
def _format_diff(self, rev, rev_id, diff_type):
414
repo = self.branch.repository
415
if len(rev.parent_ids) == 0:
416
ancestor_id = _mod_revision.NULL_REVISION
418
ancestor_id = rev.parent_ids[0]
419
tree_1 = repo.revision_tree(ancestor_id)
420
tree_2 = repo.revision_tree(rev_id)
421
file_ids = self.rqst.get('specific_fileids')
422
if diff_type == 'partial' and file_ids is not None:
423
specific_files = [tree_2.id2path(id) for id in file_ids]
425
specific_files = None
427
diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
431
def _create_log_revision_iterator(self):
432
"""Create a revision iterator for log.
434
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
437
self.start_rev_id, self.end_rev_id = _get_revision_limits(
438
self.branch, self.rqst.get('start_revision'),
439
self.rqst.get('end_revision'))
440
if self.rqst.get('_match_using_deltas'):
441
return self._log_revision_iterator_using_delta_matching()
443
# We're using the per-file-graph algorithm. This scales really
444
# well but only makes sense if there is a single file and it's
446
file_count = len(self.rqst.get('specific_fileids'))
448
raise BzrError("illegal LogRequest: must match-using-deltas "
449
"when logging %d files" % file_count)
450
return self._log_revision_iterator_using_per_file_graph()
452
def _log_revision_iterator_using_delta_matching(self):
453
# Get the base revisions, filtering by the revision range
455
generate_merge_revisions = rqst.get('levels') != 1
456
delayed_graph_generation = not rqst.get('specific_fileids') and (
457
rqst.get('limit') or self.start_rev_id or self.end_rev_id)
458
view_revisions = _calc_view_revisions(
459
self.branch, self.start_rev_id, self.end_rev_id,
460
rqst.get('direction'),
461
generate_merge_revisions=generate_merge_revisions,
462
delayed_graph_generation=delayed_graph_generation)
464
# Apply the other filters
465
return make_log_rev_iterator(self.branch, view_revisions,
466
rqst.get('delta_type'), rqst.get('message_search'),
467
file_ids=rqst.get('specific_fileids'),
468
direction=rqst.get('direction'))
470
def _log_revision_iterator_using_per_file_graph(self):
471
# Get the base revisions, filtering by the revision range.
472
# Note that we always generate the merge revisions because
473
# filter_revisions_touching_file_id() requires them ...
475
view_revisions = _calc_view_revisions(
476
self.branch, self.start_rev_id, self.end_rev_id,
477
rqst.get('direction'), generate_merge_revisions=True)
478
if not isinstance(view_revisions, list):
479
view_revisions = list(view_revisions)
480
view_revisions = _filter_revisions_touching_file_id(self.branch,
481
rqst.get('specific_fileids')[0], view_revisions,
482
include_merges=rqst.get('levels') != 1)
483
return make_log_rev_iterator(self.branch, view_revisions,
484
rqst.get('delta_type'), rqst.get('message_search'))
487
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
488
generate_merge_revisions, delayed_graph_generation=False):
489
"""Calculate the revisions to view.
491
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
492
a list of the same tuples.
494
if direction not in ('reverse', 'forward'):
495
raise ValueError('invalid direction %r' % direction)
496
br_revno, br_rev_id = branch.last_revision_info()
500
if (end_rev_id and start_rev_id == end_rev_id
501
and (not generate_merge_revisions
502
or not _has_merges(branch, end_rev_id))):
503
# If a single revision is requested, check we can handle it
504
iter_revs = _generate_one_revision(branch, end_rev_id, br_rev_id,
506
elif not generate_merge_revisions:
507
# If we only want to see linear revisions, we can iterate ...
508
iter_revs = _generate_flat_revisions(branch, start_rev_id, end_rev_id,
510
if direction == 'forward':
511
iter_revs = reversed(iter_revs)
513
iter_revs = _generate_all_revisions(branch, start_rev_id, end_rev_id,
514
direction, delayed_graph_generation)
515
if direction == 'forward':
516
iter_revs = _rebase_merge_depth(reverse_by_depth(list(iter_revs)))
520
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
521
if rev_id == br_rev_id:
523
return [(br_rev_id, br_revno, 0)]
525
revno = branch.revision_id_to_dotted_revno(rev_id)
526
revno_str = '.'.join(str(n) for n in revno)
527
return [(rev_id, revno_str, 0)]
530
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
531
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
532
# If a start limit was given and it's not obviously an
533
# ancestor of the end limit, check it before outputting anything
534
if direction == 'forward' or (start_rev_id
535
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
537
result = list(result)
538
except _StartNotLinearAncestor:
539
raise errors.BzrCommandError('Start revision not found in'
540
' left-hand history of end revision.')
544
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
545
delayed_graph_generation):
546
# On large trees, generating the merge graph can take 30-60 seconds
547
# so we delay doing it until a merge is detected, incrementally
548
# returning initial (non-merge) revisions while we can.
550
# The above is only true for old formats (<= 0.92), for newer formats, a
551
# couple of seconds only should be needed to load the whole graph and the
552
# other graph operations needed are even faster than that -- vila 100201
553
initial_revisions = []
554
if delayed_graph_generation:
556
for rev_id, revno, depth in _linear_view_revisions(
557
branch, start_rev_id, end_rev_id):
558
if _has_merges(branch, rev_id):
559
# The end_rev_id can be nested down somewhere. We need an
560
# explicit ancestry check. There is an ambiguity here as we
561
# may not raise _StartNotLinearAncestor for a revision that
562
# is an ancestor but not a *linear* one. But since we have
563
# loaded the graph to do the check (or calculate a dotted
564
# revno), we may as well accept to show the log... We need
565
# the check only if start_rev_id is not None as all
566
# revisions have _mod_revision.NULL_REVISION as an ancestor
568
graph = branch.repository.get_graph()
569
if (start_rev_id is not None
570
and not graph.is_ancestor(start_rev_id, end_rev_id)):
571
raise _StartNotLinearAncestor()
572
# Since we collected the revisions so far, we need to
577
initial_revisions.append((rev_id, revno, depth))
579
# No merged revisions found
580
return initial_revisions
581
except _StartNotLinearAncestor:
582
# A merge was never detected so the lower revision limit can't
583
# be nested down somewhere
584
raise errors.BzrCommandError('Start revision not found in'
585
' history of end revision.')
587
# We exit the loop above because we encounter a revision with merges, from
588
# this revision, we need to switch to _graph_view_revisions.
590
# A log including nested merges is required. If the direction is reverse,
591
# we rebase the initial merge depths so that the development line is
592
# shown naturally, i.e. just like it is for linear logging. We can easily
593
# make forward the exact opposite display, but showing the merge revisions
594
# indented at the end seems slightly nicer in that case.
595
view_revisions = chain(iter(initial_revisions),
596
_graph_view_revisions(branch, start_rev_id, end_rev_id,
597
rebase_initial_depths=(direction == 'reverse')))
598
return view_revisions
601
def _has_merges(branch, rev_id):
602
"""Does a revision have multiple parents or not?"""
603
parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
604
return len(parents) > 1
607
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
608
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
609
if start_rev_id and end_rev_id:
610
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
611
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
612
if len(start_dotted) == 1 and len(end_dotted) == 1:
614
return start_dotted[0] <= end_dotted[0]
615
elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
616
start_dotted[0:1] == end_dotted[0:1]):
617
# both on same development line
618
return start_dotted[2] <= end_dotted[2]
622
# if either start or end is not specified then we use either the first or
623
# the last revision and *they* are obvious ancestors.
627
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
628
"""Calculate a sequence of revisions to view, newest to oldest.
630
:param start_rev_id: the lower revision-id
631
:param end_rev_id: the upper revision-id
632
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
633
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
634
is not found walking the left-hand history
636
br_revno, br_rev_id = branch.last_revision_info()
637
repo = branch.repository
638
if start_rev_id is None and end_rev_id is None:
640
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
641
yield revision_id, str(cur_revno), 0
644
if end_rev_id is None:
645
end_rev_id = br_rev_id
646
found_start = start_rev_id is None
647
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
648
revno = branch.revision_id_to_dotted_revno(revision_id)
649
revno_str = '.'.join(str(n) for n in revno)
650
if not found_start and revision_id == start_rev_id:
651
yield revision_id, revno_str, 0
655
yield revision_id, revno_str, 0
658
raise _StartNotLinearAncestor()
661
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
662
rebase_initial_depths=True):
663
"""Calculate revisions to view including merges, newest to oldest.
665
:param branch: the branch
666
:param start_rev_id: the lower revision-id
667
:param end_rev_id: the upper revision-id
668
:param rebase_initial_depth: should depths be rebased until a mainline
670
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
672
view_revisions = branch.iter_merge_sorted_revisions(
673
start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
674
stop_rule="with-merges")
675
if not rebase_initial_depths:
676
for (rev_id, merge_depth, revno, end_of_merge
678
yield rev_id, '.'.join(map(str, revno)), merge_depth
680
# We're following a development line starting at a merged revision.
681
# We need to adjust depths down by the initial depth until we find
682
# a depth less than it. Then we use that depth as the adjustment.
683
# If and when we reach the mainline, depth adjustment ends.
684
depth_adjustment = None
685
for (rev_id, merge_depth, revno, end_of_merge
687
if depth_adjustment is None:
688
depth_adjustment = merge_depth
690
if merge_depth < depth_adjustment:
691
# From now on we reduce the depth adjustement, this can be
692
# surprising for users. The alternative requires two passes
693
# which breaks the fast display of the first revision
695
depth_adjustment = merge_depth
696
merge_depth -= depth_adjustment
697
yield rev_id, '.'.join(map(str, revno)), merge_depth
700
@deprecated_function(deprecated_in((2, 2, 0)))
701
def calculate_view_revisions(branch, start_revision, end_revision, direction,
702
specific_fileid, generate_merge_revisions):
703
"""Calculate the revisions to view.
705
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
706
a list of the same tuples.
708
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
710
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
711
direction, generate_merge_revisions or specific_fileid))
170
712
if specific_fileid:
171
mutter('get log for file_id %r', specific_fileid)
173
if search is not None:
175
searchRE = re.compile(search, re.IGNORECASE)
179
which_revs = _enumerate_history(branch)
181
if start_revision is None:
184
branch.check_real_revno(start_revision)
186
if end_revision is None:
187
end_revision = len(which_revs)
189
branch.check_real_revno(end_revision)
191
# list indexes are 0-based; revisions are 1-based
192
cut_revs = which_revs[(start_revision-1):(end_revision)]
196
# convert the revision history to a dictionary:
197
rev_nos = dict((k, v) for v, k in cut_revs)
713
view_revisions = _filter_revisions_touching_file_id(branch,
714
specific_fileid, view_revisions,
715
include_merges=generate_merge_revisions)
716
return _rebase_merge_depth(view_revisions)
719
def _rebase_merge_depth(view_revisions):
720
"""Adjust depths upwards so the top level is 0."""
721
# If either the first or last revision have a merge_depth of 0, we're done
722
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
723
min_depth = min([d for r,n,d in view_revisions])
725
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
726
return view_revisions
729
def make_log_rev_iterator(branch, view_revisions, generate_delta, search,
730
file_ids=None, direction='reverse'):
731
"""Create a revision iterator for log.
733
:param branch: The branch being logged.
734
:param view_revisions: The revisions being viewed.
735
:param generate_delta: Whether to generate a delta for each revision.
736
Permitted values are None, 'full' and 'partial'.
737
:param search: A user text search string.
738
:param file_ids: If non empty, only revisions matching one or more of
739
the file-ids are to be kept.
740
:param direction: the direction in which view_revisions is sorted
741
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
744
# Convert view_revisions into (view, None, None) groups to fit with
745
# the standard interface here.
746
if type(view_revisions) == list:
747
# A single batch conversion is faster than many incremental ones.
748
# As we have all the data, do a batch conversion.
749
nones = [None] * len(view_revisions)
750
log_rev_iterator = iter([zip(view_revisions, nones, nones)])
753
for view in view_revisions:
754
yield (view, None, None)
755
log_rev_iterator = iter([_convert()])
756
for adapter in log_adapters:
757
# It would be nicer if log adapters were first class objects
758
# with custom parameters. This will do for now. IGC 20090127
759
if adapter == _make_delta_filter:
760
log_rev_iterator = adapter(branch, generate_delta,
761
search, log_rev_iterator, file_ids, direction)
763
log_rev_iterator = adapter(branch, generate_delta,
764
search, log_rev_iterator)
765
return log_rev_iterator
768
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
769
"""Create a filtered iterator of log_rev_iterator matching on a regex.
771
:param branch: The branch being logged.
772
:param generate_delta: Whether to generate a delta for each revision.
773
:param search: A user text search string.
774
:param log_rev_iterator: An input iterator containing all revisions that
775
could be displayed, in lists.
776
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
780
return log_rev_iterator
781
searchRE = re_compile_checked(search, re.IGNORECASE,
782
'log message filter')
783
return _filter_message_re(searchRE, log_rev_iterator)
786
def _filter_message_re(searchRE, log_rev_iterator):
787
for revs in log_rev_iterator:
789
for (rev_id, revno, merge_depth), rev, delta in revs:
790
if searchRE.search(rev.message):
791
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
795
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
796
fileids=None, direction='reverse'):
797
"""Add revision deltas to a log iterator if needed.
799
:param branch: The branch being logged.
800
:param generate_delta: Whether to generate a delta for each revision.
801
Permitted values are None, 'full' and 'partial'.
802
:param search: A user text search string.
803
:param log_rev_iterator: An input iterator containing all revisions that
804
could be displayed, in lists.
805
:param fileids: If non empty, only revisions matching one or more of
806
the file-ids are to be kept.
807
:param direction: the direction in which view_revisions is sorted
808
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
811
if not generate_delta and not fileids:
812
return log_rev_iterator
813
return _generate_deltas(branch.repository, log_rev_iterator,
814
generate_delta, fileids, direction)
817
def _generate_deltas(repository, log_rev_iterator, delta_type, fileids,
819
"""Create deltas for each batch of revisions in log_rev_iterator.
821
If we're only generating deltas for the sake of filtering against
822
file-ids, we stop generating deltas once all file-ids reach the
823
appropriate life-cycle point. If we're receiving data newest to
824
oldest, then that life-cycle point is 'add', otherwise it's 'remove'.
826
check_fileids = fileids is not None and len(fileids) > 0
828
fileid_set = set(fileids)
829
if direction == 'reverse':
835
for revs in log_rev_iterator:
836
# If we were matching against fileids and we've run out,
837
# there's nothing left to do
838
if check_fileids and not fileid_set:
840
revisions = [rev[1] for rev in revs]
842
if delta_type == 'full' and not check_fileids:
843
deltas = repository.get_deltas_for_revisions(revisions)
844
for rev, delta in izip(revs, deltas):
845
new_revs.append((rev[0], rev[1], delta))
847
deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
848
for rev, delta in izip(revs, deltas):
850
if delta is None or not delta.has_changed():
853
_update_fileids(delta, fileid_set, stop_on)
854
if delta_type is None:
856
elif delta_type == 'full':
857
# If the file matches all the time, rebuilding
858
# a full delta like this in addition to a partial
859
# one could be slow. However, it's likely that
860
# most revisions won't get this far, making it
861
# faster to filter on the partial deltas and
862
# build the occasional full delta than always
863
# building full deltas and filtering those.
865
delta = repository.get_revision_delta(rev_id)
866
new_revs.append((rev[0], rev[1], delta))
870
def _update_fileids(delta, fileids, stop_on):
871
"""Update the set of file-ids to search based on file lifecycle events.
873
:param fileids: a set of fileids to update
874
:param stop_on: either 'add' or 'remove' - take file-ids out of the
875
fileids set once their add or remove entry is detected respectively
878
for item in delta.added:
879
if item[1] in fileids:
880
fileids.remove(item[1])
881
elif stop_on == 'delete':
882
for item in delta.removed:
883
if item[1] in fileids:
884
fileids.remove(item[1])
887
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
888
"""Extract revision objects from the repository
890
:param branch: The branch being logged.
891
:param generate_delta: Whether to generate a delta for each revision.
892
:param search: A user text search string.
893
:param log_rev_iterator: An input iterator containing all revisions that
894
could be displayed, in lists.
895
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
898
repository = branch.repository
899
for revs in log_rev_iterator:
900
# r = revision_id, n = revno, d = merge depth
901
revision_ids = [view[0] for view, _, _ in revs]
902
revisions = repository.get_revisions(revision_ids)
903
revs = [(rev[0], revision, rev[2]) for rev, revision in
904
izip(revs, revisions)]
908
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
909
"""Group up a single large batch into smaller ones.
911
:param branch: The branch being logged.
912
:param generate_delta: Whether to generate a delta for each revision.
913
:param search: A user text search string.
914
:param log_rev_iterator: An input iterator containing all revisions that
915
could be displayed, in lists.
916
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
919
repository = branch.repository
921
for batch in log_rev_iterator:
924
step = [detail for _, detail in zip(range(num), batch)]
928
num = min(int(num * 1.5), 200)
931
def _get_revision_limits(branch, start_revision, end_revision):
932
"""Get and check revision limits.
934
:param branch: The branch containing the revisions.
936
:param start_revision: The first revision to be logged.
937
For backwards compatibility this may be a mainline integer revno,
938
but for merge revision support a RevisionInfo is expected.
940
:param end_revision: The last revision to be logged.
941
For backwards compatibility this may be a mainline integer revno,
942
but for merge revision support a RevisionInfo is expected.
944
:return: (start_rev_id, end_rev_id) tuple.
946
branch_revno, branch_rev_id = branch.last_revision_info()
948
if start_revision is None:
951
if isinstance(start_revision, revisionspec.RevisionInfo):
952
start_rev_id = start_revision.rev_id
953
start_revno = start_revision.revno or 1
955
branch.check_real_revno(start_revision)
956
start_revno = start_revision
957
start_rev_id = branch.get_rev_id(start_revno)
960
if end_revision is None:
961
end_revno = branch_revno
963
if isinstance(end_revision, revisionspec.RevisionInfo):
964
end_rev_id = end_revision.rev_id
965
end_revno = end_revision.revno or branch_revno
967
branch.check_real_revno(end_revision)
968
end_revno = end_revision
969
end_rev_id = branch.get_rev_id(end_revno)
971
if branch_revno != 0:
972
if (start_rev_id == _mod_revision.NULL_REVISION
973
or end_rev_id == _mod_revision.NULL_REVISION):
974
raise errors.BzrCommandError('Logging revision 0 is invalid.')
975
if start_revno > end_revno:
976
raise errors.BzrCommandError("Start revision must be older than "
978
return (start_rev_id, end_rev_id)
981
def _get_mainline_revs(branch, start_revision, end_revision):
982
"""Get the mainline revisions from the branch.
984
Generates the list of mainline revisions for the branch.
986
:param branch: The branch containing the revisions.
988
:param start_revision: The first revision to be logged.
989
For backwards compatibility this may be a mainline integer revno,
990
but for merge revision support a RevisionInfo is expected.
992
:param end_revision: The last revision to be logged.
993
For backwards compatibility this may be a mainline integer revno,
994
but for merge revision support a RevisionInfo is expected.
996
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
998
branch_revno, branch_last_revision = branch.last_revision_info()
999
if branch_revno == 0:
1000
return None, None, None, None
1002
# For mainline generation, map start_revision and end_revision to
1003
# mainline revnos. If the revision is not on the mainline choose the
1004
# appropriate extreme of the mainline instead - the extra will be
1006
# Also map the revisions to rev_ids, to be used in the later filtering
1009
if start_revision is None:
1012
if isinstance(start_revision, revisionspec.RevisionInfo):
1013
start_rev_id = start_revision.rev_id
1014
start_revno = start_revision.revno or 1
1016
branch.check_real_revno(start_revision)
1017
start_revno = start_revision
1020
if end_revision is None:
1021
end_revno = branch_revno
1023
if isinstance(end_revision, revisionspec.RevisionInfo):
1024
end_rev_id = end_revision.rev_id
1025
end_revno = end_revision.revno or branch_revno
1027
branch.check_real_revno(end_revision)
1028
end_revno = end_revision
1030
if ((start_rev_id == _mod_revision.NULL_REVISION)
1031
or (end_rev_id == _mod_revision.NULL_REVISION)):
1032
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1033
if start_revno > end_revno:
1034
raise errors.BzrCommandError("Start revision must be older than "
1035
"the end revision.")
1037
if end_revno < start_revno:
1038
return None, None, None, None
1039
cur_revno = branch_revno
1042
for revision_id in branch.repository.iter_reverse_revision_history(
1043
branch_last_revision):
1044
if cur_revno < start_revno:
1045
# We have gone far enough, but we always add 1 more revision
1046
rev_nos[revision_id] = cur_revno
1047
mainline_revs.append(revision_id)
1049
if cur_revno <= end_revno:
1050
rev_nos[revision_id] = cur_revno
1051
mainline_revs.append(revision_id)
1054
# We walked off the edge of all revisions, so we add a 'None' marker
1055
mainline_revs.append(None)
1057
mainline_revs.reverse()
199
1059
# override the mainline to look like the revision history.
200
mainline_revs = [revision_id for index, revision_id in cut_revs]
201
if cut_revs[0][0] == 1:
202
mainline_revs.insert(0, None)
204
mainline_revs.insert(0, which_revs[start_revision-2][1])
205
if getattr(lf, 'show_merge', None) is not None:
206
include_merges = True
208
include_merges = False
209
view_revisions = list(get_view_revisions(mainline_revs, rev_nos, branch,
210
direction, include_merges=include_merges))
212
def iter_revisions():
213
# r = revision, n = revno, d = merge depth
1060
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1063
@deprecated_function(deprecated_in((2, 2, 0)))
1064
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1065
"""Filter view_revisions based on revision ranges.
1067
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1068
tuples to be filtered.
1070
:param start_rev_id: If not NONE specifies the first revision to be logged.
1071
If NONE then all revisions up to the end_rev_id are logged.
1073
:param end_rev_id: If not NONE specifies the last revision to be logged.
1074
If NONE then all revisions up to the end of the log are logged.
1076
:return: The filtered view_revisions.
1078
if start_rev_id or end_rev_id:
214
1079
revision_ids = [r for r, n, d in view_revisions]
215
zeros = set(r for r, n, d in view_revisions if d == 0)
217
repository = branch.repository
220
revisions = repository.get_revisions(revision_ids[:num])
221
if verbose or specific_fileid:
222
delta_revisions = [r for r in revisions if
223
r.revision_id in zeros]
224
deltas = repository.get_deltas_for_revisions(delta_revisions)
225
cur_deltas = dict(izip((r.revision_id for r in
226
delta_revisions), deltas))
227
for revision in revisions:
228
# The delta value will be None unless
229
# 1. verbose or specific_fileid is specified, and
230
# 2. the revision is a mainline revision
231
yield revision, cur_deltas.get(revision.revision_id)
232
revision_ids = revision_ids[num:]
235
# now we just print all the revisions
236
for ((rev_id, revno, merge_depth), (rev, delta)) in \
237
izip(view_revisions, iter_revisions()):
240
if not searchRE.search(rev.message):
244
# a mainline revision.
247
if not delta.touches_file_id(specific_fileid):
251
# although we calculated it, throw it away without display
254
lf.show(revno, rev, delta)
256
lf.show_merge(rev, merge_depth)
1081
start_index = revision_ids.index(start_rev_id)
1084
if start_rev_id == end_rev_id:
1085
end_index = start_index
1088
end_index = revision_ids.index(end_rev_id)
1090
end_index = len(view_revisions) - 1
1091
# To include the revisions merged into the last revision,
1092
# extend end_rev_id down to, but not including, the next rev
1093
# with the same or lesser merge_depth
1094
end_merge_depth = view_revisions[end_index][2]
1096
for index in xrange(end_index+1, len(view_revisions)+1):
1097
if view_revisions[index][2] <= end_merge_depth:
1098
end_index = index - 1
1101
# if the search falls off the end then log to the end as well
1102
end_index = len(view_revisions) - 1
1103
view_revisions = view_revisions[start_index:end_index+1]
1104
return view_revisions
1107
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1108
include_merges=True):
1109
r"""Return the list of revision ids which touch a given file id.
1111
The function filters view_revisions and returns a subset.
1112
This includes the revisions which directly change the file id,
1113
and the revisions which merge these changes. So if the
1125
And 'C' changes a file, then both C and D will be returned. F will not be
1126
returned even though it brings the changes to C into the branch starting
1127
with E. (Note that if we were using F as the tip instead of G, then we
1130
This will also be restricted based on a subset of the mainline.
1132
:param branch: The branch where we can get text revision information.
1134
:param file_id: Filter out revisions that do not touch file_id.
1136
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1137
tuples. This is the list of revisions which will be filtered. It is
1138
assumed that view_revisions is in merge_sort order (i.e. newest
1141
:param include_merges: include merge revisions in the result or not
1143
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
1145
# Lookup all possible text keys to determine which ones actually modified
1147
text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1149
# Looking up keys in batches of 1000 can cut the time in half, as well as
1150
# memory consumption. GraphIndex *does* like to look for a few keys in
1151
# parallel, it just doesn't like looking for *lots* of keys in parallel.
1152
# TODO: This code needs to be re-evaluated periodically as we tune the
1153
# indexing layer. We might consider passing in hints as to the known
1154
# access pattern (sparse/clustered, high success rate/low success
1155
# rate). This particular access is clustered with a low success rate.
1156
get_parent_map = branch.repository.texts.get_parent_map
1157
modified_text_revisions = set()
1159
for start in xrange(0, len(text_keys), chunk_size):
1160
next_keys = text_keys[start:start + chunk_size]
1161
# Only keep the revision_id portion of the key
1162
modified_text_revisions.update(
1163
[k[1] for k in get_parent_map(next_keys)])
1164
del text_keys, next_keys
1167
# Track what revisions will merge the current revision, replace entries
1168
# with 'None' when they have been added to result
1169
current_merge_stack = [None]
1170
for info in view_revisions:
1171
rev_id, revno, depth = info
1172
if depth == len(current_merge_stack):
1173
current_merge_stack.append(info)
1175
del current_merge_stack[depth + 1:]
1176
current_merge_stack[-1] = info
1178
if rev_id in modified_text_revisions:
1179
# This needs to be logged, along with the extra revisions
1180
for idx in xrange(len(current_merge_stack)):
1181
node = current_merge_stack[idx]
1182
if node is not None:
1183
if include_merges or node[2] == 0:
1185
current_merge_stack[idx] = None
1189
@deprecated_function(deprecated_in((2, 2, 0)))
259
1190
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
260
1191
include_merges=True):
261
1192
"""Produce an iterator of revisions to show
262
1193
:return: an iterator of (revision_id, revno, merge_depth)
263
1194
(if there is no revno for a revision, None is supplied)
265
if include_merges is False:
1196
if not include_merges:
266
1197
revision_ids = mainline_revs[1:]
267
1198
if direction == 'reverse':
268
1199
revision_ids.reverse()
269
1200
for revision_id in revision_ids:
270
yield revision_id, rev_nos[revision_id], 0
1201
yield revision_id, str(rev_nos[revision_id]), 0
272
merge_sorted_revisions = merge_sort(
273
branch.repository.get_revision_graph(mainline_revs[-1]),
1203
graph = branch.repository.get_graph()
1204
# This asks for all mainline revisions, which means we only have to spider
1205
# sideways, rather than depth history. That said, its still size-of-history
1206
# and should be addressed.
1207
# mainline_revisions always includes an extra revision at the beginning, so
1209
parent_map = dict(((key, value) for key, value in
1210
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1211
# filter out ghosts; merge_sort errors on ghosts.
1212
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1213
merge_sorted_revisions = tsort.merge_sort(
274
1215
mainline_revs[-1],
1217
generate_revno=True)
277
1219
if direction == 'forward':
278
1220
# forward means oldest first.
293
1234
revision of that depth. There may be no topological justification for this,
294
1235
but it looks much nicer.
1237
# Add a fake revision at start so that we can always attach sub revisions
1238
merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
296
1239
zd_revisions = []
297
1240
for val in merge_sorted_revisions:
298
1241
if val[2] == _depth:
1242
# Each revision at the current depth becomes a chunk grouping all
1243
# higher depth revisions.
299
1244
zd_revisions.append([val])
301
assert val[2] > _depth
302
1246
zd_revisions[-1].append(val)
303
1247
for revisions in zd_revisions:
304
1248
if len(revisions) > 1:
1249
# We have higher depth revisions, let reverse them locally
305
1250
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
306
1251
zd_revisions.reverse()
308
1253
for chunk in zd_revisions:
309
1254
result.extend(chunk)
1256
# Top level call, get rid of the fake revisions that have been added
1257
result = [r for r in result if r[0] is not None and r[1] is not None]
1261
class LogRevision(object):
1262
"""A revision to be logged (by LogFormatter.log_revision).
1264
A simple wrapper for the attributes of a revision to be logged.
1265
The attributes may or may not be populated, as determined by the
1266
logging options and the log formatter capabilities.
1269
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1270
tags=None, diff=None):
1272
self.revno = str(revno)
1273
self.merge_depth = merge_depth
313
1279
class LogFormatter(object):
314
"""Abstract class to display log messages."""
316
def __init__(self, to_file, show_ids=False, show_timezone='original'):
1280
"""Abstract class to display log messages.
1282
At a minimum, a derived class must implement the log_revision method.
1284
If the LogFormatter needs to be informed of the beginning or end of
1285
a log it should implement the begin_log and/or end_log hook methods.
1287
A LogFormatter should define the following supports_XXX flags
1288
to indicate which LogRevision attributes it supports:
1290
- supports_delta must be True if this log formatter supports delta.
1291
Otherwise the delta attribute may not be populated. The 'delta_format'
1292
attribute describes whether the 'short_status' format (1) or the long
1293
one (2) should be used.
1295
- supports_merge_revisions must be True if this log formatter supports
1296
merge revisions. If not, then only mainline revisions will be passed
1299
- preferred_levels is the number of levels this formatter defaults to.
1300
The default value is zero meaning display all levels.
1301
This value is only relevant if supports_merge_revisions is True.
1303
- supports_tags must be True if this log formatter supports tags.
1304
Otherwise the tags attribute may not be populated.
1306
- supports_diff must be True if this log formatter supports diffs.
1307
Otherwise the diff attribute may not be populated.
1309
Plugins can register functions to show custom revision properties using
1310
the properties_handler_registry. The registered function
1311
must respect the following interface description:
1312
def my_show_properties(properties_dict):
1313
# code that returns a dict {'name':'value'} of the properties
1316
preferred_levels = 0
1318
def __init__(self, to_file, show_ids=False, show_timezone='original',
1319
delta_format=None, levels=None, show_advice=False,
1320
to_exact_file=None):
1321
"""Create a LogFormatter.
1323
:param to_file: the file to output to
1324
:param to_exact_file: if set, gives an output stream to which
1325
non-Unicode diffs are written.
1326
:param show_ids: if True, revision-ids are to be displayed
1327
:param show_timezone: the timezone to use
1328
:param delta_format: the level of delta information to display
1329
or None to leave it to the formatter to decide
1330
:param levels: the number of levels to display; None or -1 to
1331
let the log formatter decide.
1332
:param show_advice: whether to show advice at the end of the
317
1335
self.to_file = to_file
1336
# 'exact' stream used to show diff, it should print content 'as is'
1337
# and should not try to decode/encode it to unicode to avoid bug #328007
1338
if to_exact_file is not None:
1339
self.to_exact_file = to_exact_file
1341
# XXX: somewhat hacky; this assumes it's a codec writer; it's better
1342
# for code that expects to get diffs to pass in the exact file
1344
self.to_exact_file = getattr(to_file, 'stream', to_file)
318
1345
self.show_ids = show_ids
319
1346
self.show_timezone = show_timezone
321
def show(self, revno, rev, delta):
1347
if delta_format is None:
1348
# Ensures backward compatibility
1349
delta_format = 2 # long format
1350
self.delta_format = delta_format
1351
self.levels = levels
1352
self._show_advice = show_advice
1353
self._merge_count = 0
1355
def get_levels(self):
1356
"""Get the number of levels to display or 0 for all."""
1357
if getattr(self, 'supports_merge_revisions', False):
1358
if self.levels is None or self.levels == -1:
1359
self.levels = self.preferred_levels
1364
def log_revision(self, revision):
1367
:param revision: The LogRevision to be logged.
322
1369
raise NotImplementedError('not implemented in abstract base')
1371
def show_advice(self):
1372
"""Output user advice, if any, when the log is completed."""
1373
if self._show_advice and self.levels == 1 and self._merge_count > 0:
1374
advice_sep = self.get_advice_separator()
1376
self.to_file.write(advice_sep)
1378
"Use --include-merges or -n0 to see merged revisions.\n")
1380
def get_advice_separator(self):
1381
"""Get the text separating the log from the closing advice."""
324
1384
def short_committer(self, rev):
325
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
1385
name, address = config.parse_username(rev.committer)
1390
def short_author(self, rev):
1391
name, address = config.parse_username(rev.get_apparent_authors()[0])
1396
def merge_marker(self, revision):
1397
"""Get the merge marker to include in the output or '' if none."""
1398
if len(revision.rev.parent_ids) > 1:
1399
self._merge_count += 1
1404
def show_properties(self, revision, indent):
1405
"""Displays the custom properties returned by each registered handler.
1407
If a registered handler raises an error it is propagated.
1409
for line in self.custom_properties(revision):
1410
self.to_file.write("%s%s\n" % (indent, line))
1412
def custom_properties(self, revision):
1413
"""Format the custom properties returned by each registered handler.
1415
If a registered handler raises an error it is propagated.
1417
:return: a list of formatted lines (excluding trailing newlines)
1419
lines = self._foreign_info_properties(revision)
1420
for key, handler in properties_handler_registry.iteritems():
1421
lines.extend(self._format_properties(handler(revision)))
1424
def _foreign_info_properties(self, rev):
1425
"""Custom log displayer for foreign revision identifiers.
1427
:param rev: Revision object.
1429
# Revision comes directly from a foreign repository
1430
if isinstance(rev, foreign.ForeignRevision):
1431
return self._format_properties(
1432
rev.mapping.vcs.show_foreign_revid(rev.foreign_revid))
1434
# Imported foreign revision revision ids always contain :
1435
if not ":" in rev.revision_id:
1438
# Revision was once imported from a foreign repository
1440
foreign_revid, mapping = \
1441
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1442
except errors.InvalidRevisionId:
1445
return self._format_properties(
1446
mapping.vcs.show_foreign_revid(foreign_revid))
1448
def _format_properties(self, properties):
1450
for key, value in properties.items():
1451
lines.append(key + ': ' + value)
1454
def show_diff(self, to_file, diff, indent):
1455
for l in diff.rstrip().split('\n'):
1456
to_file.write(indent + '%s\n' % (l,))
1459
# Separator between revisions in long format
1460
_LONG_SEP = '-' * 60
328
1463
class LongLogFormatter(LogFormatter):
329
def show(self, revno, rev, delta):
330
return self._show_helper(revno=revno, rev=rev, delta=delta)
332
def show_merge(self, rev, merge_depth):
333
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
335
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
336
"""Show a revision, either merged or not."""
337
from bzrlib.osutils import format_date
338
to_file = self.to_file
339
print >>to_file, indent+'-' * 60
340
if revno is not None:
341
print >>to_file, 'revno:', revno
343
print >>to_file, indent+'merged:', rev.revision_id
345
print >>to_file, indent+'revision-id:', rev.revision_id
1465
supports_merge_revisions = True
1466
preferred_levels = 1
1467
supports_delta = True
1468
supports_tags = True
1469
supports_diff = True
1471
def __init__(self, *args, **kwargs):
1472
super(LongLogFormatter, self).__init__(*args, **kwargs)
1473
if self.show_timezone == 'original':
1474
self.date_string = self._date_string_original_timezone
1476
self.date_string = self._date_string_with_timezone
1478
def _date_string_with_timezone(self, rev):
1479
return format_date(rev.timestamp, rev.timezone or 0,
1482
def _date_string_original_timezone(self, rev):
1483
return format_date_with_offset_in_original_timezone(rev.timestamp,
1486
def log_revision(self, revision):
1487
"""Log a revision, either merged or not."""
1488
indent = ' ' * revision.merge_depth
1490
if revision.revno is not None:
1491
lines.append('revno: %s%s' % (revision.revno,
1492
self.merge_marker(revision)))
1494
lines.append('tags: %s' % (', '.join(revision.tags)))
346
1495
if self.show_ids:
347
for parent_id in rev.parent_ids:
348
print >>to_file, indent+'parent:', parent_id
349
print >>to_file, indent+'committer:', rev.committer
351
print >>to_file, indent+'branch nick: %s' % \
352
rev.properties['branch-nick']
355
date_str = format_date(rev.timestamp,
358
print >>to_file, indent+'timestamp: %s' % date_str
360
print >>to_file, indent+'message:'
362
print >>to_file, indent+' (no message)'
1496
lines.append('revision-id: %s' % (revision.rev.revision_id,))
1497
for parent_id in revision.rev.parent_ids:
1498
lines.append('parent: %s' % (parent_id,))
1499
lines.extend(self.custom_properties(revision.rev))
1501
committer = revision.rev.committer
1502
authors = revision.rev.get_apparent_authors()
1503
if authors != [committer]:
1504
lines.append('author: %s' % (", ".join(authors),))
1505
lines.append('committer: %s' % (committer,))
1507
branch_nick = revision.rev.properties.get('branch-nick', None)
1508
if branch_nick is not None:
1509
lines.append('branch nick: %s' % (branch_nick,))
1511
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1513
lines.append('message:')
1514
if not revision.rev.message:
1515
lines.append(' (no message)')
364
message = rev.message.rstrip('\r\n')
1517
message = revision.rev.message.rstrip('\r\n')
365
1518
for l in message.split('\n'):
366
print >>to_file, indent+' ' + l
367
if delta is not None:
368
delta.show(to_file, self.show_ids)
1519
lines.append(' %s' % (l,))
1521
# Dump the output, appending the delta and diff if requested
1522
to_file = self.to_file
1523
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
1524
if revision.delta is not None:
1525
# Use the standard status output to display changes
1526
from bzrlib.delta import report_delta
1527
report_delta(to_file, revision.delta, short_status=False,
1528
show_ids=self.show_ids, indent=indent)
1529
if revision.diff is not None:
1530
to_file.write(indent + 'diff:\n')
1532
# Note: we explicitly don't indent the diff (relative to the
1533
# revision information) so that the output can be fed to patch -p0
1534
self.show_diff(self.to_exact_file, revision.diff, indent)
1535
self.to_exact_file.flush()
1537
def get_advice_separator(self):
1538
"""Get the text separating the log from the closing advice."""
1539
return '-' * 60 + '\n'
371
1542
class ShortLogFormatter(LogFormatter):
372
def show(self, revno, rev, delta):
373
from bzrlib.osutils import format_date
1544
supports_merge_revisions = True
1545
preferred_levels = 1
1546
supports_delta = True
1547
supports_tags = True
1548
supports_diff = True
1550
def __init__(self, *args, **kwargs):
1551
super(ShortLogFormatter, self).__init__(*args, **kwargs)
1552
self.revno_width_by_depth = {}
1554
def log_revision(self, revision):
1555
# We need two indents: one per depth and one for the information
1556
# relative to that indent. Most mainline revnos are 5 chars or
1557
# less while dotted revnos are typically 11 chars or less. Once
1558
# calculated, we need to remember the offset for a given depth
1559
# as we might be starting from a dotted revno in the first column
1560
# and we want subsequent mainline revisions to line up.
1561
depth = revision.merge_depth
1562
indent = ' ' * depth
1563
revno_width = self.revno_width_by_depth.get(depth)
1564
if revno_width is None:
1565
if revision.revno.find('.') == -1:
1566
# mainline revno, e.g. 12345
1569
# dotted revno, e.g. 12345.10.55
1571
self.revno_width_by_depth[depth] = revno_width
1572
offset = ' ' * (revno_width + 1)
375
1574
to_file = self.to_file
376
date_str = format_date(rev.timestamp, rev.timezone or 0,
378
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
379
format_date(rev.timestamp, rev.timezone or 0,
1577
tags = ' {%s}' % (', '.join(revision.tags))
1578
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1579
revision.revno, self.short_author(revision.rev),
1580
format_date(revision.rev.timestamp,
1581
revision.rev.timezone or 0,
380
1582
self.show_timezone, date_fmt="%Y-%m-%d",
1584
tags, self.merge_marker(revision)))
1585
self.show_properties(revision.rev, indent+offset)
382
1586
if self.show_ids:
383
print >>to_file, ' revision-id:', rev.revision_id
385
print >>to_file, ' (no message)'
1587
to_file.write(indent + offset + 'revision-id:%s\n'
1588
% (revision.rev.revision_id,))
1589
if not revision.rev.message:
1590
to_file.write(indent + offset + '(no message)\n')
387
message = rev.message.rstrip('\r\n')
1592
message = revision.rev.message.rstrip('\r\n')
388
1593
for l in message.split('\n'):
389
print >>to_file, ' ' + l
1594
to_file.write(indent + offset + '%s\n' % (l,))
391
# TODO: Why not show the modified files in a shorter form as
392
# well? rewrap them single lines of appropriate length
393
if delta is not None:
394
delta.show(to_file, self.show_ids)
1596
if revision.delta is not None:
1597
# Use the standard status output to display changes
1598
from bzrlib.delta import report_delta
1599
report_delta(to_file, revision.delta,
1600
short_status=self.delta_format==1,
1601
show_ids=self.show_ids, indent=indent + offset)
1602
if revision.diff is not None:
1603
self.show_diff(self.to_exact_file, revision.diff, ' ')
398
1607
class LineLogFormatter(LogFormatter):
1609
supports_merge_revisions = True
1610
preferred_levels = 1
1611
supports_tags = True
1613
def __init__(self, *args, **kwargs):
1614
super(LineLogFormatter, self).__init__(*args, **kwargs)
1615
width = terminal_width()
1616
if width is not None:
1617
# we need one extra space for terminals that wrap on last char
1619
self._max_chars = width
399
1621
def truncate(self, str, max_len):
400
if len(str) <= max_len:
1622
if max_len is None or len(str) <= max_len:
402
return str[:max_len-3]+'...'
1624
return str[:max_len-3] + '...'
404
1626
def date_string(self, rev):
405
from bzrlib.osutils import format_date
406
return format_date(rev.timestamp, rev.timezone or 0,
1627
return format_date(rev.timestamp, rev.timezone or 0,
407
1628
self.show_timezone, date_fmt="%Y-%m-%d",
408
1629
show_offset=False)
added
removed
bzrlib/log.py
