155
133
start_revision=None,
156
134
end_revision=None,
160
137
"""Write out human-readable log of commits to this branch.
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(self.branch, self.start_rev_id,
459
self.end_rev_id, rqst.get('direction'), generate_merge_revisions,
460
delayed_graph_generation=delayed_graph_generation)
462
# Apply the other filters
463
return make_log_rev_iterator(self.branch, view_revisions,
464
rqst.get('delta_type'), rqst.get('message_search'),
465
file_ids=rqst.get('specific_fileids'),
466
direction=rqst.get('direction'))
468
def _log_revision_iterator_using_per_file_graph(self):
469
# Get the base revisions, filtering by the revision range.
470
# Note that we always generate the merge revisions because
471
# filter_revisions_touching_file_id() requires them ...
473
view_revisions = _calc_view_revisions(self.branch, self.start_rev_id,
474
self.end_rev_id, rqst.get('direction'), True)
475
if not isinstance(view_revisions, list):
476
view_revisions = list(view_revisions)
477
view_revisions = _filter_revisions_touching_file_id(self.branch,
478
rqst.get('specific_fileids')[0], view_revisions,
479
include_merges=rqst.get('levels') != 1)
480
return make_log_rev_iterator(self.branch, view_revisions,
481
rqst.get('delta_type'), rqst.get('message_search'))
484
def _calc_view_revisions(branch, start_rev_id, end_rev_id, direction,
485
generate_merge_revisions, delayed_graph_generation=False):
486
"""Calculate the revisions to view.
488
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
489
a list of the same tuples.
491
br_revno, br_rev_id = branch.last_revision_info()
495
# If a single revision is requested, check we can handle it
496
generate_single_revision = (end_rev_id and start_rev_id == end_rev_id and
497
(not generate_merge_revisions or not _has_merges(branch, end_rev_id)))
498
if generate_single_revision:
499
return _generate_one_revision(branch, end_rev_id, br_rev_id, br_revno)
501
# If we only want to see linear revisions, we can iterate ...
502
if not generate_merge_revisions:
503
return _generate_flat_revisions(branch, start_rev_id, end_rev_id,
506
return _generate_all_revisions(branch, start_rev_id, end_rev_id,
507
direction, delayed_graph_generation)
510
def _generate_one_revision(branch, rev_id, br_rev_id, br_revno):
511
if rev_id == br_rev_id:
513
return [(br_rev_id, br_revno, 0)]
515
revno = branch.revision_id_to_dotted_revno(rev_id)
516
revno_str = '.'.join(str(n) for n in revno)
517
return [(rev_id, revno_str, 0)]
520
def _generate_flat_revisions(branch, start_rev_id, end_rev_id, direction):
521
result = _linear_view_revisions(branch, start_rev_id, end_rev_id)
522
# If a start limit was given and it's not obviously an
523
# ancestor of the end limit, check it before outputting anything
524
if direction == 'forward' or (start_rev_id
525
and not _is_obvious_ancestor(branch, start_rev_id, end_rev_id)):
527
result = list(result)
528
except _StartNotLinearAncestor:
529
raise errors.BzrCommandError('Start revision not found in'
530
' left-hand history of end revision.')
531
if direction == 'forward':
532
result = reversed(result)
536
def _generate_all_revisions(branch, start_rev_id, end_rev_id, direction,
537
delayed_graph_generation):
538
# On large trees, generating the merge graph can take 30-60 seconds
539
# so we delay doing it until a merge is detected, incrementally
540
# returning initial (non-merge) revisions while we can.
542
# The above is only true for old formats (<= 0.92), for newer formats, a
543
# couple of seconds only should be needed to load the whole graph and the
544
# other graph operations needed are even faster than that -- vila 100201
545
initial_revisions = []
546
if delayed_graph_generation:
548
for rev_id, revno, depth in _linear_view_revisions(
549
branch, start_rev_id, end_rev_id):
550
if _has_merges(branch, rev_id):
551
# The end_rev_id can be nested down somewhere. We need an
552
# explicit ancestry check. There is an ambiguity here as we
553
# may not raise _StartNotLinearAncestor for a revision that
554
# is an ancestor but not a *linear* one. But since we have
555
# loaded the graph to do the check (or calculate a dotted
556
# revno), we may as well accept to show the log...
558
graph = branch.repository.get_graph()
559
if not graph.is_ancestor(start_rev_id, end_rev_id):
560
raise _StartNotLinearAncestor()
564
initial_revisions.append((rev_id, revno, depth))
566
# No merged revisions found
567
if direction == 'reverse':
568
return initial_revisions
569
elif direction == 'forward':
570
return reversed(initial_revisions)
572
raise ValueError('invalid direction %r' % direction)
573
except _StartNotLinearAncestor:
574
# A merge was never detected so the lower revision limit can't
575
# be nested down somewhere
576
raise errors.BzrCommandError('Start revision not found in'
577
' history of end revision.')
579
# A log including nested merges is required. If the direction is reverse,
580
# we rebase the initial merge depths so that the development line is
581
# shown naturally, i.e. just like it is for linear logging. We can easily
582
# make forward the exact opposite display, but showing the merge revisions
583
# indented at the end seems slightly nicer in that case.
584
view_revisions = chain(iter(initial_revisions),
585
_graph_view_revisions(branch, start_rev_id, end_rev_id,
586
rebase_initial_depths=direction == 'reverse'))
587
if direction == 'reverse':
588
return view_revisions
589
elif direction == 'forward':
590
# Forward means oldest first, adjusting for depth.
591
view_revisions = reverse_by_depth(list(view_revisions))
592
return _rebase_merge_depth(view_revisions)
594
raise ValueError('invalid direction %r' % direction)
597
def _has_merges(branch, rev_id):
598
"""Does a revision have multiple parents or not?"""
599
parents = branch.repository.get_parent_map([rev_id]).get(rev_id, [])
600
return len(parents) > 1
603
def _is_obvious_ancestor(branch, start_rev_id, end_rev_id):
604
"""Is start_rev_id an obvious ancestor of end_rev_id?"""
605
if start_rev_id and end_rev_id:
606
start_dotted = branch.revision_id_to_dotted_revno(start_rev_id)
607
end_dotted = branch.revision_id_to_dotted_revno(end_rev_id)
608
if len(start_dotted) == 1 and len(end_dotted) == 1:
610
return start_dotted[0] <= end_dotted[0]
611
elif (len(start_dotted) == 3 and len(end_dotted) == 3 and
612
start_dotted[0:1] == end_dotted[0:1]):
613
# both on same development line
614
return start_dotted[2] <= end_dotted[2]
618
# if either start or end is not specified then we use either the first or
619
# the last revision and *they* are obvious ancestors.
623
def _linear_view_revisions(branch, start_rev_id, end_rev_id):
624
"""Calculate a sequence of revisions to view, newest to oldest.
626
:param start_rev_id: the lower revision-id
627
:param end_rev_id: the upper revision-id
628
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
629
:raises _StartNotLinearAncestor: if a start_rev_id is specified but
630
is not found walking the left-hand history
632
br_revno, br_rev_id = branch.last_revision_info()
633
repo = branch.repository
634
if start_rev_id is None and end_rev_id is None:
636
for revision_id in repo.iter_reverse_revision_history(br_rev_id):
637
yield revision_id, str(cur_revno), 0
640
if end_rev_id is None:
641
end_rev_id = br_rev_id
642
found_start = start_rev_id is None
643
for revision_id in repo.iter_reverse_revision_history(end_rev_id):
644
revno = branch.revision_id_to_dotted_revno(revision_id)
645
revno_str = '.'.join(str(n) for n in revno)
646
if not found_start and revision_id == start_rev_id:
647
yield revision_id, revno_str, 0
651
yield revision_id, revno_str, 0
654
raise _StartNotLinearAncestor()
657
def _graph_view_revisions(branch, start_rev_id, end_rev_id,
658
rebase_initial_depths=True):
659
"""Calculate revisions to view including merges, newest to oldest.
661
:param branch: the branch
662
:param start_rev_id: the lower revision-id
663
:param end_rev_id: the upper revision-id
664
:param rebase_initial_depth: should depths be rebased until a mainline
666
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples.
668
view_revisions = branch.iter_merge_sorted_revisions(
669
start_revision_id=end_rev_id, stop_revision_id=start_rev_id,
670
stop_rule="with-merges")
671
if not rebase_initial_depths:
672
for (rev_id, merge_depth, revno, end_of_merge
674
yield rev_id, '.'.join(map(str, revno)), merge_depth
676
# We're following a development line starting at a merged revision.
677
# We need to adjust depths down by the initial depth until we find
678
# a depth less than it. Then we use that depth as the adjustment.
679
# If and when we reach the mainline, depth adjustment ends.
680
depth_adjustment = None
681
for (rev_id, merge_depth, revno, end_of_merge
683
if depth_adjustment is None:
684
depth_adjustment = merge_depth
686
if merge_depth < depth_adjustment:
687
# From now on we reduce the depth adjustement, this can be
688
# surprising for users. The alternative requires two passes
689
# which breaks the fast display of the first revision
691
depth_adjustment = merge_depth
692
merge_depth -= depth_adjustment
693
yield rev_id, '.'.join(map(str, revno)), merge_depth
696
@deprecated_function(deprecated_in((2, 2, 0)))
697
def calculate_view_revisions(branch, start_revision, end_revision, direction,
698
specific_fileid, generate_merge_revisions):
699
"""Calculate the revisions to view.
701
:return: An iterator of (revision_id, dotted_revno, merge_depth) tuples OR
702
a list of the same tuples.
704
start_rev_id, end_rev_id = _get_revision_limits(branch, start_revision,
706
view_revisions = list(_calc_view_revisions(branch, start_rev_id, end_rev_id,
707
direction, generate_merge_revisions or specific_fileid))
140
LogFormatter object to show the output.
143
If true, list only the commits affecting the specified
144
file, rather than all commits.
147
If true show added/changed/deleted/renamed files.
150
'reverse' (default) is latest to earliest;
151
'forward' is earliest to latest.
154
If not None, only show revisions >= start_revision
157
If not None, only show revisions <= end_revision
160
If not None, only show revisions with matching commit messages
163
If not None or 0, only show limit revisions
167
if getattr(lf, 'begin_log', None):
170
_show_log(branch, lf, specific_fileid, verbose, direction,
171
start_revision, end_revision, search, limit)
173
if getattr(lf, 'end_log', None):
178
def _show_log(branch,
180
specific_fileid=None,
187
"""Worker function for show_log - see show_log."""
188
from bzrlib.osutils import format_date
189
from bzrlib.errors import BzrCheckError
191
from warnings import warn
193
if not isinstance(lf, LogFormatter):
194
warn("not a LogFormatter instance: %r" % lf)
708
196
if specific_fileid:
709
view_revisions = _filter_revisions_touching_file_id(branch,
710
specific_fileid, view_revisions,
711
include_merges=generate_merge_revisions)
712
return _rebase_merge_depth(view_revisions)
715
def _rebase_merge_depth(view_revisions):
716
"""Adjust depths upwards so the top level is 0."""
717
# If either the first or last revision have a merge_depth of 0, we're done
718
if view_revisions and view_revisions[0][2] and view_revisions[-1][2]:
719
min_depth = min([d for r,n,d in view_revisions])
721
view_revisions = [(r,n,d-min_depth) for r,n,d in view_revisions]
722
return view_revisions
725
def make_log_rev_iterator(branch, view_revisions, generate_delta, search,
726
file_ids=None, direction='reverse'):
727
"""Create a revision iterator for log.
729
:param branch: The branch being logged.
730
:param view_revisions: The revisions being viewed.
731
:param generate_delta: Whether to generate a delta for each revision.
732
Permitted values are None, 'full' and 'partial'.
733
:param search: A user text search string.
734
:param file_ids: If non empty, only revisions matching one or more of
735
the file-ids are to be kept.
736
:param direction: the direction in which view_revisions is sorted
737
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
740
# Convert view_revisions into (view, None, None) groups to fit with
741
# the standard interface here.
742
if type(view_revisions) == list:
743
# A single batch conversion is faster than many incremental ones.
744
# As we have all the data, do a batch conversion.
745
nones = [None] * len(view_revisions)
746
log_rev_iterator = iter([zip(view_revisions, nones, nones)])
749
for view in view_revisions:
750
yield (view, None, None)
751
log_rev_iterator = iter([_convert()])
752
for adapter in log_adapters:
753
# It would be nicer if log adapters were first class objects
754
# with custom parameters. This will do for now. IGC 20090127
755
if adapter == _make_delta_filter:
756
log_rev_iterator = adapter(branch, generate_delta,
757
search, log_rev_iterator, file_ids, direction)
759
log_rev_iterator = adapter(branch, generate_delta,
760
search, log_rev_iterator)
761
return log_rev_iterator
764
def _make_search_filter(branch, generate_delta, search, log_rev_iterator):
765
"""Create a filtered iterator of log_rev_iterator matching on a regex.
767
:param branch: The branch being logged.
768
:param generate_delta: Whether to generate a delta for each revision.
769
:param search: A user text search string.
770
:param log_rev_iterator: An input iterator containing all revisions that
771
could be displayed, in lists.
772
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
776
return log_rev_iterator
777
searchRE = re_compile_checked(search, re.IGNORECASE,
778
'log message filter')
779
return _filter_message_re(searchRE, log_rev_iterator)
782
def _filter_message_re(searchRE, log_rev_iterator):
783
for revs in log_rev_iterator:
785
for (rev_id, revno, merge_depth), rev, delta in revs:
786
if searchRE.search(rev.message):
787
new_revs.append(((rev_id, revno, merge_depth), rev, delta))
791
def _make_delta_filter(branch, generate_delta, search, log_rev_iterator,
792
fileids=None, direction='reverse'):
793
"""Add revision deltas to a log iterator if needed.
795
:param branch: The branch being logged.
796
:param generate_delta: Whether to generate a delta for each revision.
797
Permitted values are None, 'full' and 'partial'.
798
:param search: A user text search string.
799
:param log_rev_iterator: An input iterator containing all revisions that
800
could be displayed, in lists.
801
:param fileids: If non empty, only revisions matching one or more of
802
the file-ids are to be kept.
803
:param direction: the direction in which view_revisions is sorted
804
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
807
if not generate_delta and not fileids:
808
return log_rev_iterator
809
return _generate_deltas(branch.repository, log_rev_iterator,
810
generate_delta, fileids, direction)
813
def _generate_deltas(repository, log_rev_iterator, delta_type, fileids,
815
"""Create deltas for each batch of revisions in log_rev_iterator.
817
If we're only generating deltas for the sake of filtering against
818
file-ids, we stop generating deltas once all file-ids reach the
819
appropriate life-cycle point. If we're receiving data newest to
820
oldest, then that life-cycle point is 'add', otherwise it's 'remove'.
822
check_fileids = fileids is not None and len(fileids) > 0
824
fileid_set = set(fileids)
825
if direction == 'reverse':
831
for revs in log_rev_iterator:
832
# If we were matching against fileids and we've run out,
833
# there's nothing left to do
834
if check_fileids and not fileid_set:
836
revisions = [rev[1] for rev in revs]
838
if delta_type == 'full' and not check_fileids:
839
deltas = repository.get_deltas_for_revisions(revisions)
840
for rev, delta in izip(revs, deltas):
841
new_revs.append((rev[0], rev[1], delta))
843
deltas = repository.get_deltas_for_revisions(revisions, fileid_set)
844
for rev, delta in izip(revs, deltas):
846
if delta is None or not delta.has_changed():
849
_update_fileids(delta, fileid_set, stop_on)
850
if delta_type is None:
852
elif delta_type == 'full':
853
# If the file matches all the time, rebuilding
854
# a full delta like this in addition to a partial
855
# one could be slow. However, it's likely that
856
# most revisions won't get this far, making it
857
# faster to filter on the partial deltas and
858
# build the occasional full delta than always
859
# building full deltas and filtering those.
861
delta = repository.get_revision_delta(rev_id)
862
new_revs.append((rev[0], rev[1], delta))
866
def _update_fileids(delta, fileids, stop_on):
867
"""Update the set of file-ids to search based on file lifecycle events.
869
:param fileids: a set of fileids to update
870
:param stop_on: either 'add' or 'remove' - take file-ids out of the
871
fileids set once their add or remove entry is detected respectively
874
for item in delta.added:
875
if item[1] in fileids:
876
fileids.remove(item[1])
877
elif stop_on == 'delete':
878
for item in delta.removed:
879
if item[1] in fileids:
880
fileids.remove(item[1])
883
def _make_revision_objects(branch, generate_delta, search, log_rev_iterator):
884
"""Extract revision objects from the repository
886
:param branch: The branch being logged.
887
:param generate_delta: Whether to generate a delta for each revision.
888
:param search: A user text search string.
889
:param log_rev_iterator: An input iterator containing all revisions that
890
could be displayed, in lists.
891
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
894
repository = branch.repository
895
for revs in log_rev_iterator:
896
# r = revision_id, n = revno, d = merge depth
897
revision_ids = [view[0] for view, _, _ in revs]
898
revisions = repository.get_revisions(revision_ids)
899
revs = [(rev[0], revision, rev[2]) for rev, revision in
900
izip(revs, revisions)]
904
def _make_batch_filter(branch, generate_delta, search, log_rev_iterator):
905
"""Group up a single large batch into smaller ones.
907
:param branch: The branch being logged.
908
:param generate_delta: Whether to generate a delta for each revision.
909
:param search: A user text search string.
910
:param log_rev_iterator: An input iterator containing all revisions that
911
could be displayed, in lists.
912
:return: An iterator over lists of ((rev_id, revno, merge_depth), rev,
915
repository = branch.repository
917
for batch in log_rev_iterator:
920
step = [detail for _, detail in zip(range(num), batch)]
924
num = min(int(num * 1.5), 200)
927
def _get_revision_limits(branch, start_revision, end_revision):
928
"""Get and check revision limits.
930
:param branch: The branch containing the revisions.
932
:param start_revision: The first revision to be logged.
933
For backwards compatibility this may be a mainline integer revno,
934
but for merge revision support a RevisionInfo is expected.
936
:param end_revision: The last 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
:return: (start_rev_id, end_rev_id) tuple.
942
branch_revno, branch_rev_id = branch.last_revision_info()
944
if start_revision is None:
947
if isinstance(start_revision, revisionspec.RevisionInfo):
948
start_rev_id = start_revision.rev_id
949
start_revno = start_revision.revno or 1
951
branch.check_real_revno(start_revision)
952
start_revno = start_revision
953
start_rev_id = branch.get_rev_id(start_revno)
956
if end_revision is None:
957
end_revno = branch_revno
959
if isinstance(end_revision, revisionspec.RevisionInfo):
960
end_rev_id = end_revision.rev_id
961
end_revno = end_revision.revno or branch_revno
963
branch.check_real_revno(end_revision)
964
end_revno = end_revision
965
end_rev_id = branch.get_rev_id(end_revno)
967
if branch_revno != 0:
968
if (start_rev_id == _mod_revision.NULL_REVISION
969
or end_rev_id == _mod_revision.NULL_REVISION):
970
raise errors.BzrCommandError('Logging revision 0 is invalid.')
971
if start_revno > end_revno:
972
raise errors.BzrCommandError("Start revision must be older than "
974
return (start_rev_id, end_rev_id)
977
def _get_mainline_revs(branch, start_revision, end_revision):
978
"""Get the mainline revisions from the branch.
980
Generates the list of mainline revisions for the branch.
982
:param branch: The branch containing the revisions.
984
:param start_revision: The first revision to be logged.
985
For backwards compatibility this may be a mainline integer revno,
986
but for merge revision support a RevisionInfo is expected.
988
:param end_revision: The last 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
:return: A (mainline_revs, rev_nos, start_rev_id, end_rev_id) tuple.
994
branch_revno, branch_last_revision = branch.last_revision_info()
995
if branch_revno == 0:
996
return None, None, None, None
998
# For mainline generation, map start_revision and end_revision to
999
# mainline revnos. If the revision is not on the mainline choose the
1000
# appropriate extreme of the mainline instead - the extra will be
1002
# Also map the revisions to rev_ids, to be used in the later filtering
1005
if start_revision is None:
1008
if isinstance(start_revision, revisionspec.RevisionInfo):
1009
start_rev_id = start_revision.rev_id
1010
start_revno = start_revision.revno or 1
1012
branch.check_real_revno(start_revision)
1013
start_revno = start_revision
1016
if end_revision is None:
1017
end_revno = branch_revno
1019
if isinstance(end_revision, revisionspec.RevisionInfo):
1020
end_rev_id = end_revision.rev_id
1021
end_revno = end_revision.revno or branch_revno
1023
branch.check_real_revno(end_revision)
1024
end_revno = end_revision
1026
if ((start_rev_id == _mod_revision.NULL_REVISION)
1027
or (end_rev_id == _mod_revision.NULL_REVISION)):
1028
raise errors.BzrCommandError('Logging revision 0 is invalid.')
1029
if start_revno > end_revno:
1030
raise errors.BzrCommandError("Start revision must be older than "
1031
"the end revision.")
1033
if end_revno < start_revno:
1034
return None, None, None, None
1035
cur_revno = branch_revno
1038
for revision_id in branch.repository.iter_reverse_revision_history(
1039
branch_last_revision):
1040
if cur_revno < start_revno:
1041
# We have gone far enough, but we always add 1 more revision
1042
rev_nos[revision_id] = cur_revno
1043
mainline_revs.append(revision_id)
1045
if cur_revno <= end_revno:
1046
rev_nos[revision_id] = cur_revno
1047
mainline_revs.append(revision_id)
1050
# We walked off the edge of all revisions, so we add a 'None' marker
1051
mainline_revs.append(None)
1053
mainline_revs.reverse()
197
mutter('get log for file_id %r', specific_fileid)
199
if search is not None:
201
searchRE = re.compile(search, re.IGNORECASE)
205
which_revs = _enumerate_history(branch)
207
if start_revision is None:
210
branch.check_real_revno(start_revision)
212
if end_revision is None:
213
end_revision = len(which_revs)
215
branch.check_real_revno(end_revision)
217
# list indexes are 0-based; revisions are 1-based
218
cut_revs = which_revs[(start_revision-1):(end_revision)]
222
# convert the revision history to a dictionary:
223
rev_nos = dict((k, v) for v, k in cut_revs)
1055
225
# override the mainline to look like the revision history.
1056
return mainline_revs, rev_nos, start_rev_id, end_rev_id
1059
@deprecated_function(deprecated_in((2, 2, 0)))
1060
def _filter_revision_range(view_revisions, start_rev_id, end_rev_id):
1061
"""Filter view_revisions based on revision ranges.
1063
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1064
tuples to be filtered.
1066
:param start_rev_id: If not NONE specifies the first revision to be logged.
1067
If NONE then all revisions up to the end_rev_id are logged.
1069
:param end_rev_id: If not NONE specifies the last revision to be logged.
1070
If NONE then all revisions up to the end of the log are logged.
1072
:return: The filtered view_revisions.
1074
if start_rev_id or end_rev_id:
226
mainline_revs = [revision_id for index, revision_id in cut_revs]
227
if cut_revs[0][0] == 1:
228
mainline_revs.insert(0, None)
230
mainline_revs.insert(0, which_revs[start_revision-2][1])
231
legacy_lf = getattr(lf, 'log_revision', None) is None
233
# pre-0.17 formatters use show for mainline revisions.
234
# how should we show merged revisions ?
235
# pre-0.11 api: show_merge
236
# 0.11-0.16 api: show_merge_revno
237
show_merge_revno = getattr(lf, 'show_merge_revno', None)
238
show_merge = getattr(lf, 'show_merge', None)
239
if show_merge is None and show_merge_revno is None:
240
# no merged-revno support
241
generate_merge_revisions = False
243
generate_merge_revisions = True
244
# tell developers to update their code
245
symbol_versioning.warn('LogFormatters should provide log_revision '
246
'instead of show and show_merge_revno since bzr 0.17.',
247
DeprecationWarning, stacklevel=3)
249
generate_merge_revisions = getattr(lf, 'supports_merge_revisions',
251
view_revs_iter = get_view_revisions(mainline_revs, rev_nos, branch,
252
direction, include_merges=generate_merge_revisions)
254
view_revisions = _get_revisions_touching_file_id(branch,
259
view_revisions = list(view_revs_iter)
262
generate_tags = getattr(lf, 'supports_tags', False)
264
if branch.supports_tags():
265
rev_tag_dict = branch.tags.get_reverse_tag_dict()
267
generate_delta = verbose and getattr(lf, 'supports_delta', False)
269
def iter_revisions():
270
# r = revision, n = revno, d = merge depth
1075
271
revision_ids = [r for r, n, d in view_revisions]
1077
start_index = revision_ids.index(start_rev_id)
1080
if start_rev_id == end_rev_id:
1081
end_index = start_index
1084
end_index = revision_ids.index(end_rev_id)
272
zeros = set(r for r, n, d in view_revisions if d == 0)
274
repository = branch.repository
277
revisions = repository.get_revisions(revision_ids[:num])
279
delta_revisions = [r for r in revisions if
280
r.revision_id in zeros]
281
deltas = repository.get_deltas_for_revisions(delta_revisions)
282
cur_deltas = dict(izip((r.revision_id for r in
283
delta_revisions), deltas))
284
for revision in revisions:
285
# The delta value will be None unless
286
# 1. verbose is specified, and
287
# 2. the revision is a mainline revision
288
yield revision, cur_deltas.get(revision.revision_id)
289
revision_ids = revision_ids[num:]
290
num = min(int(num * 1.5), 200)
292
# now we just print all the revisions
294
for ((rev_id, revno, merge_depth), (rev, delta)) in \
295
izip(view_revisions, iter_revisions()):
298
if not searchRE.search(rev.message):
302
lr = LogRevision(rev, revno, merge_depth, delta,
303
rev_tag_dict.get(rev_id))
306
# support for legacy (pre-0.17) LogFormatters
309
lf.show(revno, rev, delta, rev_tag_dict.get(rev_id))
311
lf.show(revno, rev, delta)
1086
end_index = len(view_revisions) - 1
1087
# To include the revisions merged into the last revision,
1088
# extend end_rev_id down to, but not including, the next rev
1089
# with the same or lesser merge_depth
1090
end_merge_depth = view_revisions[end_index][2]
1092
for index in xrange(end_index+1, len(view_revisions)+1):
1093
if view_revisions[index][2] <= end_merge_depth:
1094
end_index = index - 1
1097
# if the search falls off the end then log to the end as well
1098
end_index = len(view_revisions) - 1
1099
view_revisions = view_revisions[start_index:end_index+1]
1100
return view_revisions
1103
def _filter_revisions_touching_file_id(branch, file_id, view_revisions,
1104
include_merges=True):
1105
r"""Return the list of revision ids which touch a given file id.
1107
The function filters view_revisions and returns a subset.
313
if show_merge_revno is None:
314
lf.show_merge(rev, merge_depth)
317
lf.show_merge_revno(rev, merge_depth, revno,
318
rev_tag_dict.get(rev_id))
320
lf.show_merge_revno(rev, merge_depth, revno)
323
if log_count >= limit:
327
def _get_revisions_touching_file_id(branch, file_id, mainline_revisions,
329
"""Return the list of revision ids which touch a given file id.
1108
331
This includes the revisions which directly change the file id,
1109
332
and the revisions which merge these changes. So if the
1110
333
revision graph is::
1121
And 'C' changes a file, then both C and D will be returned. F will not be
1122
returned even though it brings the changes to C into the branch starting
1123
with E. (Note that if we were using F as the tip instead of G, then we
1126
This will also be restricted based on a subset of the mainline.
1128
:param branch: The branch where we can get text revision information.
1130
:param file_id: Filter out revisions that do not touch file_id.
1132
:param view_revisions: A list of (revision_id, dotted_revno, merge_depth)
1133
tuples. This is the list of revisions which will be filtered. It is
1134
assumed that view_revisions is in merge_sort order (i.e. newest
1137
:param include_merges: include merge revisions in the result or not
340
And 'C' changes a file, then both C and D will be returned.
342
This will also can be restricted based on a subset of the mainline.
1139
344
:return: A list of (revision_id, dotted_revno, merge_depth) tuples.
1141
# Lookup all possible text keys to determine which ones actually modified
1143
text_keys = [(file_id, rev_id) for rev_id, revno, depth in view_revisions]
1145
# Looking up keys in batches of 1000 can cut the time in half, as well as
1146
# memory consumption. GraphIndex *does* like to look for a few keys in
1147
# parallel, it just doesn't like looking for *lots* of keys in parallel.
1148
# TODO: This code needs to be re-evaluated periodically as we tune the
1149
# indexing layer. We might consider passing in hints as to the known
1150
# access pattern (sparse/clustered, high success rate/low success
1151
# rate). This particular access is clustered with a low success rate.
1152
get_parent_map = branch.repository.texts.get_parent_map
1153
modified_text_revisions = set()
1155
for start in xrange(0, len(text_keys), chunk_size):
1156
next_keys = text_keys[start:start + chunk_size]
1157
# Only keep the revision_id portion of the key
1158
modified_text_revisions.update(
1159
[k[1] for k in get_parent_map(next_keys)])
1160
del text_keys, next_keys
1163
# Track what revisions will merge the current revision, replace entries
1164
# with 'None' when they have been added to result
1165
current_merge_stack = [None]
1166
for info in view_revisions:
1167
rev_id, revno, depth = info
1168
if depth == len(current_merge_stack):
1169
current_merge_stack.append(info)
346
# find all the revisions that change the specific file
347
file_weave = branch.repository.weave_store.get_weave(file_id,
348
branch.repository.get_transaction())
349
weave_modifed_revisions = set(file_weave.versions())
350
# build the ancestry of each revision in the graph
351
# - only listing the ancestors that change the specific file.
352
rev_graph = branch.repository.get_revision_graph(mainline_revisions[-1])
353
sorted_rev_list = topo_sort(rev_graph)
355
for rev in sorted_rev_list:
356
parents = rev_graph[rev]
357
if rev not in weave_modifed_revisions and len(parents) == 1:
358
# We will not be adding anything new, so just use a reference to
359
# the parent ancestry.
360
rev_ancestry = ancestry[parents[0]]
1171
del current_merge_stack[depth + 1:]
1172
current_merge_stack[-1] = info
1174
if rev_id in modified_text_revisions:
1175
# This needs to be logged, along with the extra revisions
1176
for idx in xrange(len(current_merge_stack)):
1177
node = current_merge_stack[idx]
1178
if node is not None:
1179
if include_merges or node[2] == 0:
1181
current_merge_stack[idx] = None
1185
@deprecated_function(deprecated_in((2, 2, 0)))
363
if rev in weave_modifed_revisions:
364
rev_ancestry.add(rev)
365
for parent in parents:
366
rev_ancestry = rev_ancestry.union(ancestry[parent])
367
ancestry[rev] = rev_ancestry
369
def is_merging_rev(r):
370
parents = rev_graph[r]
372
leftparent = parents[0]
373
for rightparent in parents[1:]:
374
if not ancestry[leftparent].issuperset(
375
ancestry[rightparent]):
379
# filter from the view the revisions that did not change or merge
381
return [(r, n, d) for r, n, d in view_revs_iter
382
if r in weave_modifed_revisions or is_merging_rev(r)]
1186
385
def get_view_revisions(mainline_revs, rev_nos, branch, direction,
1187
386
include_merges=True):
1188
387
"""Produce an iterator of revisions to show
1189
388
:return: an iterator of (revision_id, revno, merge_depth)
1190
389
(if there is no revno for a revision, None is supplied)
1192
if not include_merges:
391
if include_merges is False:
1193
392
revision_ids = mainline_revs[1:]
1194
393
if direction == 'reverse':
1195
394
revision_ids.reverse()
1196
395
for revision_id in revision_ids:
1197
396
yield revision_id, str(rev_nos[revision_id]), 0
1199
graph = branch.repository.get_graph()
1200
# This asks for all mainline revisions, which means we only have to spider
1201
# sideways, rather than depth history. That said, its still size-of-history
1202
# and should be addressed.
1203
# mainline_revisions always includes an extra revision at the beginning, so
1205
parent_map = dict(((key, value) for key, value in
1206
graph.iter_ancestry(mainline_revs[1:]) if value is not None))
1207
# filter out ghosts; merge_sort errors on ghosts.
1208
rev_graph = _mod_repository._strip_NULL_ghosts(parent_map)
1209
merge_sorted_revisions = tsort.merge_sort(
398
merge_sorted_revisions = merge_sort(
399
branch.repository.get_revision_graph(mainline_revs[-1]),
1211
400
mainline_revs[-1],
1213
402
generate_revno=True)
1280
460
If the LogFormatter needs to be informed of the beginning or end of
1281
461
a log it should implement the begin_log and/or end_log hook methods.
1283
A LogFormatter should define the following supports_XXX flags
463
A LogFormatter should define the following supports_XXX flags
1284
464
to indicate which LogRevision attributes it supports:
1286
466
- supports_delta must be True if this log formatter supports delta.
1287
Otherwise the delta attribute may not be populated. The 'delta_format'
1288
attribute describes whether the 'short_status' format (1) or the long
1289
one (2) should be used.
1291
- supports_merge_revisions must be True if this log formatter supports
1292
merge revisions. If not, then only mainline revisions will be passed
1295
- preferred_levels is the number of levels this formatter defaults to.
1296
The default value is zero meaning display all levels.
1297
This value is only relevant if supports_merge_revisions is True.
467
Otherwise the delta attribute may not be populated.
468
- supports_merge_revisions must be True if this log formatter supports
469
merge revisions. If not, only revisions mainline revisions (those
470
with merge_depth == 0) will be passed to the formatter.
1299
471
- supports_tags must be True if this log formatter supports tags.
1300
472
Otherwise the tags attribute may not be populated.
1302
- supports_diff must be True if this log formatter supports diffs.
1303
Otherwise the diff attribute may not be populated.
1305
Plugins can register functions to show custom revision properties using
1306
the properties_handler_registry. The registered function
1307
must respect the following interface description:
1308
def my_show_properties(properties_dict):
1309
# code that returns a dict {'name':'value'} of the properties
1312
preferred_levels = 0
1314
def __init__(self, to_file, show_ids=False, show_timezone='original',
1315
delta_format=None, levels=None, show_advice=False,
1316
to_exact_file=None):
1317
"""Create a LogFormatter.
1319
:param to_file: the file to output to
1320
:param to_exact_file: if set, gives an output stream to which
1321
non-Unicode diffs are written.
1322
:param show_ids: if True, revision-ids are to be displayed
1323
:param show_timezone: the timezone to use
1324
:param delta_format: the level of delta information to display
1325
or None to leave it to the formatter to decide
1326
:param levels: the number of levels to display; None or -1 to
1327
let the log formatter decide.
1328
:param show_advice: whether to show advice at the end of the
475
def __init__(self, to_file, show_ids=False, show_timezone='original'):
1331
476
self.to_file = to_file
1332
# 'exact' stream used to show diff, it should print content 'as is'
1333
# and should not try to decode/encode it to unicode to avoid bug #328007
1334
if to_exact_file is not None:
1335
self.to_exact_file = to_exact_file
1337
# XXX: somewhat hacky; this assumes it's a codec writer; it's better
1338
# for code that expects to get diffs to pass in the exact file
1340
self.to_exact_file = getattr(to_file, 'stream', to_file)
1341
477
self.show_ids = show_ids
1342
478
self.show_timezone = show_timezone
1343
if delta_format is None:
1344
# Ensures backward compatibility
1345
delta_format = 2 # long format
1346
self.delta_format = delta_format
1347
self.levels = levels
1348
self._show_advice = show_advice
1349
self._merge_count = 0
1351
def get_levels(self):
1352
"""Get the number of levels to display or 0 for all."""
1353
if getattr(self, 'supports_merge_revisions', False):
1354
if self.levels is None or self.levels == -1:
1355
self.levels = self.preferred_levels
1360
def log_revision(self, revision):
1363
:param revision: The LogRevision to be logged.
480
# TODO: uncomment this block after show() has been removed.
481
# Until then defining log_revision would prevent _show_log calling show()
482
# in legacy formatters.
483
# def log_revision(self, revision):
486
# :param revision: The LogRevision to be logged.
488
# raise NotImplementedError('not implemented in abstract base')
490
@deprecated_method(zero_seventeen)
491
def show(self, revno, rev, delta):
1365
492
raise NotImplementedError('not implemented in abstract base')
1367
def show_advice(self):
1368
"""Output user advice, if any, when the log is completed."""
1369
if self._show_advice and self.levels == 1 and self._merge_count > 0:
1370
advice_sep = self.get_advice_separator()
1372
self.to_file.write(advice_sep)
1374
"Use --include-merges or -n0 to see merged revisions.\n")
1376
def get_advice_separator(self):
1377
"""Get the text separating the log from the closing advice."""
1380
494
def short_committer(self, rev):
1381
name, address = config.parse_username(rev.committer)
1386
def short_author(self, rev):
1387
name, address = config.parse_username(rev.get_apparent_authors()[0])
1392
def merge_marker(self, revision):
1393
"""Get the merge marker to include in the output or '' if none."""
1394
if len(revision.rev.parent_ids) > 1:
1395
self._merge_count += 1
1400
def show_properties(self, revision, indent):
1401
"""Displays the custom properties returned by each registered handler.
1403
If a registered handler raises an error it is propagated.
1405
for line in self.custom_properties(revision):
1406
self.to_file.write("%s%s\n" % (indent, line))
1408
def custom_properties(self, revision):
1409
"""Format the custom properties returned by each registered handler.
1411
If a registered handler raises an error it is propagated.
1413
:return: a list of formatted lines (excluding trailing newlines)
1415
lines = self._foreign_info_properties(revision)
1416
for key, handler in properties_handler_registry.iteritems():
1417
lines.extend(self._format_properties(handler(revision)))
1420
def _foreign_info_properties(self, rev):
1421
"""Custom log displayer for foreign revision identifiers.
1423
:param rev: Revision object.
1425
# Revision comes directly from a foreign repository
1426
if isinstance(rev, foreign.ForeignRevision):
1427
return rev.mapping.vcs.show_foreign_revid(rev.foreign_revid)
1429
# Imported foreign revision revision ids always contain :
1430
if not ":" in rev.revision_id:
1433
# Revision was once imported from a foreign repository
1435
foreign_revid, mapping = \
1436
foreign.foreign_vcs_registry.parse_revision_id(rev.revision_id)
1437
except errors.InvalidRevisionId:
1440
return self._format_properties(
1441
mapping.vcs.show_foreign_revid(foreign_revid))
1443
def _format_properties(self, properties):
1445
for key, value in properties.items():
1446
lines.append(key + ': ' + value)
1449
def show_diff(self, to_file, diff, indent):
1450
for l in diff.rstrip().split('\n'):
1451
to_file.write(indent + '%s\n' % (l,))
1454
# Separator between revisions in long format
1455
_LONG_SEP = '-' * 60
495
return re.sub('<.*@.*>', '', rev.committer).strip(' ')
1458
498
class LongLogFormatter(LogFormatter):
1460
500
supports_merge_revisions = True
1461
preferred_levels = 1
1462
501
supports_delta = True
1463
502
supports_tags = True
1464
supports_diff = True
1466
def __init__(self, *args, **kwargs):
1467
super(LongLogFormatter, self).__init__(*args, **kwargs)
1468
if self.show_timezone == 'original':
1469
self.date_string = self._date_string_original_timezone
1471
self.date_string = self._date_string_with_timezone
1473
def _date_string_with_timezone(self, rev):
1474
return format_date(rev.timestamp, rev.timezone or 0,
1477
def _date_string_original_timezone(self, rev):
1478
return format_date_with_offset_in_original_timezone(rev.timestamp,
504
@deprecated_method(zero_seventeen)
505
def show(self, revno, rev, delta, tags=None):
506
lr = LogRevision(rev, revno, 0, delta, tags)
507
return self.log_revision(lr)
509
@deprecated_method(zero_eleven)
510
def show_merge(self, rev, merge_depth):
511
lr = LogRevision(rev, merge_depth=merge_depth)
512
return self.log_revision(lr)
514
@deprecated_method(zero_seventeen)
515
def show_merge_revno(self, rev, merge_depth, revno, tags=None):
516
"""Show a merged revision rev, with merge_depth and a revno."""
517
lr = LogRevision(rev, revno, merge_depth, tags=tags)
518
return self.log_revision(lr)
1481
520
def log_revision(self, revision):
1482
521
"""Log a revision, either merged or not."""
1483
indent = ' ' * revision.merge_depth
522
from bzrlib.osutils import format_date
523
indent = ' '*revision.merge_depth
524
to_file = self.to_file
525
print >>to_file, indent+'-' * 60
1485
526
if revision.revno is not None:
1486
lines.append('revno: %s%s' % (revision.revno,
1487
self.merge_marker(revision)))
527
print >>to_file, indent+'revno:', revision.revno
1488
528
if revision.tags:
1489
lines.append('tags: %s' % (', '.join(revision.tags)))
529
print >>to_file, indent+'tags: %s' % (', '.join(revision.tags))
1490
530
if self.show_ids:
1491
lines.append('revision-id: %s' % (revision.rev.revision_id,))
531
print >>to_file, indent+'revision-id:', revision.rev.revision_id
1492
532
for parent_id in revision.rev.parent_ids:
1493
lines.append('parent: %s' % (parent_id,))
1494
lines.extend(self.custom_properties(revision.rev))
1496
committer = revision.rev.committer
1497
authors = revision.rev.get_apparent_authors()
1498
if authors != [committer]:
1499
lines.append('author: %s' % (", ".join(authors),))
1500
lines.append('committer: %s' % (committer,))
1502
branch_nick = revision.rev.properties.get('branch-nick', None)
1503
if branch_nick is not None:
1504
lines.append('branch nick: %s' % (branch_nick,))
1506
lines.append('timestamp: %s' % (self.date_string(revision.rev),))
1508
lines.append('message:')
533
print >>to_file, indent+'parent:', parent_id
534
print >>to_file, indent+'committer:', revision.rev.committer
537
print >>to_file, indent+'branch nick: %s' % \
538
revision.rev.properties['branch-nick']
541
date_str = format_date(revision.rev.timestamp,
542
revision.rev.timezone or 0,
544
print >>to_file, indent+'timestamp: %s' % date_str
546
print >>to_file, indent+'message:'
1509
547
if not revision.rev.message:
1510
lines.append(' (no message)')
548
print >>to_file, indent+' (no message)'
1512
550
message = revision.rev.message.rstrip('\r\n')
1513
551
for l in message.split('\n'):
1514
lines.append(' %s' % (l,))
1516
# Dump the output, appending the delta and diff if requested
1517
to_file = self.to_file
1518
to_file.write("%s%s\n" % (indent, ('\n' + indent).join(lines)))
552
print >>to_file, indent+' ' + l
1519
553
if revision.delta is not None:
1520
# We don't respect delta_format for compatibility
1521
revision.delta.show(to_file, self.show_ids, indent=indent,
1523
if revision.diff is not None:
1524
to_file.write(indent + 'diff:\n')
1526
# Note: we explicitly don't indent the diff (relative to the
1527
# revision information) so that the output can be fed to patch -p0
1528
self.show_diff(self.to_exact_file, revision.diff, indent)
1529
self.to_exact_file.flush()
1531
def get_advice_separator(self):
1532
"""Get the text separating the log from the closing advice."""
1533
return '-' * 60 + '\n'
554
revision.delta.show(to_file, self.show_ids)
1536
557
class ShortLogFormatter(LogFormatter):
1538
supports_merge_revisions = True
1539
preferred_levels = 1
1540
559
supports_delta = True
1541
supports_tags = True
1542
supports_diff = True
1544
def __init__(self, *args, **kwargs):
1545
super(ShortLogFormatter, self).__init__(*args, **kwargs)
1546
self.revno_width_by_depth = {}
561
@deprecated_method(zero_seventeen)
562
def show(self, revno, rev, delta):
563
lr = LogRevision(rev, revno, 0, delta)
564
return self.log_revision(lr)
1548
566
def log_revision(self, revision):
1549
# We need two indents: one per depth and one for the information
1550
# relative to that indent. Most mainline revnos are 5 chars or
1551
# less while dotted revnos are typically 11 chars or less. Once
1552
# calculated, we need to remember the offset for a given depth
1553
# as we might be starting from a dotted revno in the first column
1554
# and we want subsequent mainline revisions to line up.
1555
depth = revision.merge_depth
1556
indent = ' ' * depth
1557
revno_width = self.revno_width_by_depth.get(depth)
1558
if revno_width is None:
1559
if revision.revno.find('.') == -1:
1560
# mainline revno, e.g. 12345
1563
# dotted revno, e.g. 12345.10.55
1565
self.revno_width_by_depth[depth] = revno_width
1566
offset = ' ' * (revno_width + 1)
567
from bzrlib.osutils import format_date
1568
569
to_file = self.to_file
1571
tags = ' {%s}' % (', '.join(revision.tags))
1572
to_file.write(indent + "%*s %s\t%s%s%s\n" % (revno_width,
1573
revision.revno, self.short_author(revision.rev),
570
date_str = format_date(revision.rev.timestamp,
571
revision.rev.timezone or 0,
574
if len(revision.rev.parent_ids) > 1:
575
is_merge = ' [merge]'
576
print >>to_file, "%5s %s\t%s%s" % (revision.revno,
577
self.short_committer(revision.rev),
1574
578
format_date(revision.rev.timestamp,
1575
579
revision.rev.timezone or 0,
1576
580
self.show_timezone, date_fmt="%Y-%m-%d",
1577
581
show_offset=False),
1578
tags, self.merge_marker(revision)))
1579
self.show_properties(revision.rev, indent+offset)
1580
583
if self.show_ids:
1581
to_file.write(indent + offset + 'revision-id:%s\n'
1582
% (revision.rev.revision_id,))
584
print >>to_file, ' revision-id:', revision.rev.revision_id
1583
585
if not revision.rev.message:
1584
to_file.write(indent + offset + '(no message)\n')
586
print >>to_file, ' (no message)'
1586
588
message = revision.rev.message.rstrip('\r\n')
1587
589
for l in message.split('\n'):
1588
to_file.write(indent + offset + '%s\n' % (l,))
590
print >>to_file, ' ' + l
592
# TODO: Why not show the modified files in a shorter form as
593
# well? rewrap them single lines of appropriate length
1590
594
if revision.delta is not None:
1591
revision.delta.show(to_file, self.show_ids, indent=indent + offset,
1592
short_status=self.delta_format==1)
1593
if revision.diff is not None:
1594
self.show_diff(self.to_exact_file, revision.diff, ' ')
595
revision.delta.show(to_file, self.show_ids)
1598
599
class LineLogFormatter(LogFormatter):
1600
supports_merge_revisions = True
1601
preferred_levels = 1
1602
supports_tags = True
1604
601
def __init__(self, *args, **kwargs):
602
from bzrlib.osutils import terminal_width
1605
603
super(LineLogFormatter, self).__init__(*args, **kwargs)
1606
width = terminal_width()
1607
if width is not None:
1608
# we need one extra space for terminals that wrap on last char
1610
self._max_chars = width
604
self._max_chars = terminal_width() - 1
1612
606
def truncate(self, str, max_len):
1613
if max_len is None or len(str) <= max_len:
607
if len(str) <= max_len:
1615
return str[:max_len-3] + '...'
609
return str[:max_len-3]+'...'
1617
611
def date_string(self, rev):
1618
return format_date(rev.timestamp, rev.timezone or 0,
612
from bzrlib.osutils import format_date
613
return format_date(rev.timestamp, rev.timezone or 0,
1619
614
self.show_timezone, date_fmt="%Y-%m-%d",
1620
615
show_offset=False)
added
removed
bzrlib/log.py
