132
149
direction='reverse',
133
150
start_revision=None,
134
151
end_revision=None,
136
155
"""Write out human-readable log of commits to this branch.
139
LogFormatter object to show the output.
142
If true, list only the commits affecting the specified
143
file, rather than all commits.
146
If true show added/changed/deleted/renamed files.
149
'reverse' (default) is latest to earliest;
150
'forward' is earliest to latest.
153
If not None, only show revisions >= start_revision
156
If not None, only show revisions <= end_revision
160
_show_log(branch, lf, specific_fileid, verbose, direction,
161
start_revision, end_revision, search)
165
def _show_log(branch,
167
specific_fileid=None,
173
"""Worker function for show_log - see show_log."""
174
from bzrlib.osutils import format_date
175
from bzrlib.errors import BzrCheckError
176
from bzrlib.textui import show_status
178
from warnings import warn
180
if not isinstance(lf, LogFormatter):
181
warn("not a LogFormatter instance: %r" % lf)
157
This function is being retained for backwards compatibility but
158
should not be extended with new parameters. Use the new Logger class
159
instead, eg. Logger(branch, rqst).show(lf), adding parameters to the
160
make_log_request_dict function.
162
:param lf: The LogFormatter object showing the output.
164
:param specific_fileid: If not None, list only the commits affecting the
165
specified file, rather than all commits.
167
:param verbose: If True show added/changed/deleted/renamed files.
169
:param direction: 'reverse' (default) is latest to earliest; 'forward' is
172
:param start_revision: If not None, only show revisions >= start_revision
174
:param end_revision: If not None, only show revisions <= end_revision
176
:param search: If not None, only show revisions with matching commit
179
:param limit: If set, shows only 'limit' revisions, all revisions are shown
182
:param show_diff: If True, output a diff after each revision.
184
# Convert old-style parameters to new-style parameters
185
if specific_fileid is not None:
186
file_ids = [specific_fileid]
191
delta_type = 'partial'
198
diff_type = 'partial'
204
# Build the request and execute it
205
rqst = make_log_request_dict(direction=direction, specific_fileids=file_ids,
206
start_revision=start_revision, end_revision=end_revision,
207
limit=limit, message_search=search,
208
delta_type=delta_type, diff_type=diff_type)
209
Logger(branch, rqst).show(lf)
212
# Note: This needs to be kept this in sync with the defaults in
213
# make_log_request_dict() below
214
_DEFAULT_REQUEST_PARAMS = {
215
'direction': 'reverse',
217
'generate_tags': True,
218
'_match_using_deltas': True,
222
def make_log_request_dict(direction='reverse', specific_fileids=None,
223
start_revision=None, end_revision=None, limit=None,
224
message_search=None, levels=1, generate_tags=True, delta_type=None,
225
diff_type=None, _match_using_deltas=True):
226
"""Convenience function for making a logging request dictionary.
228
Using this function may make code slightly safer by ensuring
229
parameters have the correct names. It also provides a reference
230
point for documenting the supported parameters.
232
:param direction: 'reverse' (default) is latest to earliest;
233
'forward' is earliest to latest.
235
:param specific_fileids: If not None, only include revisions
236
affecting the specified files, rather than all revisions.
238
:param start_revision: If not None, only generate
239
revisions >= start_revision
241
:param end_revision: If not None, only generate
242
revisions <= end_revision
244
:param limit: If set, generate only 'limit' revisions, all revisions
245
are shown if None or 0.
247
:param message_search: If not None, only include revisions with
248
matching commit messages
250
:param levels: the number of levels of revisions to
251
generate; 1 for just the mainline; 0 for all levels.
253
:param generate_tags: If True, include tags for matched revisions.
255
:param delta_type: Either 'full', 'partial' or None.
256
'full' means generate the complete delta - adds/deletes/modifies/etc;
257
'partial' means filter the delta using specific_fileids;
258
None means do not generate any delta.
260
:param diff_type: Either 'full', 'partial' or None.
261
'full' means generate the complete diff - adds/deletes/modifies/etc;
262
'partial' means filter the diff using specific_fileids;
263
None means do not generate any diff.
265
:param _match_using_deltas: a private parameter controlling the
266
algorithm used for matching specific_fileids. This parameter
267
may be removed in the future so bzrlib client code should NOT
271
'direction': direction,
272
'specific_fileids': specific_fileids,
273
'start_revision': start_revision,
274
'end_revision': end_revision,
276
'message_search': message_search,
278
'generate_tags': generate_tags,
279
'delta_type': delta_type,
280
'diff_type': diff_type,
281
# Add 'private' attributes for features that may be deprecated
282
'_match_using_deltas': _match_using_deltas,
286
def _apply_log_request_defaults(rqst):
287
"""Apply default values to a request dictionary."""
288
result = _DEFAULT_REQUEST_PARAMS
294
class LogGenerator(object):
295
"""A generator of log revisions."""
297
def iter_log_revisions(self):
298
"""Iterate over LogRevision objects.
300
:return: An iterator yielding LogRevision objects.
302
raise NotImplementedError(self.iter_log_revisions)
305
class Logger(object):
306
"""An object the generates, formats and displays a log."""
308
def __init__(self, branch, rqst):
311
:param branch: the branch to log
312
:param rqst: A dictionary specifying the query parameters.
313
See make_log_request_dict() for supported values.
316
self.rqst = _apply_log_request_defaults(rqst)
321
:param lf: The LogFormatter object to send the output to.
323
if not isinstance(lf, LogFormatter):
324
warn("not a LogFormatter instance: %r" % lf)
326
self.branch.lock_read()
328
if getattr(lf, 'begin_log', None):
331
if getattr(lf, 'end_log', None):
336
def _show_body(self, lf):
337
"""Show the main log output.
339
Subclasses may wish to override this.
341
# Tweak the LogRequest based on what the LogFormatter can handle.
342
# (There's no point generating stuff if the formatter can't display it.)
344
rqst['levels'] = lf.get_levels()
345
if not getattr(lf, 'supports_tags', False):
346
rqst['generate_tags'] = False
347
if not getattr(lf, 'supports_delta', False):
348
rqst['delta_type'] = None
349
if not getattr(lf, 'supports_diff', False):
350
rqst['diff_type'] = None
352
# Find and print the interesting revisions
353
generator = self._generator_factory(self.branch, rqst)
354
for lr in generator.iter_log_revisions():
358
def _generator_factory(self, branch, rqst):
359
"""Make the LogGenerator object to use.
361
Subclasses may wish to override this.
363
return _DefaultLogGenerator(branch, rqst)
366
class _StartNotLinearAncestor(Exception):
367
"""Raised when a start revision is not found walking left-hand history."""
370
class _DefaultLogGenerator(LogGenerator):
371
"""The default generator of log revisions."""
373
def __init__(self, branch, rqst):
376
if rqst.get('generate_tags') and branch.supports_tags():
377
self.rev_tag_dict = branch.tags.get_reverse_tag_dict()
379
self.rev_tag_dict = {}
381
def iter_log_revisions(self):
382
"""Iterate over LogRevision objects.
384
:return: An iterator yielding LogRevision objects.
388
revision_iterator = self._create_log_revision_iterator()
389
for revs in revision_iterator:
390
for (rev_id, revno, merge_depth), rev, delta in revs:
391
# 0 levels means show everything; merge_depth counts from 0
392
levels = rqst.get('levels')
393
if levels != 0 and merge_depth >= levels:
395
diff = self._format_diff(rev, rev_id)
396
yield LogRevision(rev, revno, merge_depth, delta,
397
self.rev_tag_dict.get(rev_id), diff)
398
limit = rqst.get('limit')
401
if log_count >= limit:
404
def _format_diff(self, rev, rev_id):
405
diff_type = self.rqst.get('diff_type')
406
if diff_type is None:
408
repo = self.branch.repository
409
if len(rev.parent_ids) == 0:
410
ancestor_id = _mod_revision.NULL_REVISION
412
ancestor_id = rev.parent_ids[0]
413
tree_1 = repo.revision_tree(ancestor_id)
414
tree_2 = repo.revision_tree(rev_id)
415
file_ids = self.rqst.get('specific_fileids')
416
if diff_type == 'partial' and file_ids is not None:
417
specific_files = [tree_2.id2path(id) for id in file_ids]
419
specific_files = None
421
diff.show_diff_trees(tree_1, tree_2, s, specific_files, old_label='',
425
def _create_log_revision_iterator(self):
426
"""Create a revision iterator for log.
428
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
431
self.start_rev_id, self.end_rev_id = _get_revision_limits(
432
self.branch, self.rqst.get('start_revision'),
433
self.rqst.get('end_revision'))
434
if self.rqst.get('_match_using_deltas'):
435
return self._log_revision_iterator_using_delta_matching()
437
# We're using the per-file-graph algorithm. This scales really
438
# well but only makes sense if there is a single file and it's
440
file_count = len(self.rqst.get('specific_fileids'))
442
raise BzrError("illegal LogRequest: must match-using-deltas "
443
"when logging %d files" % file_count)
444
return self._log_revision_iterator_using_per_file_graph()
446
def _log_revision_iterator_using_delta_matching(self):
447
# Get the base revisions, filtering by the revision range
449
generate_merge_revisions = rqst.get('levels') != 1
450
delayed_graph_generation = not rqst.get('specific_fileids') and (
451
rqst.get('limit') or self.start_rev_id or self.end_rev_id)
452
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
453
self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
454
delayed_graph_generation=delayed_graph_generation)
456
# Apply the other filters
457
return make_log_rev_iterator(self.branch, view_revisions,
458
rqst.get('delta_type'), rqst.get('message_search'),
459
file_ids=rqst.get('specific_fileids'),
460
direction=rqst.get('direction'))
462
def _log_revision_iterator_using_per_file_graph(self):
463
# Get the base revisions, filtering by the revision range.
464
# Note that we always generate the merge revisions because
465
# filter_revisions_touching_file_id() requires them ...
467
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
468
self.end_rev_id, rqst.get('direction'), True)
469
if not isinstance(view_revisions, list):
470
view_revisions = list(view_revisions)
471
view_revisions = _filter_revisions_touching_file_id(self.branch,
472
rqst.get('specific_fileids')[0], view_revisions,
473
include_merges=rqst.get('levels') != 1)
474
return make_log_rev_iterator(self.branch, view_revisions,
475
rqst.get('delta_type'), rqst.get('message_search'))
478
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
479
generate_merge_revisions, delayed_graph_generation=False):
480
"""Calculate the revisions to view.
482
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
483
a list of the same tuples.
485
br_revno, br_rev_id = branch.last_revision_info()
489
# If a single revision is requested, check we can handle it
490
generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
491
(not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
492
if generate_single_revision:
493
return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
495
# If we only want to see linear revisions, we can iterate ...
496
if not generate_merge_revisions:
497
return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
500
return _generate_all_revisions(branch, start_rev_id, end_rev_id,
501
direction, delayed_graph_generation)
504
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
505
if rev_id == br_rev_id:
507
return [(br_rev_id, br_revno, 0)]
509
revno = branch.revision_id_to_dotted_revno(rev_id)
510
revno_str = '.'.join(str(n) for n in revno)
511
return [(rev_id, revno_str, 0)]
514
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
515
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
516
# If a start limit was given and it's not obviously an
517
# ancestor of the end limit, check it before outputting anything
518
if direction == 'forward' or (start_rev_id
519
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
521
result = list(result)
522
except _StartNotLinearAncestor:
523
raise errors.BzrCommandError('Start revision not found in'
524
' left-hand history of end revision.')
525
if direction == 'forward':
526
result = reversed(result)
530
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
531
delayed_graph_generation):
532
# On large trees, generating the merge graph can take 30-60 seconds
533
# so we delay doing it until a merge is detected, incrementally
534
# returning initial (non-merge) revisions while we can.
535
initial_revisions = []
536
if delayed_graph_generation:
538
for rev_id, revno, depth in \
539
_linear_view_revisions(branch, start_rev_id, end_rev_id):
540
if _has_merges(branch, rev_id):
544
initial_revisions.append((rev_id, revno, depth))
546
# No merged revisions found
547
if direction == 'reverse':
548
return initial_revisions
549
elif direction == 'forward':
550
return reversed(initial_revisions)
552
raise ValueError('invalid direction %r' % direction)
553
except _StartNotLinearAncestor:
554
# A merge was never detected so the lower revision limit can't
555
# be nested down somewhere
556
raise errors.BzrCommandError('Start revision not found in'
557
' history of end revision.')
559
# A log including nested merges is required. If the direction is reverse,
560
# we rebase the initial merge depths so that the development line is
561
# shown naturally, i.e. just like it is for linear logging. We can easily
562
# make forward the exact opposite display, but showing the merge revisions
563
# indented at the end seems slightly nicer in that case.
564
view_revisions = chain(iter(initial_revisions),
565
_graph_view_revisions(branch, start_rev_id, end_rev_id,
566
rebase_initial_depths=direction == 'reverse'))
567
if direction == 'reverse':
568
return view_revisions
569
elif direction == 'forward':
570
# Forward means oldest first, adjusting for depth.
571
view_revisions = reverse_by_depth(list(view_revisions))
572
return _rebase_merge_depth(view_revisions)
574
raise ValueError('invalid direction %r' % direction)
577
def _has_merges(branch, rev_id):
578
"""Does a revision have multiple parents or not?"""
579
parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
580
return len(parents) > 1
583
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
584
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
585
if start_rev_id and end_rev_id:
586
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
587
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
588
if len(start_dotted) == 1 and len(end_dotted) == 1:
590
return start_dotted[0] <= end_dotted[0]
591
elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
592
start_dotted[0:1] == end_dotted[0:1]):
593
# both on same development line
594
return start_dotted[2] <= end_dotted[2]
601
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
602
"""Calculate a sequence of revisions to view, newest to oldest.
604
:param start_rev_id: the lower revision-id
605
:param end_rev_id: the upper revision-id
606
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
607
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
608
is not found walking the left-hand history
610
br_revno, br_rev_id = branch.last_revision_info()
611
repo = branch.repository
612
if start_rev_id is None and end_rev_id is None:
614
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
615
yield revision_id, str(cur_revno), 0
618
if end_rev_id is None:
619
end_rev_id = br_rev_id
620
found_start = start_rev_id is None
621
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
622
revno = branch.revision_id_to_dotted_revno(revision_id)
623
revno_str = '.'.join(str(n) for n in revno)
624
if not found_start and revision_id == start_rev_id:
625
yield revision_id, revno_str, 0
629
yield revision_id, revno_str, 0
632
raise _StartNotLinearAncestor()
635
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
636
rebase_initial_depths=True):
637
"""Calculate revisions to view including merges, newest to oldest.
639
:param branch: the branch
640
:param start_rev_id: the lower revision-id
641
:param end_rev_id: the upper revision-id
642
:param rebase_initial_depth: should depths be rebased until a mainline
644
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
646
view_revisions = branch.iter_merge_sorted_revisions(
647
start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
648
stop_rule="with-merges")
649
if not rebase_initial_depths:
650
for (rev_id, merge_depth, revno, end_of_merge
652
yield rev_id, '.'.join(map(str, revno)), merge_depth
654
# We're following a development line starting at a merged revision.
655
# We need to adjust depths down by the initial depth until we find
656
# a depth less than it. Then we use that depth as the adjustment.
657
# If and when we reach the mainline, depth adjustment ends.
658
depth_adjustment = None
659
for (rev_id, merge_depth, revno, end_of_merge
661
if depth_adjustment is None:
662
depth_adjustment = merge_depth
664
if merge_depth < depth_adjustment:
665
depth_adjustment = merge_depth
666
merge_depth -= depth_adjustment
667
yield rev_id, '.'.join(map(str, revno)), merge_depth
670
def calculate_view_revisions(branch, start_revision, end_revision, direction,
671
specific_fileid, generate_merge_revisions):
672
"""Calculate the revisions to view.
674
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
675
a list of the same tuples.
677
# This method is no longer called by the main code path.
678
# It is retained for API compatibility and may be deprecated
680
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
682
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
683
direction, generate_merge_revisions or specific_fileid))
183
684
if specific_fileid:
184
mutter('get log for file_id %r', specific_fileid)
186
if search is not None:
188
searchRE = re.compile(search, re.IGNORECASE)
192
which_revs = _enumerate_history(branch)
194
if start_revision is None:
197
branch.check_real_revno(start_revision)
199
if end_revision is None:
200
end_revision = len(which_revs)
202
branch.check_real_revno(end_revision)
204
# list indexes are 0-based; revisions are 1-based
205
cut_revs = which_revs[(start_revision-1):(end_revision)]
685
view_revisions = _filter_revisions_touching_file_id(branch,
686
specific_fileid, view_revisions,
687
include_merges=generate_merge_revisions)
688
return _rebase_merge_depth(view_revisions)
691
def _rebase_merge_depth(view_revisions):
692
"""Adjust depths upwards so the top level is 0."""
693
# If either the first or last revision have a merge_depth of 0, we're done
694
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
695
min_depth = min([d for r,n,d in view_revisions])
697
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
698
return view_revisions
701
def make_log_rev_iterator(branch, view_revisions, generate_delta, search,
702
file_ids=None, direction='reverse'):
703
"""Create a revision iterator for log.
705
:param branch: The branch being logged.
706
:param view_revisions: The revisions being viewed.
707
:param generate_delta: Whether to generate a delta for each revision.
708
Permitted values are None, 'full' and 'partial'.
709
:param search: A user text search string.
710
:param file_ids: If non empty, only revisions matching one or more of
711
the file-ids are to be kept.
712
:param direction: the direction in which view_revisions is sorted
713
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
716
# Convert view_revisions into (view, None, None) groups to fit with
717
# the standard interface here.
718
if type(view_revisions) == list:
719
# A single batch conversion is faster than many incremental ones.
720
# As we have all the data, do a batch conversion.
721
nones = [None] * len(view_revisions)
722
log_rev_iterator = iter([zip(view_revisions, nones, nones)])
725
for view in view_revisions:
726
yield (view, None, None)
727
log_rev_iterator = iter([_convert()])
728
for adapter in log_adapters:
729
# It would be nicer if log adapters were first class objects
730
# with custom parameters. This will do for now. IGC 20090127
731
if adapter == _make_delta_filter:
732
log_rev_iterator = adapter(branch, generate_delta,
733
search, log_rev_iterator, file_ids, direction)
735
log_rev_iterator = adapter(branch, generate_delta,
736
search, log_rev_iterator)
737
return log_rev_iterator
740
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
741
"""Create a filtered iterator of log_rev_iterator matching on a regex.
743
:param branch: The branch being logged.
744
:param generate_delta: Whether to generate a delta for each revision.
745
:param search: A user text search string.
746
:param log_rev_iterator: An input iterator containing all revisions that
747
could be displayed, in lists.
748
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
752
return log_rev_iterator
753
searchRE = re_compile_checked(search, re.IGNORECASE,
754
'log message filter')
755
return _filter_message_re(searchRE, log_rev_iterator)
758
def _filter_message_re(searchRE, log_rev_iterator):
759
for revs in log_rev_iterator:
761
for (rev_id, revno, merge_depth), rev, delta in revs:
762
if searchRE.search(rev.message):
763
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
767
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
768
fileids=None, direction='reverse'):
769
"""Add revision deltas to a log iterator if needed.
771
:param branch: The branch being logged.
772
:param generate_delta: Whether to generate a delta for each revision.
773
Permitted values are None, 'full' and 'partial'.
774
:param search: A user text search string.
775
:param log_rev_iterator: An input iterator containing all revisions that
776
could be displayed, in lists.
777
:param fileids: If non empty, only revisions matching one or more of
778
the file-ids are to be kept.
779
:param direction: the direction in which view_revisions is sorted
780
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
783
if not generate_delta and not fileids:
784
return log_rev_iterator
785
return _generate_deltas(branch.repository, log_rev_iterator,
786
generate_delta, fileids, direction)
789
def _generate_deltas(repository, log_rev_iterator, delta_type, fileids,
791
"""Create deltas for each batch of revisions in log_rev_iterator.
793
If we're only generating deltas for the sake of filtering against
794
file-ids, we stop generating deltas once all file-ids reach the
795
appropriate life-cycle point. If we're receiving data newest to
796
oldest, then that life-cycle point is 'add', otherwise it's 'remove'.
798
check_fileids = fileids is not None and len(fileids) > 0
800
fileid_set = set(fileids)
801
if direction == 'reverse':
807
for revs in log_rev_iterator:
808
# If we were matching against fileids and we've run out,
809
# there's nothing left to do
810
if check_fileids and not fileid_set:
812
revisions = [rev[1] for rev in revs]
814
if delta_type == 'full' and not check_fileids:
815
deltas = repository.get_deltas_for_revisions(revisions)
816
for rev, delta in izip(revs, deltas):
817
new_revs.append((rev[0], rev[1], delta))
819
deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
820
for rev, delta in izip(revs, deltas):
822
if delta is None or not delta.has_changed():
825
_update_fileids(delta, fileid_set, stop_on)
826
if delta_type is None:
828
elif delta_type == 'full':
829
# If the file matches all the time, rebuilding
830
# a full delta like this in addition to a partial
831
# one could be slow. However, it's likely that
832
# most revisions won't get this far, making it
833
# faster to filter on the partial deltas and
834
# build the occasional full delta than always
835
# building full deltas and filtering those.
837
delta = repository.get_revision_delta(rev_id)
838
new_revs.append((rev[0], rev[1], delta))
842
def _update_fileids(delta, fileids, stop_on):
843
"""Update the set of file-ids to search based on file lifecycle events.
845
:param fileids: a set of fileids to update
846
:param stop_on: either 'add' or 'remove' - take file-ids out of the
847
fileids set once their add or remove entry is detected respectively
850
for item in delta.added:
851
if item[1] in fileids:
852
fileids.remove(item[1])
853
elif stop_on == 'delete':
854
for item in delta.removed:
855
if item[1] in fileids:
856
fileids.remove(item[1])
859
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
860
"""Extract revision objects from the repository
862
:param branch: The branch being logged.
863
:param generate_delta: Whether to generate a delta for each revision.
864
:param search: A user text search string.
865
:param log_rev_iterator: An input iterator containing all revisions that
866
could be displayed, in lists.
867
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
870
repository = branch.repository
871
for revs in log_rev_iterator:
872
# r = revision_id, n = revno, d = merge depth
873
revision_ids = [view[0] for view, _, _ in revs]
874
revisions = repository.get_revisions(revision_ids)
875
revs = [(rev[0], revision, rev[2]) for rev, revision in
876
izip(revs, revisions)]
880
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
881
"""Group up a single large batch into smaller ones.
883
:param branch: The branch being logged.
884
:param generate_delta: Whether to generate a delta for each revision.
885
:param search: A user text search string.
886
:param log_rev_iterator: An input iterator containing all revisions that
887
could be displayed, in lists.
888
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
891
repository = branch.repository
893
for batch in log_rev_iterator:
896
step = [detail for _, detail in zip(range(num), batch)]
900
num = min(int(num * 1.5), 200)
903
def _get_revision_limits(branch, start_revision, end_revision):
904
"""Get and check revision limits.
906
:param branch: The branch containing the revisions.
908
:param start_revision: The first revision to be logged.
909
For backwards compatibility this may be a mainline integer revno,
910
but for merge revision support a RevisionInfo is expected.
912
:param end_revision: The last revision to be logged.
913
For backwards compatibility this may be a mainline integer revno,
914
but for merge revision support a RevisionInfo is expected.
916
:return: (start_rev_id, end_rev_id) tuple.
918
branch_revno, branch_rev_id = branch.last_revision_info()
920
if start_revision is None:
923
if isinstance(start_revision, revisionspec.RevisionInfo):
924
start_rev_id = start_revision.rev_id
925
start_revno = start_revision.revno or 1
927
branch.check_real_revno(start_revision)
928
start_revno = start_revision
929
start_rev_id = branch.get_rev_id(start_revno)
932
if end_revision is None:
933
end_revno = branch_revno
935
if isinstance(end_revision, revisionspec.RevisionInfo):
936
end_rev_id = end_revision.rev_id
937
end_revno = end_revision.revno or branch_revno
939
branch.check_real_revno(end_revision)
940
end_revno = end_revision
941
end_rev_id = branch.get_rev_id(end_revno)
943
if branch_revno != 0:
944
if (start_rev_id == _mod_revision.NULL_REVISION
945
or end_rev_id == _mod_revision.NULL_REVISION):
946
raise errors.BzrCommandError('Logging revision 0 is invalid.')
947
if start_revno > end_revno:
948
raise errors.BzrCommandError("Start revision must be older than "
950
return (start_rev_id, end_rev_id)
953
def _get_mainline_revs(branch, start_revision, end_revision):
954
"""Get the mainline revisions from the branch.
956
Generates the list of mainline revisions for the branch.
958
:param branch: The branch containing the revisions.
960
:param start_revision: The first revision to be logged.
961
For backwards compatibility this may be a mainline integer revno,
962
but for merge revision support a RevisionInfo is expected.
964
:param end_revision: The last revision to be logged.
965
For backwards compatibility this may be a mainline integer revno,
966
but for merge revision support a RevisionInfo is expected.
968
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
970
branch_revno, branch_last_revision = branch.last_revision_info()
971
if branch_revno == 0:
972
return None, None, None, None
974
# For mainline generation, map start_revision and end_revision to
975
# mainline revnos. If the revision is not on the mainline choose the
976
# appropriate extreme of the mainline instead - the extra will be
978
# Also map the revisions to rev_ids, to be used in the later filtering
981
if start_revision is None:
984
if isinstance(start_revision, revisionspec.RevisionInfo):
985
start_rev_id = start_revision.rev_id
986
start_revno = start_revision.revno or 1
988
branch.check_real_revno(start_revision)
989
start_revno = start_revision
992
if end_revision is None:
993
end_revno = branch_revno
995
if isinstance(end_revision, revisionspec.RevisionInfo):
996
end_rev_id = end_revision.rev_id
997
end_revno = end_revision.revno or branch_revno
999
branch.check_real_revno(end_revision)
1000
end_revno = end_revision
1002
if ((start_rev_id == _mod_revision.NULL_REVISION)
1003
or (end_rev_id == _mod_revision.NULL_REVISION)):
1004
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1005
if start_revno > end_revno:
1006
raise errors.BzrCommandError("Start revision must be older than "
1007
"the end revision.")
1009
if end_revno < start_revno:
1010
return None, None, None, None
1011
cur_revno = branch_revno
1014
for revision_id in branch.repository.iter_reverse_revision_history(
1015
branch_last_revision):
1016
if cur_revno < start_revno:
1017
# We have gone far enough, but we always add 1 more revision
1018
rev_nos[revision_id] = cur_revno
1019
mainline_revs.append(revision_id)
1021
if cur_revno <= end_revno:
1022
rev_nos[revision_id] = cur_revno
1023
mainline_revs.append(revision_id)
1026
# We walked off the edge of all revisions, so we add a 'None' marker
1027
mainline_revs.append(None)
1029
mainline_revs.reverse()
208
1031
# override the mainline to look like the revision history.
209
mainline_revs = [revision_id for index, revision_id in cut_revs]
210
if cut_revs[0][0] == 1:
211
mainline_revs.insert(0, None)
213
mainline_revs.insert(0, which_revs[start_revision-2][1])
215
merge_sorted_revisions = merge_sort(
216
branch.repository.get_revision_graph(mainline_revs[-1]),
1032
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1035
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1036
"""Filter view_revisions based on revision ranges.
1038
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1039
tuples to be filtered.
1041
:param start_rev_id: If not NONE specifies the first revision to be logged.
1042
If NONE then all revisions up to the end_rev_id are logged.
1044
:param end_rev_id: If not NONE specifies the last revision to be logged.
1045
If NONE then all revisions up to the end of the log are logged.
1047
:return: The filtered view_revisions.
1049
# This method is no longer called by the main code path.
1050
# It may be removed soon. IGC 20090127
1051
if start_rev_id or end_rev_id:
1052
revision_ids = [r for r, n, d in view_revisions]
1054
start_index = revision_ids.index(start_rev_id)
1057
if start_rev_id == end_rev_id:
1058
end_index = start_index
1061
end_index = revision_ids.index(end_rev_id)
1063
end_index = len(view_revisions) - 1
1064
# To include the revisions merged into the last revision,
1065
# extend end_rev_id down to, but not including, the next rev
1066
# with the same or lesser merge_depth
1067
end_merge_depth = view_revisions[end_index][2]
1069
for index in xrange(end_index+1, len(view_revisions)+1):
1070
if view_revisions[index][2] <= end_merge_depth:
1071
end_index = index - 1
1074
# if the search falls off the end then log to the end as well
1075
end_index = len(view_revisions) - 1
1076
view_revisions = view_revisions[start_index:end_index+1]
1077
return view_revisions
1080
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1081
include_merges=True):
1082
r"""Return the list of revision ids which touch a given file id.
1084
The function filters view_revisions and returns a subset.
1085
This includes the revisions which directly change the file id,
1086
and the revisions which merge these changes. So if the
1098
And 'C' changes a file, then both C and D will be returned. F will not be
1099
returned even though it brings the changes to C into the branch starting
1100
with E. (Note that if we were using F as the tip instead of G, then we
1103
This will also be restricted based on a subset of the mainline.
1105
:param branch: The branch where we can get text revision information.
1107
:param file_id: Filter out revisions that do not touch file_id.
1109
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1110
tuples. This is the list of revisions which will be filtered. It is
1111
assumed that view_revisions is in merge_sort order (i.e. newest
1114
:param include_merges: include merge revisions in the result or not
1116
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
1118
# Lookup all possible text keys to determine which ones actually modified
1120
text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1122
# Looking up keys in batches of 1000 can cut the time in half, as well as
1123
# memory consumption. GraphIndex *does* like to look for a few keys in
1124
# parallel, it just doesn't like looking for *lots* of keys in parallel.
1125
# TODO: This code needs to be re-evaluated periodically as we tune the
1126
# indexing layer. We might consider passing in hints as to the known
1127
# access pattern (sparse/clustered, high success rate/low success
1128
# rate). This particular access is clustered with a low success rate.
1129
get_parent_map = branch.repository.texts.get_parent_map
1130
modified_text_revisions = set()
1132
for start in xrange(0, len(text_keys), chunk_size):
1133
next_keys = text_keys[start:start + chunk_size]
1134
# Only keep the revision_id portion of the key
1135
modified_text_revisions.update(
1136
[k[1] for k in get_parent_map(next_keys)])
1137
del text_keys, next_keys
1140
# Track what revisions will merge the current revision, replace entries
1141
# with 'None' when they have been added to result
1142
current_merge_stack = [None]
1143
for info in view_revisions:
1144
rev_id, revno, depth = info
1145
if depth == len(current_merge_stack):
1146
current_merge_stack.append(info)
1148
del current_merge_stack[depth + 1:]
1149
current_merge_stack[-1] = info
1151
if rev_id in modified_text_revisions:
1152
# This needs to be logged, along with the extra revisions
1153
for idx in xrange(len(current_merge_stack)):
1154
node = current_merge_stack[idx]
1155
if node is not None:
1156
if include_merges or node[2] == 0:
1158
current_merge_stack[idx] = None
1162
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1163
include_merges=True):
1164
"""Produce an iterator of revisions to show
1165
:return: an iterator of (revision_id, revno, merge_depth)
1166
(if there is no revno for a revision, None is supplied)
1168
# This method is no longer called by the main code path.
1169
# It is retained for API compatibility and may be deprecated
1170
# soon. IGC 20090127
1171
if not include_merges:
1172
revision_ids = mainline_revs[1:]
1173
if direction == 'reverse':
1174
revision_ids.reverse()
1175
for revision_id in revision_ids:
1176
yield revision_id, str(rev_nos[revision_id]), 0
1178
graph = branch.repository.get_graph()
1179
# This asks for all mainline revisions, which means we only have to spider
1180
# sideways, rather than depth history. That said, its still size-of-history
1181
# and should be addressed.
1182
# mainline_revisions always includes an extra revision at the beginning, so
1184
parent_map = dict(((key, value) for key, value in
1185
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1186
# filter out ghosts; merge_sort errors on ghosts.
1187
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1188
merge_sorted_revisions = tsort.merge_sort(
217
1190
mainline_revs[-1],
1192
generate_revno=True)
220
if direction == 'reverse':
222
elif direction == 'forward':
1194
if direction == 'forward':
223
1195
# forward means oldest first.
224
merge_sorted_revisions.reverse()
1196
merge_sorted_revisions = reverse_by_depth(merge_sorted_revisions)
1197
elif direction != 'reverse':
226
1198
raise ValueError('invalid direction %r' % direction)
228
revision_history = branch.revision_history()
230
# convert the revision history to a dictionary:
232
for index, rev_id in cut_revs:
233
rev_nos[rev_id] = index
235
# now we just print all the revisions
236
for sequence, rev_id, merge_depth, end_of_merge in merge_sorted_revisions:
237
rev = branch.repository.get_revision(rev_id)
240
if not searchRE.search(rev.message):
244
# a mainline revision.
245
if verbose or specific_fileid:
246
delta = _get_revision_delta(branch, rev_nos[rev_id])
249
if not delta.touches_file_id(specific_fileid):
253
# although we calculated it, throw it away without display
256
lf.show(rev_nos[rev_id], rev, delta)
257
elif hasattr(lf, 'show_merge'):
258
lf.show_merge(rev, merge_depth)
261
def deltas_for_log_dummy(branch, which_revs):
262
"""Return all the revisions without intermediate deltas.
264
Useful for log commands that won't need the delta information.
267
for revno, revision_id in which_revs:
268
yield revno, branch.get_revision(revision_id), None
271
def deltas_for_log_reverse(branch, which_revs):
272
"""Compute deltas for display in latest-to-earliest order.
278
Sequence of (revno, revision_id) for the subset of history to examine
281
Sequence of (revno, rev, delta)
283
The delta is from the given revision to the next one in the
284
sequence, which makes sense if the log is being displayed from
287
last_revno = last_revision_id = last_tree = None
288
for revno, revision_id in which_revs:
289
this_tree = branch.revision_tree(revision_id)
290
this_revision = branch.get_revision(revision_id)
293
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
295
this_tree = EmptyTree(branch.get_root_id())
298
last_revision = this_revision
299
last_tree = this_tree
303
this_tree = EmptyTree(branch.get_root_id())
1200
for (sequence, rev_id, merge_depth, revno, end_of_merge
1201
) in merge_sorted_revisions:
1202
yield rev_id, '.'.join(map(str, revno)), merge_depth
1205
def reverse_by_depth(merge_sorted_revisions, _depth=0):
1206
"""Reverse revisions by depth.
1208
Revisions with a different depth are sorted as a group with the previous
1209
revision of that depth. There may be no topological justification for this,
1210
but it looks much nicer.
1212
# Add a fake revision at start so that we can always attach sub revisions
1213
merge_sorted_revisions = [(None, None, _depth)] + merge_sorted_revisions
1215
for val in merge_sorted_revisions:
1216
if val[2] == _depth:
1217
# Each revision at the current depth becomes a chunk grouping all
1218
# higher depth revisions.
1219
zd_revisions.append([val])
305
this_revno = last_revno - 1
306
this_revision_id = branch.revision_history()[this_revno]
307
this_tree = branch.revision_tree(this_revision_id)
308
yield last_revno, last_revision, compare_trees(this_tree, last_tree, False)
311
def deltas_for_log_forward(branch, which_revs):
312
"""Compute deltas for display in forward log.
314
Given a sequence of (revno, revision_id) pairs, return
317
The delta is from the given revision to the next one in the
318
sequence, which makes sense if the log is being displayed from
1221
zd_revisions[-1].append(val)
1222
for revisions in zd_revisions:
1223
if len(revisions) > 1:
1224
# We have higher depth revisions, let reverse them locally
1225
revisions[1:] = reverse_by_depth(revisions[1:], _depth + 1)
1226
zd_revisions.reverse()
1228
for chunk in zd_revisions:
1229
result.extend(chunk)
1231
# Top level call, get rid of the fake revisions that have been added
1232
result = [r for r in result if r[0] is not None and r[1] is not None]
1236
class LogRevision(object):
1237
"""A revision to be logged (by LogFormatter.log_revision).
1239
A simple wrapper for the attributes of a revision to be logged.
1240
The attributes may or may not be populated, as determined by the
1241
logging options and the log formatter capabilities.
321
last_revno = last_revision_id = last_tree = None
322
prev_tree = EmptyTree(branch.get_root_id())
324
for revno, revision_id in which_revs:
325
this_tree = branch.revision_tree(revision_id)
326
this_revision = branch.get_revision(revision_id)
330
last_tree = EmptyTree(branch.get_root_id())
332
last_revno = revno - 1
333
last_revision_id = branch.revision_history()[last_revno]
334
last_tree = branch.revision_tree(last_revision_id)
336
yield revno, this_revision, compare_trees(last_tree, this_tree, False)
339
last_revision = this_revision
340
last_tree = this_tree
1244
def __init__(self, rev=None, revno=None, merge_depth=0, delta=None,
1245
tags=None, diff=None):
1247
self.revno = str(revno)
1248
self.merge_depth = merge_depth
343
1254
class LogFormatter(object):
344
"""Abstract class to display log messages."""
345
def __init__(self, to_file, show_ids=False, show_timezone='original'):
1255
"""Abstract class to display log messages.
1257
At a minimum, a derived class must implement the log_revision method.
1259
If the LogFormatter needs to be informed of the beginning or end of
1260
a log it should implement the begin_log and/or end_log hook methods.
1262
A LogFormatter should define the following supports_XXX flags
1263
to indicate which LogRevision attributes it supports:
1265
- supports_delta must be True if this log formatter supports delta.
1266
Otherwise the delta attribute may not be populated. The 'delta_format'
1267
attribute describes whether the 'short_status' format (1) or the long
1268
one (2) should be used.
1270
- supports_merge_revisions must be True if this log formatter supports
1271
merge revisions. If not, then only mainline revisions will be passed
1274
- preferred_levels is the number of levels this formatter defaults to.
1275
The default value is zero meaning display all levels.
1276
This value is only relevant if supports_merge_revisions is True.
1278
- supports_tags must be True if this log formatter supports tags.
1279
Otherwise the tags attribute may not be populated.
1281
- supports_diff must be True if this log formatter supports diffs.
1282
Otherwise the diff attribute may not be populated.
1284
Plugins can register functions to show custom revision properties using
1285
the properties_handler_registry. The registered function
1286
must respect the following interface description:
1287
def my_show_properties(properties_dict):
1288
# code that returns a dict {'name':'value'} of the properties
1291
preferred_levels = 0
1293
def __init__(self, to_file, show_ids=False, show_timezone='original',
1294
delta_format=None, levels=None, show_advice=False,
1295
to_exact_file=None):
1296
"""Create a LogFormatter.
1298
:param to_file: the file to output to
1299
:param to_exact_file: if set, gives an output stream to which
1300
non-Unicode diffs are written.
1301
:param show_ids: if True, revision-ids are to be displayed
1302
:param show_timezone: the timezone to use
1303
:param delta_format: the level of delta information to display
1304
or None to leave it to the formatter to decide
1305
:param levels: the number of levels to display; None or -1 to
1306
let the log formatter decide.
1307
:param show_advice: whether to show advice at the end of the
346
1310
self.to_file = to_file
1311
# 'exact' stream used to show diff, it should print content 'as is'
1312
# and should not try to decode/encode it to unicode to avoid bug #328007
1313
if to_exact_file is not None:
1314
self.to_exact_file = to_exact_file
1316
# XXX: somewhat hacky; this assumes it's a codec writer; it's better
1317
# for code that expects to get diffs to pass in the exact file
1319
self.to_exact_file = getattr(to_file, 'stream', to_file)
347
1320
self.show_ids = show_ids
348
1321
self.show_timezone = show_timezone
351
def show(self, revno, rev, delta):
1322
if delta_format is None:
1323
# Ensures backward compatibility
1324
delta_format = 2 # long format
1325
self.delta_format = delta_format
1326
self.levels = levels
1327
self._show_advice = show_advice
1328
self._merge_count = 0
1330
def get_levels(self):
1331
"""Get the number of levels to display or 0 for all."""
1332
if getattr(self, 'supports_merge_revisions', False):
1333
if self.levels is None or self.levels == -1:
1334
self.levels = self.preferred_levels
1339
def log_revision(self, revision):
1342
:param revision: The LogRevision to be logged.
352
1344
raise NotImplementedError('not implemented in abstract base')
1346
def show_advice(self):
1347
"""Output user advice, if any, when the log is completed."""
1348
if self._show_advice and self.levels == 1 and self._merge_count > 0:
1349
advice_sep = self.get_advice_separator()
1351
self.to_file.write(advice_sep)
1353
"Use --include-merges or -n0 to see merged revisions.\n")
1355
def get_advice_separator(self):
1356
"""Get the text separating the log from the closing advice."""
354
1359
def short_committer(self, rev):
355
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
1360
name, address = config.parse_username(rev.committer)
1365
def short_author(self, rev):
1366
name, address = config.parse_username(rev.get_apparent_authors()[0])
1371
def merge_marker(self, revision):
1372
"""Get the merge marker to include in the output or '' if none."""
1373
if len(revision.rev.parent_ids) > 1:
1374
self._merge_count += 1
1379
def show_foreign_info(self, rev, indent):
1380
"""Custom log displayer for foreign revision identifiers.
1382
:param rev: Revision object.
1384
# Revision comes directly from a foreign repository
1385
if isinstance(rev, foreign.ForeignRevision):
1386
self._write_properties(indent, rev.mapping.vcs.show_foreign_revid(
1390
# Imported foreign revision revision ids always contain :
1391
if not ":" in rev.revision_id:
1394
# Revision was once imported from a foreign repository
1396
foreign_revid, mapping = \
1397
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1398
except errors.InvalidRevisionId:
1401
self._write_properties(indent,
1402
mapping.vcs.show_foreign_revid(foreign_revid))
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 key, handler in properties_handler_registry.iteritems():
1410
self._write_properties(indent, handler(revision))
1412
def _write_properties(self, indent, properties):
1413
for key, value in properties.items():
1414
self.to_file.write(indent + key + ': ' + value + '\n')
1416
def show_diff(self, to_file, diff, indent):
1417
for l in diff.rstrip().split('\n'):
1418
to_file.write(indent + '%s\n' % (l,))
358
1421
class LongLogFormatter(LogFormatter):
359
def show(self, revno, rev, delta):
360
return self._show_helper(revno=revno, rev=rev, delta=delta)
362
def show_merge(self, rev, merge_depth):
363
return self._show_helper(rev=rev, indent=' '*merge_depth, merged=True, delta=None)
365
def _show_helper(self, rev=None, revno=None, indent='', merged=False, delta=None):
366
"""Show a revision, either merged or not."""
367
from bzrlib.osutils import format_date
1423
supports_merge_revisions = True
1424
preferred_levels = 1
1425
supports_delta = True
1426
supports_tags = True
1427
supports_diff = True
1429
def log_revision(self, revision):
1430
"""Log a revision, either merged or not."""
1431
indent = ' ' * revision.merge_depth
368
1432
to_file = self.to_file
369
print >>to_file, indent+'-' * 60
370
if revno is not None:
371
print >>to_file, 'revno:', revno
373
print >>to_file, indent+'merged:', rev.revision_id
375
print >>to_file, indent+'revision-id:', rev.revision_id
1433
to_file.write(indent + '-' * 60 + '\n')
1434
if revision.revno is not None:
1435
to_file.write(indent + 'revno: %s%s\n' % (revision.revno,
1436
self.merge_marker(revision)))
1438
to_file.write(indent + 'tags: %s\n' % (', '.join(revision.tags)))
376
1439
if self.show_ids:
377
for parent_id in rev.parent_ids:
378
print >>to_file, indent+'parent:', parent_id
379
print >>to_file, indent+'committer:', rev.committer
381
print >>to_file, indent+'branch nick: %s' % \
382
rev.properties['branch-nick']
385
date_str = format_date(rev.timestamp,
1440
to_file.write(indent + 'revision-id: ' + revision.rev.revision_id)
1442
for parent_id in revision.rev.parent_ids:
1443
to_file.write(indent + 'parent: %s\n' % (parent_id,))
1444
self.show_foreign_info(revision.rev, indent)
1445
self.show_properties(revision.rev, indent)
1447
committer = revision.rev.committer
1448
authors = revision.rev.get_apparent_authors()
1449
if authors != [committer]:
1450
to_file.write(indent + 'author: %s\n' % (", ".join(authors),))
1451
to_file.write(indent + 'committer: %s\n' % (committer,))
1453
branch_nick = revision.rev.properties.get('branch-nick', None)
1454
if branch_nick is not None:
1455
to_file.write(indent + 'branch nick: %s\n' % (branch_nick,))
1457
date_str = format_date(revision.rev.timestamp,
1458
revision.rev.timezone or 0,
387
1459
self.show_timezone)
388
print >>to_file, indent+'timestamp: %s' % date_str
1460
to_file.write(indent + 'timestamp: %s\n' % (date_str,))
390
print >>to_file, indent+'message:'
392
print >>to_file, indent+' (no message)'
1462
to_file.write(indent + 'message:\n')
1463
if not revision.rev.message:
1464
to_file.write(indent + ' (no message)\n')
394
message = rev.message.rstrip('\r\n')
1466
message = revision.rev.message.rstrip('\r\n')
395
1467
for l in message.split('\n'):
396
print >>to_file, indent+' ' + l
398
delta.show(to_file, self.show_ids)
1468
to_file.write(indent + ' %s\n' % (l,))
1469
if revision.delta is not None:
1470
# We don't respect delta_format for compatibility
1471
revision.delta.show(to_file, self.show_ids, indent=indent,
1473
if revision.diff is not None:
1474
to_file.write(indent + 'diff:\n')
1476
# Note: we explicitly don't indent the diff (relative to the
1477
# revision information) so that the output can be fed to patch -p0
1478
self.show_diff(self.to_exact_file, revision.diff, indent)
1479
self.to_exact_file.flush()
1481
def get_advice_separator(self):
1482
"""Get the text separating the log from the closing advice."""
1483
return '-' * 60 + '\n'
401
1486
class ShortLogFormatter(LogFormatter):
402
def show(self, revno, rev, delta):
403
from bzrlib.osutils import format_date
1488
supports_merge_revisions = True
1489
preferred_levels = 1
1490
supports_delta = True
1491
supports_tags = True
1492
supports_diff = True
1494
def __init__(self, *args, **kwargs):
1495
super(ShortLogFormatter, self).__init__(*args, **kwargs)
1496
self.revno_width_by_depth = {}
1498
def log_revision(self, revision):
1499
# We need two indents: one per depth and one for the information
1500
# relative to that indent. Most mainline revnos are 5 chars or
1501
# less while dotted revnos are typically 11 chars or less. Once
1502
# calculated, we need to remember the offset for a given depth
1503
# as we might be starting from a dotted revno in the first column
1504
# and we want subsequent mainline revisions to line up.
1505
depth = revision.merge_depth
1506
indent = ' ' * depth
1507
revno_width = self.revno_width_by_depth.get(depth)
1508
if revno_width is None:
1509
if revision.revno.find('.') == -1:
1510
# mainline revno, e.g. 12345
1513
# dotted revno, e.g. 12345.10.55
1515
self.revno_width_by_depth[depth] = revno_width
1516
offset = ' ' * (revno_width + 1)
405
1518
to_file = self.to_file
406
date_str = format_date(rev.timestamp, rev.timezone or 0,
408
print >>to_file, "%5d %s\t%s" % (revno, self.short_committer(rev),
409
format_date(rev.timestamp, rev.timezone or 0,
1521
tags = ' {%s}' % (', '.join(revision.tags))
1522
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1523
revision.revno, self.short_author(revision.rev),
1524
format_date(revision.rev.timestamp,
1525
revision.rev.timezone or 0,
410
1526
self.show_timezone, date_fmt="%Y-%m-%d",
1528
tags, self.merge_marker(revision)))
1529
self.show_foreign_info(revision.rev, indent+offset)
1530
self.show_properties(revision.rev, indent+offset)
412
1531
if self.show_ids:
413
print >>to_file, ' revision-id:', rev.revision_id
415
print >>to_file, ' (no message)'
1532
to_file.write(indent + offset + 'revision-id:%s\n'
1533
% (revision.rev.revision_id,))
1534
if not revision.rev.message:
1535
to_file.write(indent + offset + '(no message)\n')
417
message = rev.message.rstrip('\r\n')
1537
message = revision.rev.message.rstrip('\r\n')
418
1538
for l in message.split('\n'):
419
print >>to_file, ' ' + l
421
# TODO: Why not show the modified files in a shorter form as
422
# well? rewrap them single lines of appropriate length
424
delta.show(to_file, self.show_ids)
1539
to_file.write(indent + offset + '%s\n' % (l,))
1541
if revision.delta is not None:
1542
revision.delta.show(to_file, self.show_ids, indent=indent + offset,
1543
short_status=self.delta_format==1)
1544
if revision.diff is not None:
1545
self.show_diff(self.to_exact_file, revision.diff, ' ')
427
1549
class LineLogFormatter(LogFormatter):
1551
supports_merge_revisions = True
1552
preferred_levels = 1
1553
supports_tags = True
1555
def __init__(self, *args, **kwargs):
1556
super(LineLogFormatter, self).__init__(*args, **kwargs)
1557
self._max_chars = terminal_width() - 1
428
1559
def truncate(self, str, max_len):
429
1560
if len(str) <= max_len:
431
1562
return str[:max_len-3]+'...'
433
1564
def date_string(self, rev):
434
from bzrlib.osutils import format_date
435
return format_date(rev.timestamp, rev.timezone or 0,
1565
return format_date(rev.timestamp, rev.timezone or 0,
436
1566
self.show_timezone, date_fmt="%Y-%m-%d",
437
1567
show_offset=False)
added
removed
bzrlib/log.py
