/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
 
34
    directory_service,
34
35
    delta,
35
36
    config,
36
37
    errors,
53
54
    )
54
55
from bzrlib.branch import Branch
55
56
from bzrlib.conflicts import ConflictList
 
57
from bzrlib.transport import memory
56
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
57
59
from bzrlib.smtp_connection import SMTPConnection
58
60
from bzrlib.workingtree import WorkingTree
59
61
""")
60
62
 
61
 
from bzrlib.commands import Command, display_command
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
62
68
from bzrlib.option import (
63
69
    ListOption,
64
70
    Option,
233
239
# opens the branch?)
234
240
 
235
241
class cmd_status(Command):
236
 
    """Display status summary.
 
242
    __doc__ = """Display status summary.
237
243
 
238
244
    This reports on versioned and unknown files, reporting them
239
245
    grouped by state.  Possible states are:
326
332
 
327
333
 
328
334
class cmd_cat_revision(Command):
329
 
    """Write out metadata for a revision.
 
335
    __doc__ = """Write out metadata for a revision.
330
336
 
331
337
    The revision to print can either be specified by a specific
332
338
    revision identifier, or you can use --revision.
338
344
    # cat-revision is more for frontends so should be exact
339
345
    encoding = 'strict'
340
346
 
 
347
    def print_revision(self, revisions, revid):
 
348
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
 
349
        record = stream.next()
 
350
        if record.storage_kind == 'absent':
 
351
            raise errors.NoSuchRevision(revisions, revid)
 
352
        revtext = record.get_bytes_as('fulltext')
 
353
        self.outf.write(revtext.decode('utf-8'))
 
354
 
341
355
    @display_command
342
356
    def run(self, revision_id=None, revision=None):
343
357
        if revision_id is not None and revision is not None:
348
362
                                         ' --revision or a revision_id')
349
363
        b = WorkingTree.open_containing(u'.')[0].branch
350
364
 
351
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
352
 
        if revision_id is not None:
353
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
354
 
            try:
355
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
356
 
            except errors.NoSuchRevision:
357
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
358
 
                    revision_id)
359
 
                raise errors.BzrCommandError(msg)
360
 
        elif revision is not None:
361
 
            for rev in revision:
362
 
                if rev is None:
363
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
364
 
                                                 ' revision.')
365
 
                rev_id = rev.as_revision_id(b)
366
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
365
        revisions = b.repository.revisions
 
366
        if revisions is None:
 
367
            raise errors.BzrCommandError('Repository %r does not support '
 
368
                'access to raw revision texts')
367
369
 
 
370
        b.repository.lock_read()
 
371
        try:
 
372
            # TODO: jam 20060112 should cat-revision always output utf-8?
 
373
            if revision_id is not None:
 
374
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
375
                try:
 
376
                    self.print_revision(revisions, revision_id)
 
377
                except errors.NoSuchRevision:
 
378
                    msg = "The repository %s contains no revision %s." % (
 
379
                        b.repository.base, revision_id)
 
380
                    raise errors.BzrCommandError(msg)
 
381
            elif revision is not None:
 
382
                for rev in revision:
 
383
                    if rev is None:
 
384
                        raise errors.BzrCommandError(
 
385
                            'You cannot specify a NULL revision.')
 
386
                    rev_id = rev.as_revision_id(b)
 
387
                    self.print_revision(revisions, rev_id)
 
388
        finally:
 
389
            b.repository.unlock()
 
390
        
368
391
 
369
392
class cmd_dump_btree(Command):
370
 
    """Dump the contents of a btree index file to stdout.
 
393
    __doc__ = """Dump the contents of a btree index file to stdout.
371
394
 
372
395
    PATH is a btree index file, it can be any URL. This includes things like
373
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
437
460
        for node in bt.iter_all_entries():
438
461
            # Node is made up of:
439
462
            # (index, key, value, [references])
440
 
            refs_as_tuples = static_tuple.as_tuples(node[3])
 
463
            try:
 
464
                refs = node[3]
 
465
            except IndexError:
 
466
                refs_as_tuples = None
 
467
            else:
 
468
                refs_as_tuples = static_tuple.as_tuples(refs)
441
469
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
442
470
            self.outf.write('%s\n' % (as_tuple,))
443
471
 
444
472
 
445
473
class cmd_remove_tree(Command):
446
 
    """Remove the working tree from a given branch/checkout.
 
474
    __doc__ = """Remove the working tree from a given branch/checkout.
447
475
 
448
476
    Since a lightweight checkout is little more than a working tree
449
477
    this will refuse to run against one.
451
479
    To re-create the working tree, use "bzr checkout".
452
480
    """
453
481
    _see_also = ['checkout', 'working-trees']
454
 
    takes_args = ['location?']
 
482
    takes_args = ['location*']
455
483
    takes_options = [
456
484
        Option('force',
457
485
               help='Remove the working tree even if it has '
458
486
                    'uncommitted changes.'),
459
487
        ]
460
488
 
461
 
    def run(self, location='.', force=False):
462
 
        d = bzrdir.BzrDir.open(location)
463
 
 
464
 
        try:
465
 
            working = d.open_workingtree()
466
 
        except errors.NoWorkingTree:
467
 
            raise errors.BzrCommandError("No working tree to remove")
468
 
        except errors.NotLocalUrl:
469
 
            raise errors.BzrCommandError("You cannot remove the working tree"
470
 
                                         " of a remote path")
471
 
        if not force:
472
 
            if (working.has_changes()):
473
 
                raise errors.UncommittedChanges(working)
474
 
 
475
 
        working_path = working.bzrdir.root_transport.base
476
 
        branch_path = working.branch.bzrdir.root_transport.base
477
 
        if working_path != branch_path:
478
 
            raise errors.BzrCommandError("You cannot remove the working tree"
479
 
                                         " from a lightweight checkout")
480
 
 
481
 
        d.destroy_workingtree()
 
489
    def run(self, location_list, force=False):
 
490
        if not location_list:
 
491
            location_list=['.']
 
492
 
 
493
        for location in location_list:
 
494
            d = bzrdir.BzrDir.open(location)
 
495
            
 
496
            try:
 
497
                working = d.open_workingtree()
 
498
            except errors.NoWorkingTree:
 
499
                raise errors.BzrCommandError("No working tree to remove")
 
500
            except errors.NotLocalUrl:
 
501
                raise errors.BzrCommandError("You cannot remove the working tree"
 
502
                                             " of a remote path")
 
503
            if not force:
 
504
                if (working.has_changes()):
 
505
                    raise errors.UncommittedChanges(working)
 
506
 
 
507
            if working.user_url != working.branch.user_url:
 
508
                raise errors.BzrCommandError("You cannot remove the working tree"
 
509
                                             " from a lightweight checkout")
 
510
 
 
511
            d.destroy_workingtree()
482
512
 
483
513
 
484
514
class cmd_revno(Command):
485
 
    """Show current revision number.
 
515
    __doc__ = """Show current revision number.
486
516
 
487
517
    This is equal to the number of revisions on this branch.
488
518
    """
501
531
                wt.lock_read()
502
532
            except (errors.NoWorkingTree, errors.NotLocalUrl):
503
533
                raise errors.NoWorkingTree(location)
 
534
            self.add_cleanup(wt.unlock)
 
535
            revid = wt.last_revision()
504
536
            try:
505
 
                revid = wt.last_revision()
506
 
                try:
507
 
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
508
 
                except errors.NoSuchRevision:
509
 
                    revno_t = ('???',)
510
 
                revno = ".".join(str(n) for n in revno_t)
511
 
            finally:
512
 
                wt.unlock()
 
537
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
538
            except errors.NoSuchRevision:
 
539
                revno_t = ('???',)
 
540
            revno = ".".join(str(n) for n in revno_t)
513
541
        else:
514
542
            b = Branch.open_containing(location)[0]
515
543
            b.lock_read()
516
 
            try:
517
 
                revno = b.revno()
518
 
            finally:
519
 
                b.unlock()
520
 
 
 
544
            self.add_cleanup(b.unlock)
 
545
            revno = b.revno()
 
546
        self.cleanup_now()
521
547
        self.outf.write(str(revno) + '\n')
522
548
 
523
549
 
524
550
class cmd_revision_info(Command):
525
 
    """Show revision number and revision id for a given revision identifier.
 
551
    __doc__ = """Show revision number and revision id for a given revision identifier.
526
552
    """
527
553
    hidden = True
528
554
    takes_args = ['revision_info*']
545
571
            wt = WorkingTree.open_containing(directory)[0]
546
572
            b = wt.branch
547
573
            wt.lock_read()
 
574
            self.add_cleanup(wt.unlock)
548
575
        except (errors.NoWorkingTree, errors.NotLocalUrl):
549
576
            wt = None
550
577
            b = Branch.open_containing(directory)[0]
551
578
            b.lock_read()
552
 
        try:
553
 
            revision_ids = []
554
 
            if revision is not None:
555
 
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
556
 
            if revision_info_list is not None:
557
 
                for rev_str in revision_info_list:
558
 
                    rev_spec = RevisionSpec.from_string(rev_str)
559
 
                    revision_ids.append(rev_spec.as_revision_id(b))
560
 
            # No arguments supplied, default to the last revision
561
 
            if len(revision_ids) == 0:
562
 
                if tree:
563
 
                    if wt is None:
564
 
                        raise errors.NoWorkingTree(directory)
565
 
                    revision_ids.append(wt.last_revision())
566
 
                else:
567
 
                    revision_ids.append(b.last_revision())
568
 
 
569
 
            revinfos = []
570
 
            maxlen = 0
571
 
            for revision_id in revision_ids:
572
 
                try:
573
 
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
574
 
                    revno = '.'.join(str(i) for i in dotted_revno)
575
 
                except errors.NoSuchRevision:
576
 
                    revno = '???'
577
 
                maxlen = max(maxlen, len(revno))
578
 
                revinfos.append([revno, revision_id])
579
 
        finally:
580
 
            if wt is None:
581
 
                b.unlock()
 
579
            self.add_cleanup(b.unlock)
 
580
        revision_ids = []
 
581
        if revision is not None:
 
582
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
583
        if revision_info_list is not None:
 
584
            for rev_str in revision_info_list:
 
585
                rev_spec = RevisionSpec.from_string(rev_str)
 
586
                revision_ids.append(rev_spec.as_revision_id(b))
 
587
        # No arguments supplied, default to the last revision
 
588
        if len(revision_ids) == 0:
 
589
            if tree:
 
590
                if wt is None:
 
591
                    raise errors.NoWorkingTree(directory)
 
592
                revision_ids.append(wt.last_revision())
582
593
            else:
583
 
                wt.unlock()
584
 
 
 
594
                revision_ids.append(b.last_revision())
 
595
 
 
596
        revinfos = []
 
597
        maxlen = 0
 
598
        for revision_id in revision_ids:
 
599
            try:
 
600
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
601
                revno = '.'.join(str(i) for i in dotted_revno)
 
602
            except errors.NoSuchRevision:
 
603
                revno = '???'
 
604
            maxlen = max(maxlen, len(revno))
 
605
            revinfos.append([revno, revision_id])
 
606
 
 
607
        self.cleanup_now()
585
608
        for ri in revinfos:
586
609
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
587
610
 
588
611
 
589
612
class cmd_add(Command):
590
 
    """Add specified files or directories.
 
613
    __doc__ = """Add specified files or directories.
591
614
 
592
615
    In non-recursive mode, all the named items are added, regardless
593
616
    of whether they were previously ignored.  A warning is given if
659
682
 
660
683
        if base_tree:
661
684
            base_tree.lock_read()
662
 
        try:
663
 
            tree, file_list = tree_files_for_add(file_list)
664
 
            added, ignored = tree.smart_add(file_list, not
665
 
                no_recurse, action=action, save=not dry_run)
666
 
        finally:
667
 
            if base_tree is not None:
668
 
                base_tree.unlock()
 
685
            self.add_cleanup(base_tree.unlock)
 
686
        tree, file_list = tree_files_for_add(file_list)
 
687
        added, ignored = tree.smart_add(file_list, not
 
688
            no_recurse, action=action, save=not dry_run)
 
689
        self.cleanup_now()
669
690
        if len(ignored) > 0:
670
691
            if verbose:
671
692
                for glob in sorted(ignored.keys()):
675
696
 
676
697
 
677
698
class cmd_mkdir(Command):
678
 
    """Create a new versioned directory.
 
699
    __doc__ = """Create a new versioned directory.
679
700
 
680
701
    This is equivalent to creating the directory and then adding it.
681
702
    """
685
706
 
686
707
    def run(self, dir_list):
687
708
        for d in dir_list:
688
 
            os.mkdir(d)
689
709
            wt, dd = WorkingTree.open_containing(d)
690
 
            wt.add([dd])
691
 
            self.outf.write('added %s\n' % d)
 
710
            base = os.path.dirname(dd)
 
711
            id = wt.path2id(base)
 
712
            if id != None:
 
713
                os.mkdir(d)
 
714
                wt.add([dd])
 
715
                self.outf.write('added %s\n' % d)
 
716
            else:
 
717
                raise errors.NotVersionedError(path=base)
692
718
 
693
719
 
694
720
class cmd_relpath(Command):
695
 
    """Show path of a file relative to root"""
 
721
    __doc__ = """Show path of a file relative to root"""
696
722
 
697
723
    takes_args = ['filename']
698
724
    hidden = True
707
733
 
708
734
 
709
735
class cmd_inventory(Command):
710
 
    """Show inventory of the current working copy or a revision.
 
736
    __doc__ = """Show inventory of the current working copy or a revision.
711
737
 
712
738
    It is possible to limit the output to a particular entry
713
739
    type using the --kind option.  For example: --kind file.
735
761
        revision = _get_one_revision('inventory', revision)
736
762
        work_tree, file_list = tree_files(file_list)
737
763
        work_tree.lock_read()
738
 
        try:
739
 
            if revision is not None:
740
 
                tree = revision.as_tree(work_tree.branch)
741
 
 
742
 
                extra_trees = [work_tree]
743
 
                tree.lock_read()
744
 
            else:
745
 
                tree = work_tree
746
 
                extra_trees = []
747
 
 
748
 
            if file_list is not None:
749
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
750
 
                                          require_versioned=True)
751
 
                # find_ids_across_trees may include some paths that don't
752
 
                # exist in 'tree'.
753
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
754
 
                                 for file_id in file_ids if file_id in tree)
755
 
            else:
756
 
                entries = tree.inventory.entries()
757
 
        finally:
758
 
            tree.unlock()
759
 
            if tree is not work_tree:
760
 
                work_tree.unlock()
761
 
 
 
764
        self.add_cleanup(work_tree.unlock)
 
765
        if revision is not None:
 
766
            tree = revision.as_tree(work_tree.branch)
 
767
 
 
768
            extra_trees = [work_tree]
 
769
            tree.lock_read()
 
770
            self.add_cleanup(tree.unlock)
 
771
        else:
 
772
            tree = work_tree
 
773
            extra_trees = []
 
774
 
 
775
        if file_list is not None:
 
776
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
777
                                      require_versioned=True)
 
778
            # find_ids_across_trees may include some paths that don't
 
779
            # exist in 'tree'.
 
780
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
781
                             for file_id in file_ids if file_id in tree)
 
782
        else:
 
783
            entries = tree.inventory.entries()
 
784
 
 
785
        self.cleanup_now()
762
786
        for path, entry in entries:
763
787
            if kind and kind != entry.kind:
764
788
                continue
770
794
 
771
795
 
772
796
class cmd_mv(Command):
773
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
774
798
 
775
799
    :Usage:
776
800
        bzr mv OLDNAME NEWNAME
810
834
            raise errors.BzrCommandError("missing file argument")
811
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
812
836
        tree.lock_tree_write()
813
 
        try:
814
 
            self._run(tree, names_list, rel_names, after)
815
 
        finally:
816
 
            tree.unlock()
 
837
        self.add_cleanup(tree.unlock)
 
838
        self._run(tree, names_list, rel_names, after)
817
839
 
818
840
    def run_auto(self, names_list, after, dry_run):
819
841
        if names_list is not None and len(names_list) > 1:
824
846
                                         ' --auto.')
825
847
        work_tree, file_list = tree_files(names_list, default_branch='.')
826
848
        work_tree.lock_tree_write()
827
 
        try:
828
 
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
829
 
        finally:
830
 
            work_tree.unlock()
 
849
        self.add_cleanup(work_tree.unlock)
 
850
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
831
851
 
832
852
    def _run(self, tree, names_list, rel_names, after):
833
853
        into_existing = osutils.isdir(names_list[-1])
911
931
 
912
932
 
913
933
class cmd_pull(Command):
914
 
    """Turn this branch into a mirror of another branch.
 
934
    __doc__ = """Turn this branch into a mirror of another branch.
915
935
 
916
936
    By default, this command only works on branches that have not diverged.
917
937
    Branches are considered diverged if the destination branch's most recent 
966
986
        try:
967
987
            tree_to = WorkingTree.open_containing(directory)[0]
968
988
            branch_to = tree_to.branch
 
989
            tree_to.lock_write()
 
990
            self.add_cleanup(tree_to.unlock)
969
991
        except errors.NoWorkingTree:
970
992
            tree_to = None
971
993
            branch_to = Branch.open_containing(directory)[0]
972
 
        
 
994
            branch_to.lock_write()
 
995
            self.add_cleanup(branch_to.unlock)
 
996
 
973
997
        if local and not branch_to.get_bound_location():
974
998
            raise errors.LocalRequiresBoundBranch()
975
999
 
1005
1029
        else:
1006
1030
            branch_from = Branch.open(location,
1007
1031
                possible_transports=possible_transports)
 
1032
            branch_from.lock_read()
 
1033
            self.add_cleanup(branch_from.unlock)
1008
1034
 
1009
1035
            if branch_to.get_parent() is None or remember:
1010
1036
                branch_to.set_parent(branch_from.base)
1011
1037
 
1012
 
        if branch_from is not branch_to:
1013
 
            branch_from.lock_read()
1014
 
        try:
1015
 
            if revision is not None:
1016
 
                revision_id = revision.as_revision_id(branch_from)
1017
 
 
1018
 
            branch_to.lock_write()
1019
 
            try:
1020
 
                if tree_to is not None:
1021
 
                    view_info = _get_view_info_for_change_reporter(tree_to)
1022
 
                    change_reporter = delta._ChangeReporter(
1023
 
                        unversioned_filter=tree_to.is_ignored,
1024
 
                        view_info=view_info)
1025
 
                    result = tree_to.pull(
1026
 
                        branch_from, overwrite, revision_id, change_reporter,
1027
 
                        possible_transports=possible_transports, local=local)
1028
 
                else:
1029
 
                    result = branch_to.pull(
1030
 
                        branch_from, overwrite, revision_id, local=local)
1031
 
 
1032
 
                result.report(self.outf)
1033
 
                if verbose and result.old_revid != result.new_revid:
1034
 
                    log.show_branch_change(
1035
 
                        branch_to, self.outf, result.old_revno,
1036
 
                        result.old_revid)
1037
 
            finally:
1038
 
                branch_to.unlock()
1039
 
        finally:
1040
 
            if branch_from is not branch_to:
1041
 
                branch_from.unlock()
 
1038
        if revision is not None:
 
1039
            revision_id = revision.as_revision_id(branch_from)
 
1040
 
 
1041
        if tree_to is not None:
 
1042
            view_info = _get_view_info_for_change_reporter(tree_to)
 
1043
            change_reporter = delta._ChangeReporter(
 
1044
                unversioned_filter=tree_to.is_ignored,
 
1045
                view_info=view_info)
 
1046
            result = tree_to.pull(
 
1047
                branch_from, overwrite, revision_id, change_reporter,
 
1048
                possible_transports=possible_transports, local=local)
 
1049
        else:
 
1050
            result = branch_to.pull(
 
1051
                branch_from, overwrite, revision_id, local=local)
 
1052
 
 
1053
        result.report(self.outf)
 
1054
        if verbose and result.old_revid != result.new_revid:
 
1055
            log.show_branch_change(
 
1056
                branch_to, self.outf, result.old_revno,
 
1057
                result.old_revid)
1042
1058
 
1043
1059
 
1044
1060
class cmd_push(Command):
1045
 
    """Update a mirror of this branch.
 
1061
    __doc__ = """Update a mirror of this branch.
1046
1062
 
1047
1063
    The target branch will not have its working tree populated because this
1048
1064
    is both expensive, and is not supported on remote file systems.
1109
1125
        # Get the source branch
1110
1126
        (tree, br_from,
1111
1127
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1112
 
        if strict is None:
1113
 
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
1114
 
        if strict is None: strict = True # default value
1115
1128
        # Get the tip's revision_id
1116
1129
        revision = _get_one_revision('push', revision)
1117
1130
        if revision is not None:
1118
1131
            revision_id = revision.in_history(br_from).rev_id
1119
1132
        else:
1120
1133
            revision_id = None
1121
 
        if strict and tree is not None and revision_id is None:
1122
 
            if (tree.has_changes()):
1123
 
                raise errors.UncommittedChanges(
1124
 
                    tree, more='Use --no-strict to force the push.')
1125
 
            if tree.last_revision() != tree.branch.last_revision():
1126
 
                # The tree has lost sync with its branch, there is little
1127
 
                # chance that the user is aware of it but he can still force
1128
 
                # the push with --no-strict
1129
 
                raise errors.OutOfDateTree(
1130
 
                    tree, more='Use --no-strict to force the push.')
1131
 
 
 
1134
        if tree is not None and revision_id is None:
 
1135
            tree.check_changed_or_out_of_date(
 
1136
                strict, 'push_strict',
 
1137
                more_error='Use --no-strict to force the push.',
 
1138
                more_warning='Uncommitted changes will not be pushed.')
1132
1139
        # Get the stacked_on branch, if any
1133
1140
        if stacked_on is not None:
1134
1141
            stacked_on = urlutils.normalize_url(stacked_on)
1166
1173
 
1167
1174
 
1168
1175
class cmd_branch(Command):
1169
 
    """Create a new branch that is a copy of an existing branch.
 
1176
    __doc__ = """Create a new branch that is a copy of an existing branch.
1170
1177
 
1171
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1172
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1199
1206
                    ' directory exists, but does not already'
1200
1207
                    ' have a control directory.  This flag will'
1201
1208
                    ' allow branch to proceed.'),
 
1209
        Option('bind',
 
1210
            help="Bind new branch to from location."),
1202
1211
        ]
1203
1212
    aliases = ['get', 'clone']
1204
1213
 
1205
1214
    def run(self, from_location, to_location=None, revision=None,
1206
1215
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1207
 
            use_existing_dir=False, switch=False):
 
1216
            use_existing_dir=False, switch=False, bind=False):
1208
1217
        from bzrlib import switch as _mod_switch
1209
1218
        from bzrlib.tag import _merge_tags_if_possible
1210
1219
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1211
1220
            from_location)
1212
1221
        revision = _get_one_revision('branch', revision)
1213
1222
        br_from.lock_read()
 
1223
        self.add_cleanup(br_from.unlock)
 
1224
        if revision is not None:
 
1225
            revision_id = revision.as_revision_id(br_from)
 
1226
        else:
 
1227
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1228
            # None or perhaps NULL_REVISION to mean copy nothing
 
1229
            # RBC 20060209
 
1230
            revision_id = br_from.last_revision()
 
1231
        if to_location is None:
 
1232
            to_location = urlutils.derive_to_location(from_location)
 
1233
        to_transport = transport.get_transport(to_location)
1214
1234
        try:
1215
 
            if revision is not None:
1216
 
                revision_id = revision.as_revision_id(br_from)
 
1235
            to_transport.mkdir('.')
 
1236
        except errors.FileExists:
 
1237
            if not use_existing_dir:
 
1238
                raise errors.BzrCommandError('Target directory "%s" '
 
1239
                    'already exists.' % to_location)
1217
1240
            else:
1218
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1219
 
                # None or perhaps NULL_REVISION to mean copy nothing
1220
 
                # RBC 20060209
1221
 
                revision_id = br_from.last_revision()
1222
 
            if to_location is None:
1223
 
                to_location = urlutils.derive_to_location(from_location)
1224
 
            to_transport = transport.get_transport(to_location)
1225
 
            try:
1226
 
                to_transport.mkdir('.')
1227
 
            except errors.FileExists:
1228
 
                if not use_existing_dir:
1229
 
                    raise errors.BzrCommandError('Target directory "%s" '
1230
 
                        'already exists.' % to_location)
 
1241
                try:
 
1242
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1243
                except errors.NotBranchError:
 
1244
                    pass
1231
1245
                else:
1232
 
                    try:
1233
 
                        bzrdir.BzrDir.open_from_transport(to_transport)
1234
 
                    except errors.NotBranchError:
1235
 
                        pass
1236
 
                    else:
1237
 
                        raise errors.AlreadyBranchError(to_location)
1238
 
            except errors.NoSuchFile:
1239
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1240
 
                                             % to_location)
1241
 
            try:
1242
 
                # preserve whatever source format we have.
1243
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1244
 
                                            possible_transports=[to_transport],
1245
 
                                            accelerator_tree=accelerator_tree,
1246
 
                                            hardlink=hardlink, stacked=stacked,
1247
 
                                            force_new_repo=standalone,
1248
 
                                            create_tree_if_local=not no_tree,
1249
 
                                            source_branch=br_from)
1250
 
                branch = dir.open_branch()
1251
 
            except errors.NoSuchRevision:
1252
 
                to_transport.delete_tree('.')
1253
 
                msg = "The branch %s has no revision %s." % (from_location,
1254
 
                    revision)
1255
 
                raise errors.BzrCommandError(msg)
1256
 
            _merge_tags_if_possible(br_from, branch)
1257
 
            # If the source branch is stacked, the new branch may
1258
 
            # be stacked whether we asked for that explicitly or not.
1259
 
            # We therefore need a try/except here and not just 'if stacked:'
1260
 
            try:
1261
 
                note('Created new stacked branch referring to %s.' %
1262
 
                    branch.get_stacked_on_url())
1263
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1264
 
                errors.UnstackableRepositoryFormat), e:
1265
 
                note('Branched %d revision(s).' % branch.revno())
1266
 
            if switch:
1267
 
                # Switch to the new branch
1268
 
                wt, _ = WorkingTree.open_containing('.')
1269
 
                _mod_switch.switch(wt.bzrdir, branch)
1270
 
                note('Switched to branch: %s',
1271
 
                    urlutils.unescape_for_display(branch.base, 'utf-8'))
1272
 
        finally:
1273
 
            br_from.unlock()
 
1246
                    raise errors.AlreadyBranchError(to_location)
 
1247
        except errors.NoSuchFile:
 
1248
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1249
                                         % to_location)
 
1250
        try:
 
1251
            # preserve whatever source format we have.
 
1252
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1253
                                        possible_transports=[to_transport],
 
1254
                                        accelerator_tree=accelerator_tree,
 
1255
                                        hardlink=hardlink, stacked=stacked,
 
1256
                                        force_new_repo=standalone,
 
1257
                                        create_tree_if_local=not no_tree,
 
1258
                                        source_branch=br_from)
 
1259
            branch = dir.open_branch()
 
1260
        except errors.NoSuchRevision:
 
1261
            to_transport.delete_tree('.')
 
1262
            msg = "The branch %s has no revision %s." % (from_location,
 
1263
                revision)
 
1264
            raise errors.BzrCommandError(msg)
 
1265
        _merge_tags_if_possible(br_from, branch)
 
1266
        # If the source branch is stacked, the new branch may
 
1267
        # be stacked whether we asked for that explicitly or not.
 
1268
        # We therefore need a try/except here and not just 'if stacked:'
 
1269
        try:
 
1270
            note('Created new stacked branch referring to %s.' %
 
1271
                branch.get_stacked_on_url())
 
1272
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1273
            errors.UnstackableRepositoryFormat), e:
 
1274
            note('Branched %d revision(s).' % branch.revno())
 
1275
        if bind:
 
1276
            # Bind to the parent
 
1277
            parent_branch = Branch.open(from_location)
 
1278
            branch.bind(parent_branch)
 
1279
            note('New branch bound to %s' % from_location)
 
1280
        if switch:
 
1281
            # Switch to the new branch
 
1282
            wt, _ = WorkingTree.open_containing('.')
 
1283
            _mod_switch.switch(wt.bzrdir, branch)
 
1284
            note('Switched to branch: %s',
 
1285
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1274
1286
 
1275
1287
 
1276
1288
class cmd_checkout(Command):
1277
 
    """Create a new checkout of an existing branch.
 
1289
    __doc__ = """Create a new checkout of an existing branch.
1278
1290
 
1279
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1280
1292
    the branch found in '.'. This is useful if you have removed the working tree
1343
1355
 
1344
1356
 
1345
1357
class cmd_renames(Command):
1346
 
    """Show list of renamed files.
 
1358
    __doc__ = """Show list of renamed files.
1347
1359
    """
1348
1360
    # TODO: Option to show renames between two historical versions.
1349
1361
 
1355
1367
    def run(self, dir=u'.'):
1356
1368
        tree = WorkingTree.open_containing(dir)[0]
1357
1369
        tree.lock_read()
1358
 
        try:
1359
 
            new_inv = tree.inventory
1360
 
            old_tree = tree.basis_tree()
1361
 
            old_tree.lock_read()
1362
 
            try:
1363
 
                old_inv = old_tree.inventory
1364
 
                renames = []
1365
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1366
 
                for f, paths, c, v, p, n, k, e in iterator:
1367
 
                    if paths[0] == paths[1]:
1368
 
                        continue
1369
 
                    if None in (paths):
1370
 
                        continue
1371
 
                    renames.append(paths)
1372
 
                renames.sort()
1373
 
                for old_name, new_name in renames:
1374
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1375
 
            finally:
1376
 
                old_tree.unlock()
1377
 
        finally:
1378
 
            tree.unlock()
 
1370
        self.add_cleanup(tree.unlock)
 
1371
        new_inv = tree.inventory
 
1372
        old_tree = tree.basis_tree()
 
1373
        old_tree.lock_read()
 
1374
        self.add_cleanup(old_tree.unlock)
 
1375
        old_inv = old_tree.inventory
 
1376
        renames = []
 
1377
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1378
        for f, paths, c, v, p, n, k, e in iterator:
 
1379
            if paths[0] == paths[1]:
 
1380
                continue
 
1381
            if None in (paths):
 
1382
                continue
 
1383
            renames.append(paths)
 
1384
        renames.sort()
 
1385
        for old_name, new_name in renames:
 
1386
            self.outf.write("%s => %s\n" % (old_name, new_name))
1379
1387
 
1380
1388
 
1381
1389
class cmd_update(Command):
1382
 
    """Update a tree to have the latest code committed to its branch.
 
1390
    __doc__ = """Update a tree to have the latest code committed to its branch.
1383
1391
 
1384
1392
    This will perform a merge into the working tree, and may generate
1385
1393
    conflicts. If you have any local changes, you will still
1387
1395
 
1388
1396
    If you want to discard your local changes, you can just do a
1389
1397
    'bzr revert' instead of 'bzr commit' after the update.
 
1398
 
 
1399
    If the tree's branch is bound to a master branch, it will also update
 
1400
    the branch from the master.
1390
1401
    """
1391
1402
 
1392
1403
    _see_also = ['pull', 'working-trees', 'status-flags']
1393
1404
    takes_args = ['dir?']
 
1405
    takes_options = ['revision']
1394
1406
    aliases = ['up']
1395
1407
 
1396
 
    def run(self, dir='.'):
 
1408
    def run(self, dir='.', revision=None):
 
1409
        if revision is not None and len(revision) != 1:
 
1410
            raise errors.BzrCommandError(
 
1411
                        "bzr update --revision takes exactly one revision")
1397
1412
        tree = WorkingTree.open_containing(dir)[0]
 
1413
        branch = tree.branch
1398
1414
        possible_transports = []
1399
 
        master = tree.branch.get_master_branch(
 
1415
        master = branch.get_master_branch(
1400
1416
            possible_transports=possible_transports)
1401
1417
        if master is not None:
1402
1418
            tree.lock_write()
1404
1420
        else:
1405
1421
            tree.lock_tree_write()
1406
1422
            branch_location = tree.branch.base
 
1423
        self.add_cleanup(tree.unlock)
1407
1424
        # get rid of the final '/' and be ready for display
1408
 
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
1409
 
                                                        self.outf.encoding)
 
1425
        branch_location = urlutils.unescape_for_display(
 
1426
            branch_location.rstrip('/'),
 
1427
            self.outf.encoding)
 
1428
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1429
        if master is None:
 
1430
            old_tip = None
 
1431
        else:
 
1432
            # may need to fetch data into a heavyweight checkout
 
1433
            # XXX: this may take some time, maybe we should display a
 
1434
            # message
 
1435
            old_tip = branch.update(possible_transports)
 
1436
        if revision is not None:
 
1437
            revision_id = revision[0].as_revision_id(branch)
 
1438
        else:
 
1439
            revision_id = branch.last_revision()
 
1440
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1441
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1442
            note("Tree is up to date at revision %s of branch %s" %
 
1443
                ('.'.join(map(str, revno)), branch_location))
 
1444
            return 0
 
1445
        view_info = _get_view_info_for_change_reporter(tree)
 
1446
        change_reporter = delta._ChangeReporter(
 
1447
            unversioned_filter=tree.is_ignored,
 
1448
            view_info=view_info)
1410
1449
        try:
1411
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1412
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1413
 
            if last_rev == _mod_revision.ensure_null(
1414
 
                tree.branch.last_revision()):
1415
 
                # may be up to date, check master too.
1416
 
                if master is None or last_rev == _mod_revision.ensure_null(
1417
 
                    master.last_revision()):
1418
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1419
 
                    note('Tree is up to date at revision %d of branch %s'
1420
 
                         % (revno, branch_location))
1421
 
                    return 0
1422
 
            view_info = _get_view_info_for_change_reporter(tree)
1423
1450
            conflicts = tree.update(
1424
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1425
 
                view_info=view_info), possible_transports=possible_transports)
1426
 
            revno = tree.branch.revision_id_to_revno(
1427
 
                _mod_revision.ensure_null(tree.last_revision()))
1428
 
            note('Updated to revision %d of branch %s' %
1429
 
                 (revno, branch_location))
1430
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1431
 
                note('Your local commits will now show as pending merges with '
1432
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1433
 
            if conflicts != 0:
1434
 
                return 1
1435
 
            else:
1436
 
                return 0
1437
 
        finally:
1438
 
            tree.unlock()
 
1451
                change_reporter,
 
1452
                possible_transports=possible_transports,
 
1453
                revision=revision_id,
 
1454
                old_tip=old_tip)
 
1455
        except errors.NoSuchRevision, e:
 
1456
            raise errors.BzrCommandError(
 
1457
                                  "branch has no revision %s\n"
 
1458
                                  "bzr update --revision only works"
 
1459
                                  " for a revision in the branch history"
 
1460
                                  % (e.revision))
 
1461
        revno = tree.branch.revision_id_to_dotted_revno(
 
1462
            _mod_revision.ensure_null(tree.last_revision()))
 
1463
        note('Updated to revision %s of branch %s' %
 
1464
             ('.'.join(map(str, revno)), branch_location))
 
1465
        parent_ids = tree.get_parent_ids()
 
1466
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1467
            note('Your local commits will now show as pending merges with '
 
1468
                 "'bzr status', and can be committed with 'bzr commit'.")
 
1469
        if conflicts != 0:
 
1470
            return 1
 
1471
        else:
 
1472
            return 0
1439
1473
 
1440
1474
 
1441
1475
class cmd_info(Command):
1442
 
    """Show information about a working tree, branch or repository.
 
1476
    __doc__ = """Show information about a working tree, branch or repository.
1443
1477
 
1444
1478
    This command will show all known locations and formats associated to the
1445
1479
    tree, branch or repository.
1483
1517
 
1484
1518
 
1485
1519
class cmd_remove(Command):
1486
 
    """Remove files or directories.
 
1520
    __doc__ = """Remove files or directories.
1487
1521
 
1488
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1489
1523
    them if they can easily be recovered using revert. If no options or
1512
1546
            file_list = [f for f in file_list]
1513
1547
 
1514
1548
        tree.lock_write()
1515
 
        try:
1516
 
            # Heuristics should probably all move into tree.remove_smart or
1517
 
            # some such?
1518
 
            if new:
1519
 
                added = tree.changes_from(tree.basis_tree(),
1520
 
                    specific_files=file_list).added
1521
 
                file_list = sorted([f[0] for f in added], reverse=True)
1522
 
                if len(file_list) == 0:
1523
 
                    raise errors.BzrCommandError('No matching files.')
1524
 
            elif file_list is None:
1525
 
                # missing files show up in iter_changes(basis) as
1526
 
                # versioned-with-no-kind.
1527
 
                missing = []
1528
 
                for change in tree.iter_changes(tree.basis_tree()):
1529
 
                    # Find paths in the working tree that have no kind:
1530
 
                    if change[1][1] is not None and change[6][1] is None:
1531
 
                        missing.append(change[1][1])
1532
 
                file_list = sorted(missing, reverse=True)
1533
 
                file_deletion_strategy = 'keep'
1534
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1535
 
                keep_files=file_deletion_strategy=='keep',
1536
 
                force=file_deletion_strategy=='force')
1537
 
        finally:
1538
 
            tree.unlock()
 
1549
        self.add_cleanup(tree.unlock)
 
1550
        # Heuristics should probably all move into tree.remove_smart or
 
1551
        # some such?
 
1552
        if new:
 
1553
            added = tree.changes_from(tree.basis_tree(),
 
1554
                specific_files=file_list).added
 
1555
            file_list = sorted([f[0] for f in added], reverse=True)
 
1556
            if len(file_list) == 0:
 
1557
                raise errors.BzrCommandError('No matching files.')
 
1558
        elif file_list is None:
 
1559
            # missing files show up in iter_changes(basis) as
 
1560
            # versioned-with-no-kind.
 
1561
            missing = []
 
1562
            for change in tree.iter_changes(tree.basis_tree()):
 
1563
                # Find paths in the working tree that have no kind:
 
1564
                if change[1][1] is not None and change[6][1] is None:
 
1565
                    missing.append(change[1][1])
 
1566
            file_list = sorted(missing, reverse=True)
 
1567
            file_deletion_strategy = 'keep'
 
1568
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1569
            keep_files=file_deletion_strategy=='keep',
 
1570
            force=file_deletion_strategy=='force')
1539
1571
 
1540
1572
 
1541
1573
class cmd_file_id(Command):
1542
 
    """Print file_id of a particular file or directory.
 
1574
    __doc__ = """Print file_id of a particular file or directory.
1543
1575
 
1544
1576
    The file_id is assigned when the file is first added and remains the
1545
1577
    same through all revisions where the file exists, even when it is
1561
1593
 
1562
1594
 
1563
1595
class cmd_file_path(Command):
1564
 
    """Print path of file_ids to a file or directory.
 
1596
    __doc__ = """Print path of file_ids to a file or directory.
1565
1597
 
1566
1598
    This prints one line for each directory down to the target,
1567
1599
    starting at the branch root.
1583
1615
 
1584
1616
 
1585
1617
class cmd_reconcile(Command):
1586
 
    """Reconcile bzr metadata in a branch.
 
1618
    __doc__ = """Reconcile bzr metadata in a branch.
1587
1619
 
1588
1620
    This can correct data mismatches that may have been caused by
1589
1621
    previous ghost operations or bzr upgrades. You should only
1611
1643
 
1612
1644
 
1613
1645
class cmd_revision_history(Command):
1614
 
    """Display the list of revision ids on a branch."""
 
1646
    __doc__ = """Display the list of revision ids on a branch."""
1615
1647
 
1616
1648
    _see_also = ['log']
1617
1649
    takes_args = ['location?']
1627
1659
 
1628
1660
 
1629
1661
class cmd_ancestry(Command):
1630
 
    """List all revisions merged into this branch."""
 
1662
    __doc__ = """List all revisions merged into this branch."""
1631
1663
 
1632
1664
    _see_also = ['log', 'revision-history']
1633
1665
    takes_args = ['location?']
1652
1684
 
1653
1685
 
1654
1686
class cmd_init(Command):
1655
 
    """Make a directory into a versioned branch.
 
1687
    __doc__ = """Make a directory into a versioned branch.
1656
1688
 
1657
1689
    Use this to create an empty branch, or before importing an
1658
1690
    existing project.
1761
1793
 
1762
1794
 
1763
1795
class cmd_init_repository(Command):
1764
 
    """Create a shared repository for branches to share storage space.
 
1796
    __doc__ = """Create a shared repository for branches to share storage space.
1765
1797
 
1766
1798
    New branches created under the repository directory will store their
1767
1799
    revisions in the repository, not in the branch directory.  For branches
1821
1853
 
1822
1854
 
1823
1855
class cmd_diff(Command):
1824
 
    """Show differences in the working tree, between revisions or branches.
 
1856
    __doc__ = """Show differences in the working tree, between revisions or branches.
1825
1857
 
1826
1858
    If no arguments are given, all changes for the current tree are listed.
1827
1859
    If files are given, only the changes in those files are listed.
1913
1945
            help='Use this command to compare files.',
1914
1946
            type=unicode,
1915
1947
            ),
 
1948
        RegistryOption('format',
 
1949
            help='Diff format to use.',
 
1950
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1951
            value_switches=False, title='Diff format'),
1916
1952
        ]
1917
1953
    aliases = ['di', 'dif']
1918
1954
    encoding_type = 'exact'
1919
1955
 
1920
1956
    @display_command
1921
1957
    def run(self, revision=None, file_list=None, diff_options=None,
1922
 
            prefix=None, old=None, new=None, using=None):
1923
 
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
 
1958
            prefix=None, old=None, new=None, using=None, format=None):
 
1959
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1960
            show_diff_trees)
1924
1961
 
1925
1962
        if (prefix is None) or (prefix == '0'):
1926
1963
            # diff -p0 format
1940
1977
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1941
1978
                                         ' one or two revision specifiers')
1942
1979
 
 
1980
        if using is not None and format is not None:
 
1981
            raise errors.BzrCommandError('--using and --format are mutually '
 
1982
                'exclusive.')
 
1983
 
1943
1984
        (old_tree, new_tree,
1944
1985
         old_branch, new_branch,
1945
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
1946
 
            file_list, revision, old, new, apply_view=True)
 
1986
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
1987
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
1947
1988
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1948
1989
                               specific_files=specific_files,
1949
1990
                               external_diff_options=diff_options,
1950
1991
                               old_label=old_label, new_label=new_label,
1951
 
                               extra_trees=extra_trees, using=using)
 
1992
                               extra_trees=extra_trees, using=using,
 
1993
                               format_cls=format)
1952
1994
 
1953
1995
 
1954
1996
class cmd_deleted(Command):
1955
 
    """List files deleted in the working tree.
 
1997
    __doc__ = """List files deleted in the working tree.
1956
1998
    """
1957
1999
    # TODO: Show files deleted since a previous revision, or
1958
2000
    # between two revisions.
1967
2009
    def run(self, show_ids=False):
1968
2010
        tree = WorkingTree.open_containing(u'.')[0]
1969
2011
        tree.lock_read()
1970
 
        try:
1971
 
            old = tree.basis_tree()
1972
 
            old.lock_read()
1973
 
            try:
1974
 
                for path, ie in old.inventory.iter_entries():
1975
 
                    if not tree.has_id(ie.file_id):
1976
 
                        self.outf.write(path)
1977
 
                        if show_ids:
1978
 
                            self.outf.write(' ')
1979
 
                            self.outf.write(ie.file_id)
1980
 
                        self.outf.write('\n')
1981
 
            finally:
1982
 
                old.unlock()
1983
 
        finally:
1984
 
            tree.unlock()
 
2012
        self.add_cleanup(tree.unlock)
 
2013
        old = tree.basis_tree()
 
2014
        old.lock_read()
 
2015
        self.add_cleanup(old.unlock)
 
2016
        for path, ie in old.inventory.iter_entries():
 
2017
            if not tree.has_id(ie.file_id):
 
2018
                self.outf.write(path)
 
2019
                if show_ids:
 
2020
                    self.outf.write(' ')
 
2021
                    self.outf.write(ie.file_id)
 
2022
                self.outf.write('\n')
1985
2023
 
1986
2024
 
1987
2025
class cmd_modified(Command):
1988
 
    """List files modified in working tree.
 
2026
    __doc__ = """List files modified in working tree.
1989
2027
    """
1990
2028
 
1991
2029
    hidden = True
2008
2046
 
2009
2047
 
2010
2048
class cmd_added(Command):
2011
 
    """List files added in working tree.
 
2049
    __doc__ = """List files added in working tree.
2012
2050
    """
2013
2051
 
2014
2052
    hidden = True
2023
2061
    def run(self, null=False):
2024
2062
        wt = WorkingTree.open_containing(u'.')[0]
2025
2063
        wt.lock_read()
2026
 
        try:
2027
 
            basis = wt.basis_tree()
2028
 
            basis.lock_read()
2029
 
            try:
2030
 
                basis_inv = basis.inventory
2031
 
                inv = wt.inventory
2032
 
                for file_id in inv:
2033
 
                    if file_id in basis_inv:
2034
 
                        continue
2035
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
2036
 
                        continue
2037
 
                    path = inv.id2path(file_id)
2038
 
                    if not os.access(osutils.abspath(path), os.F_OK):
2039
 
                        continue
2040
 
                    if null:
2041
 
                        self.outf.write(path + '\0')
2042
 
                    else:
2043
 
                        self.outf.write(osutils.quotefn(path) + '\n')
2044
 
            finally:
2045
 
                basis.unlock()
2046
 
        finally:
2047
 
            wt.unlock()
 
2064
        self.add_cleanup(wt.unlock)
 
2065
        basis = wt.basis_tree()
 
2066
        basis.lock_read()
 
2067
        self.add_cleanup(basis.unlock)
 
2068
        basis_inv = basis.inventory
 
2069
        inv = wt.inventory
 
2070
        for file_id in inv:
 
2071
            if file_id in basis_inv:
 
2072
                continue
 
2073
            if inv.is_root(file_id) and len(basis_inv) == 0:
 
2074
                continue
 
2075
            path = inv.id2path(file_id)
 
2076
            if not os.access(osutils.abspath(path), os.F_OK):
 
2077
                continue
 
2078
            if null:
 
2079
                self.outf.write(path + '\0')
 
2080
            else:
 
2081
                self.outf.write(osutils.quotefn(path) + '\n')
2048
2082
 
2049
2083
 
2050
2084
class cmd_root(Command):
2051
 
    """Show the tree root directory.
 
2085
    __doc__ = """Show the tree root directory.
2052
2086
 
2053
2087
    The root is the nearest enclosing directory with a .bzr control
2054
2088
    directory."""
2078
2112
 
2079
2113
 
2080
2114
class cmd_log(Command):
2081
 
    """Show historical log for a branch or subset of a branch.
 
2115
    __doc__ = """Show historical log for a branch or subset of a branch.
2082
2116
 
2083
2117
    log is bzr's default tool for exploring the history of a branch.
2084
2118
    The branch to use is taken from the first parameter. If no parameters
2195
2229
    :Tips & tricks:
2196
2230
 
2197
2231
      GUI tools and IDEs are often better at exploring history than command
2198
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2199
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2200
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2201
 
 
2202
 
      Web interfaces are often better at exploring history than command line
2203
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2204
 
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2232
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2233
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2234
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2235
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2205
2236
 
2206
2237
      You may find it useful to add the aliases below to ``bazaar.conf``::
2207
2238
 
2268
2299
                   help='Show changes made in each revision as a patch.'),
2269
2300
            Option('include-merges',
2270
2301
                   help='Show merged revisions like --levels 0 does.'),
 
2302
            Option('exclude-common-ancestry',
 
2303
                   help='Display only the revisions that are not part'
 
2304
                   ' of both ancestries (require -rX..Y)'
 
2305
                   )
2271
2306
            ]
2272
2307
    encoding_type = 'replace'
2273
2308
 
2283
2318
            message=None,
2284
2319
            limit=None,
2285
2320
            show_diff=False,
2286
 
            include_merges=False):
 
2321
            include_merges=False,
 
2322
            exclude_common_ancestry=False,
 
2323
            ):
2287
2324
        from bzrlib.log import (
2288
2325
            Logger,
2289
2326
            make_log_request_dict,
2290
2327
            _get_info_for_log_files,
2291
2328
            )
2292
2329
        direction = (forward and 'forward') or 'reverse'
 
2330
        if (exclude_common_ancestry
 
2331
            and (revision is None or len(revision) != 2)):
 
2332
            raise errors.BzrCommandError(
 
2333
                '--exclude-common-ancestry requires -r with two revisions')
2293
2334
        if include_merges:
2294
2335
            if levels is None:
2295
2336
                levels = 0
2308
2349
 
2309
2350
        file_ids = []
2310
2351
        filter_by_dir = False
2311
 
        b = None
2312
 
        try:
2313
 
            if file_list:
2314
 
                # find the file ids to log and check for directory filtering
2315
 
                b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2316
 
                    revision, file_list)
2317
 
                for relpath, file_id, kind in file_info_list:
2318
 
                    if file_id is None:
2319
 
                        raise errors.BzrCommandError(
2320
 
                            "Path unknown at end or start of revision range: %s" %
2321
 
                            relpath)
2322
 
                    # If the relpath is the top of the tree, we log everything
2323
 
                    if relpath == '':
2324
 
                        file_ids = []
2325
 
                        break
2326
 
                    else:
2327
 
                        file_ids.append(file_id)
2328
 
                    filter_by_dir = filter_by_dir or (
2329
 
                        kind in ['directory', 'tree-reference'])
2330
 
            else:
2331
 
                # log everything
2332
 
                # FIXME ? log the current subdir only RBC 20060203
2333
 
                if revision is not None \
2334
 
                        and len(revision) > 0 and revision[0].get_branch():
2335
 
                    location = revision[0].get_branch()
 
2352
        if file_list:
 
2353
            # find the file ids to log and check for directory filtering
 
2354
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2355
                revision, file_list)
 
2356
            self.add_cleanup(b.unlock)
 
2357
            for relpath, file_id, kind in file_info_list:
 
2358
                if file_id is None:
 
2359
                    raise errors.BzrCommandError(
 
2360
                        "Path unknown at end or start of revision range: %s" %
 
2361
                        relpath)
 
2362
                # If the relpath is the top of the tree, we log everything
 
2363
                if relpath == '':
 
2364
                    file_ids = []
 
2365
                    break
2336
2366
                else:
2337
 
                    location = '.'
2338
 
                dir, relpath = bzrdir.BzrDir.open_containing(location)
2339
 
                b = dir.open_branch()
2340
 
                b.lock_read()
2341
 
                rev1, rev2 = _get_revision_range(revision, b, self.name())
2342
 
 
2343
 
            # Decide on the type of delta & diff filtering to use
2344
 
            # TODO: add an --all-files option to make this configurable & consistent
2345
 
            if not verbose:
2346
 
                delta_type = None
2347
 
            else:
2348
 
                delta_type = 'full'
2349
 
            if not show_diff:
2350
 
                diff_type = None
2351
 
            elif file_ids:
2352
 
                diff_type = 'partial'
2353
 
            else:
2354
 
                diff_type = 'full'
2355
 
 
2356
 
            # Build the log formatter
2357
 
            if log_format is None:
2358
 
                log_format = log.log_formatter_registry.get_default(b)
2359
 
            # Make a non-encoding output to include the diffs - bug 328007
2360
 
            unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2361
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2362
 
                            to_exact_file=unencoded_output,
2363
 
                            show_timezone=timezone,
2364
 
                            delta_format=get_verbosity_level(),
2365
 
                            levels=levels,
2366
 
                            show_advice=levels is None)
2367
 
 
2368
 
            # Choose the algorithm for doing the logging. It's annoying
2369
 
            # having multiple code paths like this but necessary until
2370
 
            # the underlying repository format is faster at generating
2371
 
            # deltas or can provide everything we need from the indices.
2372
 
            # The default algorithm - match-using-deltas - works for
2373
 
            # multiple files and directories and is faster for small
2374
 
            # amounts of history (200 revisions say). However, it's too
2375
 
            # slow for logging a single file in a repository with deep
2376
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2377
 
            # evil when adding features", we continue to use the
2378
 
            # original algorithm - per-file-graph - for the "single
2379
 
            # file that isn't a directory without showing a delta" case.
2380
 
            partial_history = revision and b.repository._format.supports_chks
2381
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2382
 
                or delta_type or partial_history)
2383
 
 
2384
 
            # Build the LogRequest and execute it
2385
 
            if len(file_ids) == 0:
2386
 
                file_ids = None
2387
 
            rqst = make_log_request_dict(
2388
 
                direction=direction, specific_fileids=file_ids,
2389
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2390
 
                message_search=message, delta_type=delta_type,
2391
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2392
 
            Logger(b, rqst).show(lf)
2393
 
        finally:
2394
 
            if b is not None:
2395
 
                b.unlock()
 
2367
                    file_ids.append(file_id)
 
2368
                filter_by_dir = filter_by_dir or (
 
2369
                    kind in ['directory', 'tree-reference'])
 
2370
        else:
 
2371
            # log everything
 
2372
            # FIXME ? log the current subdir only RBC 20060203
 
2373
            if revision is not None \
 
2374
                    and len(revision) > 0 and revision[0].get_branch():
 
2375
                location = revision[0].get_branch()
 
2376
            else:
 
2377
                location = '.'
 
2378
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2379
            b = dir.open_branch()
 
2380
            b.lock_read()
 
2381
            self.add_cleanup(b.unlock)
 
2382
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2383
 
 
2384
        # Decide on the type of delta & diff filtering to use
 
2385
        # TODO: add an --all-files option to make this configurable & consistent
 
2386
        if not verbose:
 
2387
            delta_type = None
 
2388
        else:
 
2389
            delta_type = 'full'
 
2390
        if not show_diff:
 
2391
            diff_type = None
 
2392
        elif file_ids:
 
2393
            diff_type = 'partial'
 
2394
        else:
 
2395
            diff_type = 'full'
 
2396
 
 
2397
        # Build the log formatter
 
2398
        if log_format is None:
 
2399
            log_format = log.log_formatter_registry.get_default(b)
 
2400
        # Make a non-encoding output to include the diffs - bug 328007
 
2401
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2402
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2403
                        to_exact_file=unencoded_output,
 
2404
                        show_timezone=timezone,
 
2405
                        delta_format=get_verbosity_level(),
 
2406
                        levels=levels,
 
2407
                        show_advice=levels is None)
 
2408
 
 
2409
        # Choose the algorithm for doing the logging. It's annoying
 
2410
        # having multiple code paths like this but necessary until
 
2411
        # the underlying repository format is faster at generating
 
2412
        # deltas or can provide everything we need from the indices.
 
2413
        # The default algorithm - match-using-deltas - works for
 
2414
        # multiple files and directories and is faster for small
 
2415
        # amounts of history (200 revisions say). However, it's too
 
2416
        # slow for logging a single file in a repository with deep
 
2417
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2418
        # evil when adding features", we continue to use the
 
2419
        # original algorithm - per-file-graph - for the "single
 
2420
        # file that isn't a directory without showing a delta" case.
 
2421
        partial_history = revision and b.repository._format.supports_chks
 
2422
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2423
            or delta_type or partial_history)
 
2424
 
 
2425
        # Build the LogRequest and execute it
 
2426
        if len(file_ids) == 0:
 
2427
            file_ids = None
 
2428
        rqst = make_log_request_dict(
 
2429
            direction=direction, specific_fileids=file_ids,
 
2430
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2431
            message_search=message, delta_type=delta_type,
 
2432
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2433
            exclude_common_ancestry=exclude_common_ancestry,
 
2434
            )
 
2435
        Logger(b, rqst).show(lf)
2396
2436
 
2397
2437
 
2398
2438
def _get_revision_range(revisionspec_list, branch, command_name):
2416
2456
            raise errors.BzrCommandError(
2417
2457
                "bzr %s doesn't accept two revisions in different"
2418
2458
                " branches." % command_name)
2419
 
        rev1 = start_spec.in_history(branch)
 
2459
        if start_spec.spec is None:
 
2460
            # Avoid loading all the history.
 
2461
            rev1 = RevisionInfo(branch, None, None)
 
2462
        else:
 
2463
            rev1 = start_spec.in_history(branch)
2420
2464
        # Avoid loading all of history when we know a missing
2421
2465
        # end of range means the last revision ...
2422
2466
        if end_spec.spec is None:
2451
2495
 
2452
2496
 
2453
2497
class cmd_touching_revisions(Command):
2454
 
    """Return revision-ids which affected a particular file.
 
2498
    __doc__ = """Return revision-ids which affected a particular file.
2455
2499
 
2456
2500
    A more user-friendly interface is "bzr log FILE".
2457
2501
    """
2465
2509
        file_id = tree.path2id(relpath)
2466
2510
        b = tree.branch
2467
2511
        b.lock_read()
2468
 
        try:
2469
 
            touching_revs = log.find_touching_revisions(b, file_id)
2470
 
            for revno, revision_id, what in touching_revs:
2471
 
                self.outf.write("%6d %s\n" % (revno, what))
2472
 
        finally:
2473
 
            b.unlock()
 
2512
        self.add_cleanup(b.unlock)
 
2513
        touching_revs = log.find_touching_revisions(b, file_id)
 
2514
        for revno, revision_id, what in touching_revs:
 
2515
            self.outf.write("%6d %s\n" % (revno, what))
2474
2516
 
2475
2517
 
2476
2518
class cmd_ls(Command):
2477
 
    """List files in a tree.
 
2519
    __doc__ = """List files in a tree.
2478
2520
    """
2479
2521
 
2480
2522
    _see_also = ['status', 'cat']
2543
2585
                note("Ignoring files outside view. View is %s" % view_str)
2544
2586
 
2545
2587
        tree.lock_read()
2546
 
        try:
2547
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2548
 
                from_dir=relpath, recursive=recursive):
2549
 
                # Apply additional masking
2550
 
                if not all and not selection[fc]:
2551
 
                    continue
2552
 
                if kind is not None and fkind != kind:
2553
 
                    continue
2554
 
                if apply_view:
2555
 
                    try:
2556
 
                        if relpath:
2557
 
                            fullpath = osutils.pathjoin(relpath, fp)
2558
 
                        else:
2559
 
                            fullpath = fp
2560
 
                        views.check_path_in_view(tree, fullpath)
2561
 
                    except errors.FileOutsideView:
2562
 
                        continue
 
2588
        self.add_cleanup(tree.unlock)
 
2589
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2590
            from_dir=relpath, recursive=recursive):
 
2591
            # Apply additional masking
 
2592
            if not all and not selection[fc]:
 
2593
                continue
 
2594
            if kind is not None and fkind != kind:
 
2595
                continue
 
2596
            if apply_view:
 
2597
                try:
 
2598
                    if relpath:
 
2599
                        fullpath = osutils.pathjoin(relpath, fp)
 
2600
                    else:
 
2601
                        fullpath = fp
 
2602
                    views.check_path_in_view(tree, fullpath)
 
2603
                except errors.FileOutsideView:
 
2604
                    continue
2563
2605
 
2564
 
                # Output the entry
2565
 
                if prefix:
2566
 
                    fp = osutils.pathjoin(prefix, fp)
2567
 
                kindch = entry.kind_character()
2568
 
                outstring = fp + kindch
2569
 
                ui.ui_factory.clear_term()
2570
 
                if verbose:
2571
 
                    outstring = '%-8s %s' % (fc, outstring)
2572
 
                    if show_ids and fid is not None:
2573
 
                        outstring = "%-50s %s" % (outstring, fid)
 
2606
            # Output the entry
 
2607
            if prefix:
 
2608
                fp = osutils.pathjoin(prefix, fp)
 
2609
            kindch = entry.kind_character()
 
2610
            outstring = fp + kindch
 
2611
            ui.ui_factory.clear_term()
 
2612
            if verbose:
 
2613
                outstring = '%-8s %s' % (fc, outstring)
 
2614
                if show_ids and fid is not None:
 
2615
                    outstring = "%-50s %s" % (outstring, fid)
 
2616
                self.outf.write(outstring + '\n')
 
2617
            elif null:
 
2618
                self.outf.write(fp + '\0')
 
2619
                if show_ids:
 
2620
                    if fid is not None:
 
2621
                        self.outf.write(fid)
 
2622
                    self.outf.write('\0')
 
2623
                self.outf.flush()
 
2624
            else:
 
2625
                if show_ids:
 
2626
                    if fid is not None:
 
2627
                        my_id = fid
 
2628
                    else:
 
2629
                        my_id = ''
 
2630
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2631
                else:
2574
2632
                    self.outf.write(outstring + '\n')
2575
 
                elif null:
2576
 
                    self.outf.write(fp + '\0')
2577
 
                    if show_ids:
2578
 
                        if fid is not None:
2579
 
                            self.outf.write(fid)
2580
 
                        self.outf.write('\0')
2581
 
                    self.outf.flush()
2582
 
                else:
2583
 
                    if show_ids:
2584
 
                        if fid is not None:
2585
 
                            my_id = fid
2586
 
                        else:
2587
 
                            my_id = ''
2588
 
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
2589
 
                    else:
2590
 
                        self.outf.write(outstring + '\n')
2591
 
        finally:
2592
 
            tree.unlock()
2593
2633
 
2594
2634
 
2595
2635
class cmd_unknowns(Command):
2596
 
    """List unknown files.
 
2636
    __doc__ = """List unknown files.
2597
2637
    """
2598
2638
 
2599
2639
    hidden = True
2606
2646
 
2607
2647
 
2608
2648
class cmd_ignore(Command):
2609
 
    """Ignore specified files or patterns.
 
2649
    __doc__ = """Ignore specified files or patterns.
2610
2650
 
2611
2651
    See ``bzr help patterns`` for details on the syntax of patterns.
2612
2652
 
2620
2660
    After adding, editing or deleting that file either indirectly by
2621
2661
    using this command or directly by using an editor, be sure to commit
2622
2662
    it.
 
2663
    
 
2664
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2665
    the global ignore file can be found in the application data directory as
 
2666
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2667
    Global ignores are not touched by this command. The global ignore file
 
2668
    can be edited directly using an editor.
 
2669
 
 
2670
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
2671
    precedence over regular ignores.  Such exceptions are used to specify
 
2672
    files that should be versioned which would otherwise be ignored.
 
2673
    
 
2674
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
2675
    precedence over the '!' exception patterns.
2623
2676
 
2624
2677
    Note: ignore patterns containing shell wildcards must be quoted from
2625
2678
    the shell on Unix.
2629
2682
 
2630
2683
            bzr ignore ./Makefile
2631
2684
 
2632
 
        Ignore class files in all directories::
 
2685
        Ignore .class files in all directories...::
2633
2686
 
2634
2687
            bzr ignore "*.class"
2635
2688
 
 
2689
        ...but do not ignore "special.class"::
 
2690
 
 
2691
            bzr ignore "!special.class"
 
2692
 
2636
2693
        Ignore .o files under the lib directory::
2637
2694
 
2638
2695
            bzr ignore "lib/**/*.o"
2644
2701
        Ignore everything but the "debian" toplevel directory::
2645
2702
 
2646
2703
            bzr ignore "RE:(?!debian/).*"
 
2704
        
 
2705
        Ignore everything except the "local" toplevel directory,
 
2706
        but always ignore "*~" autosave files, even under local/::
 
2707
        
 
2708
            bzr ignore "*"
 
2709
            bzr ignore "!./local"
 
2710
            bzr ignore "!!*~"
2647
2711
    """
2648
2712
 
2649
2713
    _see_also = ['status', 'ignored', 'patterns']
2650
2714
    takes_args = ['name_pattern*']
2651
2715
    takes_options = [
2652
 
        Option('old-default-rules',
2653
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2716
        Option('default-rules',
 
2717
               help='Display the default ignore rules that bzr uses.')
2654
2718
        ]
2655
2719
 
2656
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2720
    def run(self, name_pattern_list=None, default_rules=None):
2657
2721
        from bzrlib import ignores
2658
 
        if old_default_rules is not None:
2659
 
            # dump the rules and exit
2660
 
            for pattern in ignores.OLD_DEFAULTS:
2661
 
                print pattern
 
2722
        if default_rules is not None:
 
2723
            # dump the default rules and exit
 
2724
            for pattern in ignores.USER_DEFAULTS:
 
2725
                self.outf.write("%s\n" % pattern)
2662
2726
            return
2663
2727
        if not name_pattern_list:
2664
2728
            raise errors.BzrCommandError("ignore requires at least one "
2665
 
                                  "NAME_PATTERN or --old-default-rules")
 
2729
                "NAME_PATTERN or --default-rules.")
2666
2730
        name_pattern_list = [globbing.normalize_pattern(p)
2667
2731
                             for p in name_pattern_list]
2668
2732
        for name_pattern in name_pattern_list:
2680
2744
            if id is not None:
2681
2745
                filename = entry[0]
2682
2746
                if ignored.match(filename):
2683
 
                    matches.append(filename.encode('utf-8'))
 
2747
                    matches.append(filename)
2684
2748
        tree.unlock()
2685
2749
        if len(matches) > 0:
2686
 
            print "Warning: the following files are version controlled and" \
2687
 
                  " match your ignore pattern:\n%s" \
2688
 
                  "\nThese files will continue to be version controlled" \
2689
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2750
            self.outf.write("Warning: the following files are version controlled and"
 
2751
                  " match your ignore pattern:\n%s"
 
2752
                  "\nThese files will continue to be version controlled"
 
2753
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2690
2754
 
2691
2755
 
2692
2756
class cmd_ignored(Command):
2693
 
    """List ignored files and the patterns that matched them.
 
2757
    __doc__ = """List ignored files and the patterns that matched them.
2694
2758
 
2695
2759
    List all the ignored files and the ignore pattern that caused the file to
2696
2760
    be ignored.
2707
2771
    def run(self):
2708
2772
        tree = WorkingTree.open_containing(u'.')[0]
2709
2773
        tree.lock_read()
2710
 
        try:
2711
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2712
 
                if file_class != 'I':
2713
 
                    continue
2714
 
                ## XXX: Slightly inefficient since this was already calculated
2715
 
                pat = tree.is_ignored(path)
2716
 
                self.outf.write('%-50s %s\n' % (path, pat))
2717
 
        finally:
2718
 
            tree.unlock()
 
2774
        self.add_cleanup(tree.unlock)
 
2775
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2776
            if file_class != 'I':
 
2777
                continue
 
2778
            ## XXX: Slightly inefficient since this was already calculated
 
2779
            pat = tree.is_ignored(path)
 
2780
            self.outf.write('%-50s %s\n' % (path, pat))
2719
2781
 
2720
2782
 
2721
2783
class cmd_lookup_revision(Command):
2722
 
    """Lookup the revision-id from a revision-number
 
2784
    __doc__ = """Lookup the revision-id from a revision-number
2723
2785
 
2724
2786
    :Examples:
2725
2787
        bzr lookup-revision 33
2732
2794
        try:
2733
2795
            revno = int(revno)
2734
2796
        except ValueError:
2735
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2736
 
 
2737
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2797
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2798
                                         % revno)
 
2799
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2800
        self.outf.write("%s\n" % revid)
2738
2801
 
2739
2802
 
2740
2803
class cmd_export(Command):
2741
 
    """Export current or past revision to a destination directory or archive.
 
2804
    __doc__ = """Export current or past revision to a destination directory or archive.
2742
2805
 
2743
2806
    If no revision is specified this exports the last committed revision.
2744
2807
 
2776
2839
        Option('root',
2777
2840
               type=str,
2778
2841
               help="Name of the root directory inside the exported file."),
 
2842
        Option('per-file-timestamps',
 
2843
               help='Set modification time of files to that of the last '
 
2844
                    'revision in which it was changed.'),
2779
2845
        ]
2780
2846
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2781
 
        root=None, filters=False):
 
2847
        root=None, filters=False, per_file_timestamps=False):
2782
2848
        from bzrlib.export import export
2783
2849
 
2784
2850
        if branch_or_subdir is None:
2791
2857
 
2792
2858
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2793
2859
        try:
2794
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2860
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2861
                   per_file_timestamps=per_file_timestamps)
2795
2862
        except errors.NoSuchExportFormat, e:
2796
2863
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2797
2864
 
2798
2865
 
2799
2866
class cmd_cat(Command):
2800
 
    """Write the contents of a file as of a given revision to standard output.
 
2867
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2801
2868
 
2802
2869
    If no revision is nominated, the last revision is used.
2803
2870
 
2824
2891
        tree, branch, relpath = \
2825
2892
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2826
2893
        branch.lock_read()
2827
 
        try:
2828
 
            return self._run(tree, branch, relpath, filename, revision,
2829
 
                             name_from_revision, filters)
2830
 
        finally:
2831
 
            branch.unlock()
 
2894
        self.add_cleanup(branch.unlock)
 
2895
        return self._run(tree, branch, relpath, filename, revision,
 
2896
                         name_from_revision, filters)
2832
2897
 
2833
2898
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2834
2899
        filtered):
2835
2900
        if tree is None:
2836
2901
            tree = b.basis_tree()
2837
2902
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2903
        rev_tree.lock_read()
 
2904
        self.add_cleanup(rev_tree.unlock)
2838
2905
 
2839
2906
        old_file_id = rev_tree.path2id(relpath)
2840
2907
 
2875
2942
            chunks = content.splitlines(True)
2876
2943
            content = filtered_output_bytes(chunks, filters,
2877
2944
                ContentFilterContext(relpath, rev_tree))
 
2945
            self.cleanup_now()
2878
2946
            self.outf.writelines(content)
2879
2947
        else:
 
2948
            self.cleanup_now()
2880
2949
            self.outf.write(content)
2881
2950
 
2882
2951
 
2883
2952
class cmd_local_time_offset(Command):
2884
 
    """Show the offset in seconds from GMT to local time."""
 
2953
    __doc__ = """Show the offset in seconds from GMT to local time."""
2885
2954
    hidden = True
2886
2955
    @display_command
2887
2956
    def run(self):
2888
 
        print osutils.local_time_offset()
 
2957
        self.outf.write("%s\n" % osutils.local_time_offset())
2889
2958
 
2890
2959
 
2891
2960
 
2892
2961
class cmd_commit(Command):
2893
 
    """Commit changes into a new revision.
 
2962
    __doc__ = """Commit changes into a new revision.
2894
2963
 
2895
2964
    An explanatory message needs to be given for each commit. This is
2896
2965
    often done by using the --message option (getting the message from the
3004
3073
                         "the master branch until a normal commit "
3005
3074
                         "is performed."
3006
3075
                    ),
3007
 
             Option('show-diff',
 
3076
             Option('show-diff', short_name='p',
3008
3077
                    help='When no message is supplied, show the diff along'
3009
3078
                    ' with the status summary in the message editor.'),
3010
3079
             ]
3090
3159
                    '(use --file "%(f)s" to take commit message from that file)'
3091
3160
                    % { 'f': message })
3092
3161
                ui.ui_factory.show_warning(warning_msg)
 
3162
            if '\r' in message:
 
3163
                message = message.replace('\r\n', '\n')
 
3164
                message = message.replace('\r', '\n')
 
3165
            if file:
 
3166
                raise errors.BzrCommandError(
 
3167
                    "please specify either --message or --file")
3093
3168
 
3094
3169
        def get_message(commit_obj):
3095
3170
            """Callback to get commit message"""
3096
 
            my_message = message
3097
 
            if my_message is not None and '\r' in my_message:
3098
 
                my_message = my_message.replace('\r\n', '\n')
3099
 
                my_message = my_message.replace('\r', '\n')
3100
 
            if my_message is None and not file:
3101
 
                t = make_commit_message_template_encoded(tree,
 
3171
            if file:
 
3172
                my_message = codecs.open(
 
3173
                    file, 'rt', osutils.get_user_encoding()).read()
 
3174
            elif message is not None:
 
3175
                my_message = message
 
3176
            else:
 
3177
                # No message supplied: make one up.
 
3178
                # text is the status of the tree
 
3179
                text = make_commit_message_template_encoded(tree,
3102
3180
                        selected_list, diff=show_diff,
3103
3181
                        output_encoding=osutils.get_user_encoding())
 
3182
                # start_message is the template generated from hooks
 
3183
                # XXX: Warning - looks like hooks return unicode,
 
3184
                # make_commit_message_template_encoded returns user encoding.
 
3185
                # We probably want to be using edit_commit_message instead to
 
3186
                # avoid this.
3104
3187
                start_message = generate_commit_message_template(commit_obj)
3105
 
                my_message = edit_commit_message_encoded(t,
 
3188
                my_message = edit_commit_message_encoded(text,
3106
3189
                    start_message=start_message)
3107
3190
                if my_message is None:
3108
3191
                    raise errors.BzrCommandError("please specify a commit"
3109
3192
                        " message with either --message or --file")
3110
 
            elif my_message and file:
3111
 
                raise errors.BzrCommandError(
3112
 
                    "please specify either --message or --file")
3113
 
            if file:
3114
 
                my_message = codecs.open(file, 'rt',
3115
 
                                         osutils.get_user_encoding()).read()
3116
3193
            if my_message == "":
3117
3194
                raise errors.BzrCommandError("empty commit message specified")
3118
3195
            return my_message
3130
3207
                        timezone=offset,
3131
3208
                        exclude=safe_relpath_files(tree, exclude))
3132
3209
        except PointlessCommit:
3133
 
            # FIXME: This should really happen before the file is read in;
3134
 
            # perhaps prepare the commit; get the message; then actually commit
3135
3210
            raise errors.BzrCommandError("No changes to commit."
3136
3211
                              " Use --unchanged to commit anyhow.")
3137
3212
        except ConflictsInTree:
3142
3217
            raise errors.BzrCommandError("Commit refused because there are"
3143
3218
                              " unknown files in the working tree.")
3144
3219
        except errors.BoundBranchOutOfDate, e:
3145
 
            raise errors.BzrCommandError(str(e) + "\n"
3146
 
            'To commit to master branch, run update and then commit.\n'
3147
 
            'You can also pass --local to commit to continue working '
3148
 
            'disconnected.')
 
3220
            e.extra_help = ("\n"
 
3221
                'To commit to master branch, run update and then commit.\n'
 
3222
                'You can also pass --local to commit to continue working '
 
3223
                'disconnected.')
 
3224
            raise
3149
3225
 
3150
3226
 
3151
3227
class cmd_check(Command):
3152
 
    """Validate working tree structure, branch consistency and repository history.
 
3228
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3153
3229
 
3154
3230
    This command checks various invariants about branch and repository storage
3155
3231
    to detect data corruption or bzr bugs.
3219
3295
 
3220
3296
 
3221
3297
class cmd_upgrade(Command):
3222
 
    """Upgrade branch storage to current format.
 
3298
    __doc__ = """Upgrade branch storage to current format.
3223
3299
 
3224
3300
    The check command or bzr developers may sometimes advise you to run
3225
3301
    this command. When the default format has changed you may also be warned
3243
3319
 
3244
3320
 
3245
3321
class cmd_whoami(Command):
3246
 
    """Show or set bzr user id.
 
3322
    __doc__ = """Show or set bzr user id.
3247
3323
 
3248
3324
    :Examples:
3249
3325
        Show the email of the current user::
3293
3369
 
3294
3370
 
3295
3371
class cmd_nick(Command):
3296
 
    """Print or set the branch nickname.
 
3372
    __doc__ = """Print or set the branch nickname.
3297
3373
 
3298
3374
    If unset, the tree root directory name is used as the nickname.
3299
3375
    To print the current nickname, execute with no argument.
3313
3389
 
3314
3390
    @display_command
3315
3391
    def printme(self, branch):
3316
 
        print branch.nick
 
3392
        self.outf.write('%s\n' % branch.nick)
3317
3393
 
3318
3394
 
3319
3395
class cmd_alias(Command):
3320
 
    """Set/unset and display aliases.
 
3396
    __doc__ = """Set/unset and display aliases.
3321
3397
 
3322
3398
    :Examples:
3323
3399
        Show the current aliases::
3387
3463
 
3388
3464
 
3389
3465
class cmd_selftest(Command):
3390
 
    """Run internal test suite.
 
3466
    __doc__ = """Run internal test suite.
3391
3467
 
3392
3468
    If arguments are given, they are regular expressions that say which tests
3393
3469
    should run.  Tests matching any expression are run, and other tests are
3437
3513
    def get_transport_type(typestring):
3438
3514
        """Parse and return a transport specifier."""
3439
3515
        if typestring == "sftp":
3440
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3441
 
            return SFTPAbsoluteServer
 
3516
            from bzrlib.tests import stub_sftp
 
3517
            return stub_sftp.SFTPAbsoluteServer
3442
3518
        if typestring == "memory":
3443
 
            from bzrlib.transport.memory import MemoryServer
3444
 
            return MemoryServer
 
3519
            from bzrlib.tests import test_server
 
3520
            return memory.MemoryServer
3445
3521
        if typestring == "fakenfs":
3446
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3447
 
            return FakeNFSServer
 
3522
            from bzrlib.tests import test_server
 
3523
            return test_server.FakeNFSServer
3448
3524
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3449
3525
            (typestring)
3450
3526
        raise errors.BzrCommandError(msg)
3534
3610
                raise errors.BzrCommandError("subunit not available. subunit "
3535
3611
                    "needs to be installed to use --subunit.")
3536
3612
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3613
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3614
            # stdout, which would corrupt the subunit stream. 
 
3615
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3616
                import msvcrt
 
3617
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3537
3618
        if parallel:
3538
3619
            self.additional_selftest_args.setdefault(
3539
3620
                'suite_decorators', []).append(parallel)
3543
3624
            verbose = not is_quiet()
3544
3625
            # TODO: should possibly lock the history file...
3545
3626
            benchfile = open(".perf_history", "at", buffering=1)
 
3627
            self.add_cleanup(benchfile.close)
3546
3628
        else:
3547
3629
            test_suite_factory = None
3548
3630
            benchfile = None
3549
 
        try:
3550
 
            selftest_kwargs = {"verbose": verbose,
3551
 
                              "pattern": pattern,
3552
 
                              "stop_on_failure": one,
3553
 
                              "transport": transport,
3554
 
                              "test_suite_factory": test_suite_factory,
3555
 
                              "lsprof_timed": lsprof_timed,
3556
 
                              "lsprof_tests": lsprof_tests,
3557
 
                              "bench_history": benchfile,
3558
 
                              "matching_tests_first": first,
3559
 
                              "list_only": list_only,
3560
 
                              "random_seed": randomize,
3561
 
                              "exclude_pattern": exclude,
3562
 
                              "strict": strict,
3563
 
                              "load_list": load_list,
3564
 
                              "debug_flags": debugflag,
3565
 
                              "starting_with": starting_with
3566
 
                              }
3567
 
            selftest_kwargs.update(self.additional_selftest_args)
3568
 
            result = selftest(**selftest_kwargs)
3569
 
        finally:
3570
 
            if benchfile is not None:
3571
 
                benchfile.close()
 
3631
        selftest_kwargs = {"verbose": verbose,
 
3632
                          "pattern": pattern,
 
3633
                          "stop_on_failure": one,
 
3634
                          "transport": transport,
 
3635
                          "test_suite_factory": test_suite_factory,
 
3636
                          "lsprof_timed": lsprof_timed,
 
3637
                          "lsprof_tests": lsprof_tests,
 
3638
                          "bench_history": benchfile,
 
3639
                          "matching_tests_first": first,
 
3640
                          "list_only": list_only,
 
3641
                          "random_seed": randomize,
 
3642
                          "exclude_pattern": exclude,
 
3643
                          "strict": strict,
 
3644
                          "load_list": load_list,
 
3645
                          "debug_flags": debugflag,
 
3646
                          "starting_with": starting_with
 
3647
                          }
 
3648
        selftest_kwargs.update(self.additional_selftest_args)
 
3649
        result = selftest(**selftest_kwargs)
3572
3650
        return int(not result)
3573
3651
 
3574
3652
 
3575
3653
class cmd_version(Command):
3576
 
    """Show version of bzr."""
 
3654
    __doc__ = """Show version of bzr."""
3577
3655
 
3578
3656
    encoding_type = 'replace'
3579
3657
    takes_options = [
3590
3668
 
3591
3669
 
3592
3670
class cmd_rocks(Command):
3593
 
    """Statement of optimism."""
 
3671
    __doc__ = """Statement of optimism."""
3594
3672
 
3595
3673
    hidden = True
3596
3674
 
3597
3675
    @display_command
3598
3676
    def run(self):
3599
 
        print "It sure does!"
 
3677
        self.outf.write("It sure does!\n")
3600
3678
 
3601
3679
 
3602
3680
class cmd_find_merge_base(Command):
3603
 
    """Find and print a base revision for merging two branches."""
 
3681
    __doc__ = """Find and print a base revision for merging two branches."""
3604
3682
    # TODO: Options to specify revisions on either side, as if
3605
3683
    #       merging only part of the history.
3606
3684
    takes_args = ['branch', 'other']
3613
3691
        branch1 = Branch.open_containing(branch)[0]
3614
3692
        branch2 = Branch.open_containing(other)[0]
3615
3693
        branch1.lock_read()
3616
 
        try:
3617
 
            branch2.lock_read()
3618
 
            try:
3619
 
                last1 = ensure_null(branch1.last_revision())
3620
 
                last2 = ensure_null(branch2.last_revision())
3621
 
 
3622
 
                graph = branch1.repository.get_graph(branch2.repository)
3623
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3624
 
 
3625
 
                print 'merge base is revision %s' % base_rev_id
3626
 
            finally:
3627
 
                branch2.unlock()
3628
 
        finally:
3629
 
            branch1.unlock()
 
3694
        self.add_cleanup(branch1.unlock)
 
3695
        branch2.lock_read()
 
3696
        self.add_cleanup(branch2.unlock)
 
3697
        last1 = ensure_null(branch1.last_revision())
 
3698
        last2 = ensure_null(branch2.last_revision())
 
3699
 
 
3700
        graph = branch1.repository.get_graph(branch2.repository)
 
3701
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3702
 
 
3703
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3630
3704
 
3631
3705
 
3632
3706
class cmd_merge(Command):
3633
 
    """Perform a three-way merge.
 
3707
    __doc__ = """Perform a three-way merge.
3634
3708
 
3635
3709
    The source of the merge can be specified either in the form of a branch,
3636
3710
    or in the form of a path to a file containing a merge directive generated
3665
3739
    committed to record the result of the merge.
3666
3740
 
3667
3741
    merge refuses to run if there are any uncommitted changes, unless
3668
 
    --force is given.
 
3742
    --force is given. The --force option can also be used to create a
 
3743
    merge revision which has more than two parents.
 
3744
 
 
3745
    If one would like to merge changes from the working tree of the other
 
3746
    branch without merging any committed revisions, the --uncommitted option
 
3747
    can be given.
3669
3748
 
3670
3749
    To select only some changes to merge, use "merge -i", which will prompt
3671
3750
    you to apply each diff hunk and file change, similar to "shelve".
3686
3765
        To apply a merge directive contained in /tmp/merge::
3687
3766
 
3688
3767
            bzr merge /tmp/merge
 
3768
 
 
3769
        To create a merge revision with three parents from two branches
 
3770
        feature1a and feature1b:
 
3771
 
 
3772
            bzr merge ../feature1a
 
3773
            bzr merge ../feature1b --force
 
3774
            bzr commit -m 'revision with three parents'
3689
3775
    """
3690
3776
 
3691
3777
    encoding_type = 'exact'
3749
3835
        view_info = _get_view_info_for_change_reporter(tree)
3750
3836
        change_reporter = delta._ChangeReporter(
3751
3837
            unversioned_filter=tree.is_ignored, view_info=view_info)
3752
 
        cleanups = []
3753
 
        try:
3754
 
            pb = ui.ui_factory.nested_progress_bar()
3755
 
            cleanups.append(pb.finished)
3756
 
            tree.lock_write()
3757
 
            cleanups.append(tree.unlock)
3758
 
            if location is not None:
3759
 
                try:
3760
 
                    mergeable = bundle.read_mergeable_from_url(location,
3761
 
                        possible_transports=possible_transports)
3762
 
                except errors.NotABundle:
3763
 
                    mergeable = None
3764
 
                else:
3765
 
                    if uncommitted:
3766
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3767
 
                            ' with bundles or merge directives.')
3768
 
 
3769
 
                    if revision is not None:
3770
 
                        raise errors.BzrCommandError(
3771
 
                            'Cannot use -r with merge directives or bundles')
3772
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3773
 
                       mergeable, pb)
3774
 
 
3775
 
            if merger is None and uncommitted:
3776
 
                if revision is not None and len(revision) > 0:
3777
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3778
 
                        ' --revision at the same time.')
3779
 
                merger = self.get_merger_from_uncommitted(tree, location, pb,
3780
 
                                                          cleanups)
3781
 
                allow_pending = False
3782
 
 
3783
 
            if merger is None:
3784
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3785
 
                    location, revision, remember, possible_transports, pb)
3786
 
 
3787
 
            merger.merge_type = merge_type
3788
 
            merger.reprocess = reprocess
3789
 
            merger.show_base = show_base
3790
 
            self.sanity_check_merger(merger)
3791
 
            if (merger.base_rev_id == merger.other_rev_id and
3792
 
                merger.other_rev_id is not None):
3793
 
                note('Nothing to do.')
 
3838
        pb = ui.ui_factory.nested_progress_bar()
 
3839
        self.add_cleanup(pb.finished)
 
3840
        tree.lock_write()
 
3841
        self.add_cleanup(tree.unlock)
 
3842
        if location is not None:
 
3843
            try:
 
3844
                mergeable = bundle.read_mergeable_from_url(location,
 
3845
                    possible_transports=possible_transports)
 
3846
            except errors.NotABundle:
 
3847
                mergeable = None
 
3848
            else:
 
3849
                if uncommitted:
 
3850
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3851
                        ' with bundles or merge directives.')
 
3852
 
 
3853
                if revision is not None:
 
3854
                    raise errors.BzrCommandError(
 
3855
                        'Cannot use -r with merge directives or bundles')
 
3856
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3857
                   mergeable, None)
 
3858
 
 
3859
        if merger is None and uncommitted:
 
3860
            if revision is not None and len(revision) > 0:
 
3861
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3862
                    ' --revision at the same time.')
 
3863
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3864
            allow_pending = False
 
3865
 
 
3866
        if merger is None:
 
3867
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3868
                location, revision, remember, possible_transports, None)
 
3869
 
 
3870
        merger.merge_type = merge_type
 
3871
        merger.reprocess = reprocess
 
3872
        merger.show_base = show_base
 
3873
        self.sanity_check_merger(merger)
 
3874
        if (merger.base_rev_id == merger.other_rev_id and
 
3875
            merger.other_rev_id is not None):
 
3876
            note('Nothing to do.')
 
3877
            return 0
 
3878
        if pull:
 
3879
            if merger.interesting_files is not None:
 
3880
                raise errors.BzrCommandError('Cannot pull individual files')
 
3881
            if (merger.base_rev_id == tree.last_revision()):
 
3882
                result = tree.pull(merger.other_branch, False,
 
3883
                                   merger.other_rev_id)
 
3884
                result.report(self.outf)
3794
3885
                return 0
3795
 
            if pull:
3796
 
                if merger.interesting_files is not None:
3797
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3798
 
                if (merger.base_rev_id == tree.last_revision()):
3799
 
                    result = tree.pull(merger.other_branch, False,
3800
 
                                       merger.other_rev_id)
3801
 
                    result.report(self.outf)
3802
 
                    return 0
3803
 
            if merger.this_basis is None:
3804
 
                raise errors.BzrCommandError(
3805
 
                    "This branch has no commits."
3806
 
                    " (perhaps you would prefer 'bzr pull')")
3807
 
            if preview:
3808
 
                return self._do_preview(merger, cleanups)
3809
 
            elif interactive:
3810
 
                return self._do_interactive(merger, cleanups)
3811
 
            else:
3812
 
                return self._do_merge(merger, change_reporter, allow_pending,
3813
 
                                      verified)
3814
 
        finally:
3815
 
            for cleanup in reversed(cleanups):
3816
 
                cleanup()
 
3886
        if merger.this_basis is None:
 
3887
            raise errors.BzrCommandError(
 
3888
                "This branch has no commits."
 
3889
                " (perhaps you would prefer 'bzr pull')")
 
3890
        if preview:
 
3891
            return self._do_preview(merger)
 
3892
        elif interactive:
 
3893
            return self._do_interactive(merger)
 
3894
        else:
 
3895
            return self._do_merge(merger, change_reporter, allow_pending,
 
3896
                                  verified)
3817
3897
 
3818
 
    def _get_preview(self, merger, cleanups):
 
3898
    def _get_preview(self, merger):
3819
3899
        tree_merger = merger.make_merger()
3820
3900
        tt = tree_merger.make_preview_transform()
3821
 
        cleanups.append(tt.finalize)
 
3901
        self.add_cleanup(tt.finalize)
3822
3902
        result_tree = tt.get_preview_tree()
3823
3903
        return result_tree
3824
3904
 
3825
 
    def _do_preview(self, merger, cleanups):
 
3905
    def _do_preview(self, merger):
3826
3906
        from bzrlib.diff import show_diff_trees
3827
 
        result_tree = self._get_preview(merger, cleanups)
 
3907
        result_tree = self._get_preview(merger)
3828
3908
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3829
3909
                        old_label='', new_label='')
3830
3910
 
3840
3920
        else:
3841
3921
            return 0
3842
3922
 
3843
 
    def _do_interactive(self, merger, cleanups):
 
3923
    def _do_interactive(self, merger):
3844
3924
        """Perform an interactive merge.
3845
3925
 
3846
3926
        This works by generating a preview tree of the merge, then using
3848
3928
        and the preview tree.
3849
3929
        """
3850
3930
        from bzrlib import shelf_ui
3851
 
        result_tree = self._get_preview(merger, cleanups)
 
3931
        result_tree = self._get_preview(merger)
3852
3932
        writer = bzrlib.option.diff_writer_registry.get()
3853
3933
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3854
3934
                                   reporter=shelf_ui.ApplyReporter(),
3922
4002
            allow_pending = True
3923
4003
        return merger, allow_pending
3924
4004
 
3925
 
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
4005
    def get_merger_from_uncommitted(self, tree, location, pb):
3926
4006
        """Get a merger for uncommitted changes.
3927
4007
 
3928
4008
        :param tree: The tree the merger should apply to.
3929
4009
        :param location: The location containing uncommitted changes.
3930
4010
        :param pb: The progress bar to use for showing progress.
3931
 
        :param cleanups: A list of operations to perform to clean up the
3932
 
            temporary directories, unfinalized objects, etc.
3933
4011
        """
3934
4012
        location = self._select_branch_location(tree, location)[0]
3935
4013
        other_tree, other_path = WorkingTree.open_containing(location)
3987
4065
 
3988
4066
 
3989
4067
class cmd_remerge(Command):
3990
 
    """Redo a merge.
 
4068
    __doc__ = """Redo a merge.
3991
4069
 
3992
4070
    Use this if you want to try a different merge technique while resolving
3993
4071
    conflicts.  Some merge techniques are better than others, and remerge
4018
4096
 
4019
4097
    def run(self, file_list=None, merge_type=None, show_base=False,
4020
4098
            reprocess=False):
 
4099
        from bzrlib.conflicts import restore
4021
4100
        if merge_type is None:
4022
4101
            merge_type = _mod_merge.Merge3Merger
4023
4102
        tree, file_list = tree_files(file_list)
4024
4103
        tree.lock_write()
4025
 
        try:
4026
 
            parents = tree.get_parent_ids()
4027
 
            if len(parents) != 2:
4028
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
4029
 
                                             " merges.  Not cherrypicking or"
4030
 
                                             " multi-merges.")
4031
 
            repository = tree.branch.repository
4032
 
            interesting_ids = None
4033
 
            new_conflicts = []
4034
 
            conflicts = tree.conflicts()
4035
 
            if file_list is not None:
4036
 
                interesting_ids = set()
4037
 
                for filename in file_list:
4038
 
                    file_id = tree.path2id(filename)
4039
 
                    if file_id is None:
4040
 
                        raise errors.NotVersionedError(filename)
4041
 
                    interesting_ids.add(file_id)
4042
 
                    if tree.kind(file_id) != "directory":
4043
 
                        continue
 
4104
        self.add_cleanup(tree.unlock)
 
4105
        parents = tree.get_parent_ids()
 
4106
        if len(parents) != 2:
 
4107
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4108
                                         " merges.  Not cherrypicking or"
 
4109
                                         " multi-merges.")
 
4110
        repository = tree.branch.repository
 
4111
        interesting_ids = None
 
4112
        new_conflicts = []
 
4113
        conflicts = tree.conflicts()
 
4114
        if file_list is not None:
 
4115
            interesting_ids = set()
 
4116
            for filename in file_list:
 
4117
                file_id = tree.path2id(filename)
 
4118
                if file_id is None:
 
4119
                    raise errors.NotVersionedError(filename)
 
4120
                interesting_ids.add(file_id)
 
4121
                if tree.kind(file_id) != "directory":
 
4122
                    continue
4044
4123
 
4045
 
                    for name, ie in tree.inventory.iter_entries(file_id):
4046
 
                        interesting_ids.add(ie.file_id)
4047
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4048
 
            else:
4049
 
                # Remerge only supports resolving contents conflicts
4050
 
                allowed_conflicts = ('text conflict', 'contents conflict')
4051
 
                restore_files = [c.path for c in conflicts
4052
 
                                 if c.typestring in allowed_conflicts]
4053
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4054
 
            tree.set_conflicts(ConflictList(new_conflicts))
4055
 
            if file_list is not None:
4056
 
                restore_files = file_list
4057
 
            for filename in restore_files:
4058
 
                try:
4059
 
                    restore(tree.abspath(filename))
4060
 
                except errors.NotConflicted:
4061
 
                    pass
4062
 
            # Disable pending merges, because the file texts we are remerging
4063
 
            # have not had those merges performed.  If we use the wrong parents
4064
 
            # list, we imply that the working tree text has seen and rejected
4065
 
            # all the changes from the other tree, when in fact those changes
4066
 
            # have not yet been seen.
4067
 
            pb = ui.ui_factory.nested_progress_bar()
4068
 
            tree.set_parent_ids(parents[:1])
 
4124
                for name, ie in tree.inventory.iter_entries(file_id):
 
4125
                    interesting_ids.add(ie.file_id)
 
4126
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4127
        else:
 
4128
            # Remerge only supports resolving contents conflicts
 
4129
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4130
            restore_files = [c.path for c in conflicts
 
4131
                             if c.typestring in allowed_conflicts]
 
4132
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4133
        tree.set_conflicts(ConflictList(new_conflicts))
 
4134
        if file_list is not None:
 
4135
            restore_files = file_list
 
4136
        for filename in restore_files:
4069
4137
            try:
4070
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
4071
 
                                                             tree, parents[1])
4072
 
                merger.interesting_ids = interesting_ids
4073
 
                merger.merge_type = merge_type
4074
 
                merger.show_base = show_base
4075
 
                merger.reprocess = reprocess
4076
 
                conflicts = merger.do_merge()
4077
 
            finally:
4078
 
                tree.set_parent_ids(parents)
4079
 
                pb.finished()
 
4138
                restore(tree.abspath(filename))
 
4139
            except errors.NotConflicted:
 
4140
                pass
 
4141
        # Disable pending merges, because the file texts we are remerging
 
4142
        # have not had those merges performed.  If we use the wrong parents
 
4143
        # list, we imply that the working tree text has seen and rejected
 
4144
        # all the changes from the other tree, when in fact those changes
 
4145
        # have not yet been seen.
 
4146
        tree.set_parent_ids(parents[:1])
 
4147
        try:
 
4148
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4149
            merger.interesting_ids = interesting_ids
 
4150
            merger.merge_type = merge_type
 
4151
            merger.show_base = show_base
 
4152
            merger.reprocess = reprocess
 
4153
            conflicts = merger.do_merge()
4080
4154
        finally:
4081
 
            tree.unlock()
 
4155
            tree.set_parent_ids(parents)
4082
4156
        if conflicts > 0:
4083
4157
            return 1
4084
4158
        else:
4086
4160
 
4087
4161
 
4088
4162
class cmd_revert(Command):
4089
 
    """Revert files to a previous revision.
 
4163
    __doc__ = """Revert files to a previous revision.
4090
4164
 
4091
4165
    Giving a list of files will revert only those files.  Otherwise, all files
4092
4166
    will be reverted.  If the revision is not specified with '--revision', the
4111
4185
    created as above.  Directories containing unknown files will not be
4112
4186
    deleted.
4113
4187
 
4114
 
    The working tree contains a list of pending merged revisions, which will
4115
 
    be included as parents in the next commit.  Normally, revert clears that
4116
 
    list as well as reverting the files.  If any files are specified, revert
4117
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
4118
 
    revert ." in the tree root to revert all files but keep the merge record,
4119
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4188
    The working tree contains a list of revisions that have been merged but
 
4189
    not yet committed. These revisions will be included as additional parents
 
4190
    of the next commit.  Normally, using revert clears that list as well as
 
4191
    reverting the files.  If any files are specified, revert leaves the list
 
4192
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4193
    .`` in the tree root to revert all files but keep the recorded merges,
 
4194
    and ``bzr revert --forget-merges`` to clear the pending merge list without
4120
4195
    reverting any files.
4121
4196
 
4122
 
    Using "bzr revert --forget-merges", it is possible to apply the changes
4123
 
    from an arbitrary merge as a single revision.  To do this, perform the
4124
 
    merge as desired.  Then doing revert with the "--forget-merges" option will
4125
 
    keep the content of the tree as it was, but it will clear the list of
4126
 
    pending merges.  The next commit will then contain all of the changes that
4127
 
    would have been in the merge, but without any mention of the other parent
4128
 
    revisions.  Because this technique forgets where these changes originated,
4129
 
    it may cause additional conflicts on later merges involving the source and
 
4197
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4198
    changes from a branch in a single revision.  To do this, perform the merge
 
4199
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4200
    the content of the tree as it was, but it will clear the list of pending
 
4201
    merges.  The next commit will then contain all of the changes that are
 
4202
    present in the other branch, but without any other parent revisions.
 
4203
    Because this technique forgets where these changes originated, it may
 
4204
    cause additional conflicts on later merges involving the same source and
4130
4205
    target branches.
4131
4206
    """
4132
4207
 
4142
4217
    def run(self, revision=None, no_backup=False, file_list=None,
4143
4218
            forget_merges=None):
4144
4219
        tree, file_list = tree_files(file_list)
4145
 
        tree.lock_write()
4146
 
        try:
4147
 
            if forget_merges:
4148
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
4149
 
            else:
4150
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4151
 
        finally:
4152
 
            tree.unlock()
 
4220
        tree.lock_tree_write()
 
4221
        self.add_cleanup(tree.unlock)
 
4222
        if forget_merges:
 
4223
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4224
        else:
 
4225
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4153
4226
 
4154
4227
    @staticmethod
4155
4228
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4156
4229
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4157
 
        pb = ui.ui_factory.nested_progress_bar()
4158
 
        try:
4159
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
4160
 
                report_changes=True)
4161
 
        finally:
4162
 
            pb.finished()
 
4230
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4231
            report_changes=True)
4163
4232
 
4164
4233
 
4165
4234
class cmd_assert_fail(Command):
4166
 
    """Test reporting of assertion failures"""
 
4235
    __doc__ = """Test reporting of assertion failures"""
4167
4236
    # intended just for use in testing
4168
4237
 
4169
4238
    hidden = True
4173
4242
 
4174
4243
 
4175
4244
class cmd_help(Command):
4176
 
    """Show help on a command or other topic.
 
4245
    __doc__ = """Show help on a command or other topic.
4177
4246
    """
4178
4247
 
4179
4248
    _see_also = ['topics']
4192
4261
 
4193
4262
 
4194
4263
class cmd_shell_complete(Command):
4195
 
    """Show appropriate completions for context.
 
4264
    __doc__ = """Show appropriate completions for context.
4196
4265
 
4197
4266
    For a list of all available commands, say 'bzr shell-complete'.
4198
4267
    """
4207
4276
 
4208
4277
 
4209
4278
class cmd_missing(Command):
4210
 
    """Show unmerged/unpulled revisions between two branches.
 
4279
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4211
4280
 
4212
4281
    OTHER_BRANCH may be local or remote.
4213
4282
 
4291
4360
            restrict = 'remote'
4292
4361
 
4293
4362
        local_branch = Branch.open_containing(u".")[0]
 
4363
        local_branch.lock_read()
 
4364
        self.add_cleanup(local_branch.unlock)
 
4365
 
4294
4366
        parent = local_branch.get_parent()
4295
4367
        if other_branch is None:
4296
4368
            other_branch = parent
4305
4377
        remote_branch = Branch.open(other_branch)
4306
4378
        if remote_branch.base == local_branch.base:
4307
4379
            remote_branch = local_branch
 
4380
        else:
 
4381
            remote_branch.lock_read()
 
4382
            self.add_cleanup(remote_branch.unlock)
4308
4383
 
4309
4384
        local_revid_range = _revision_range_to_revid_range(
4310
4385
            _get_revision_range(my_revision, local_branch,
4314
4389
            _get_revision_range(revision,
4315
4390
                remote_branch, self.name()))
4316
4391
 
4317
 
        local_branch.lock_read()
4318
 
        try:
4319
 
            remote_branch.lock_read()
4320
 
            try:
4321
 
                local_extra, remote_extra = find_unmerged(
4322
 
                    local_branch, remote_branch, restrict,
4323
 
                    backward=not reverse,
4324
 
                    include_merges=include_merges,
4325
 
                    local_revid_range=local_revid_range,
4326
 
                    remote_revid_range=remote_revid_range)
4327
 
 
4328
 
                if log_format is None:
4329
 
                    registry = log.log_formatter_registry
4330
 
                    log_format = registry.get_default(local_branch)
4331
 
                lf = log_format(to_file=self.outf,
4332
 
                                show_ids=show_ids,
4333
 
                                show_timezone='original')
4334
 
 
4335
 
                status_code = 0
4336
 
                if local_extra and not theirs_only:
4337
 
                    message("You have %d extra revision(s):\n" %
4338
 
                        len(local_extra))
4339
 
                    for revision in iter_log_revisions(local_extra,
4340
 
                                        local_branch.repository,
4341
 
                                        verbose):
4342
 
                        lf.log_revision(revision)
4343
 
                    printed_local = True
4344
 
                    status_code = 1
4345
 
                else:
4346
 
                    printed_local = False
4347
 
 
4348
 
                if remote_extra and not mine_only:
4349
 
                    if printed_local is True:
4350
 
                        message("\n\n\n")
4351
 
                    message("You are missing %d revision(s):\n" %
4352
 
                        len(remote_extra))
4353
 
                    for revision in iter_log_revisions(remote_extra,
4354
 
                                        remote_branch.repository,
4355
 
                                        verbose):
4356
 
                        lf.log_revision(revision)
4357
 
                    status_code = 1
4358
 
 
4359
 
                if mine_only and not local_extra:
4360
 
                    # We checked local, and found nothing extra
4361
 
                    message('This branch is up to date.\n')
4362
 
                elif theirs_only and not remote_extra:
4363
 
                    # We checked remote, and found nothing extra
4364
 
                    message('Other branch is up to date.\n')
4365
 
                elif not (mine_only or theirs_only or local_extra or
4366
 
                          remote_extra):
4367
 
                    # We checked both branches, and neither one had extra
4368
 
                    # revisions
4369
 
                    message("Branches are up to date.\n")
4370
 
            finally:
4371
 
                remote_branch.unlock()
4372
 
        finally:
4373
 
            local_branch.unlock()
 
4392
        local_extra, remote_extra = find_unmerged(
 
4393
            local_branch, remote_branch, restrict,
 
4394
            backward=not reverse,
 
4395
            include_merges=include_merges,
 
4396
            local_revid_range=local_revid_range,
 
4397
            remote_revid_range=remote_revid_range)
 
4398
 
 
4399
        if log_format is None:
 
4400
            registry = log.log_formatter_registry
 
4401
            log_format = registry.get_default(local_branch)
 
4402
        lf = log_format(to_file=self.outf,
 
4403
                        show_ids=show_ids,
 
4404
                        show_timezone='original')
 
4405
 
 
4406
        status_code = 0
 
4407
        if local_extra and not theirs_only:
 
4408
            message("You have %d extra revision(s):\n" %
 
4409
                len(local_extra))
 
4410
            for revision in iter_log_revisions(local_extra,
 
4411
                                local_branch.repository,
 
4412
                                verbose):
 
4413
                lf.log_revision(revision)
 
4414
            printed_local = True
 
4415
            status_code = 1
 
4416
        else:
 
4417
            printed_local = False
 
4418
 
 
4419
        if remote_extra and not mine_only:
 
4420
            if printed_local is True:
 
4421
                message("\n\n\n")
 
4422
            message("You are missing %d revision(s):\n" %
 
4423
                len(remote_extra))
 
4424
            for revision in iter_log_revisions(remote_extra,
 
4425
                                remote_branch.repository,
 
4426
                                verbose):
 
4427
                lf.log_revision(revision)
 
4428
            status_code = 1
 
4429
 
 
4430
        if mine_only and not local_extra:
 
4431
            # We checked local, and found nothing extra
 
4432
            message('This branch is up to date.\n')
 
4433
        elif theirs_only and not remote_extra:
 
4434
            # We checked remote, and found nothing extra
 
4435
            message('Other branch is up to date.\n')
 
4436
        elif not (mine_only or theirs_only or local_extra or
 
4437
                  remote_extra):
 
4438
            # We checked both branches, and neither one had extra
 
4439
            # revisions
 
4440
            message("Branches are up to date.\n")
 
4441
        self.cleanup_now()
4374
4442
        if not status_code and parent is None and other_branch is not None:
4375
4443
            local_branch.lock_write()
4376
 
            try:
4377
 
                # handle race conditions - a parent might be set while we run.
4378
 
                if local_branch.get_parent() is None:
4379
 
                    local_branch.set_parent(remote_branch.base)
4380
 
            finally:
4381
 
                local_branch.unlock()
 
4444
            self.add_cleanup(local_branch.unlock)
 
4445
            # handle race conditions - a parent might be set while we run.
 
4446
            if local_branch.get_parent() is None:
 
4447
                local_branch.set_parent(remote_branch.base)
4382
4448
        return status_code
4383
4449
 
4384
4450
 
4385
4451
class cmd_pack(Command):
4386
 
    """Compress the data within a repository."""
 
4452
    __doc__ = """Compress the data within a repository.
 
4453
 
 
4454
    This operation compresses the data within a bazaar repository. As
 
4455
    bazaar supports automatic packing of repository, this operation is
 
4456
    normally not required to be done manually.
 
4457
 
 
4458
    During the pack operation, bazaar takes a backup of existing repository
 
4459
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4460
    automatically when it is safe to do so. To save disk space by removing
 
4461
    the backed up pack files, the --clean-obsolete-packs option may be
 
4462
    used.
 
4463
 
 
4464
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4465
    during or immediately after repacking, you may be left with a state
 
4466
    where the deletion has been written to disk but the new packs have not
 
4467
    been. In this case the repository may be unusable.
 
4468
    """
4387
4469
 
4388
4470
    _see_also = ['repositories']
4389
4471
    takes_args = ['branch_or_repo?']
 
4472
    takes_options = [
 
4473
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4474
        ]
4390
4475
 
4391
 
    def run(self, branch_or_repo='.'):
 
4476
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4392
4477
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4393
4478
        try:
4394
4479
            branch = dir.open_branch()
4395
4480
            repository = branch.repository
4396
4481
        except errors.NotBranchError:
4397
4482
            repository = dir.open_repository()
4398
 
        repository.pack()
 
4483
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4399
4484
 
4400
4485
 
4401
4486
class cmd_plugins(Command):
4402
 
    """List the installed plugins.
 
4487
    __doc__ = """List the installed plugins.
4403
4488
 
4404
4489
    This command displays the list of installed plugins including
4405
4490
    version of plugin and a short description of each.
4412
4497
    adding new commands, providing additional network transports and
4413
4498
    customizing log output.
4414
4499
 
4415
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4416
 
    information on plugins including where to find them and how to
4417
 
    install them. Instructions are also provided there on how to
4418
 
    write new plugins using the Python programming language.
 
4500
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4501
    for further information on plugins including where to find them and how to
 
4502
    install them. Instructions are also provided there on how to write new
 
4503
    plugins using the Python programming language.
4419
4504
    """
4420
4505
    takes_options = ['verbose']
4421
4506
 
4436
4521
                doc = '(no description)'
4437
4522
            result.append((name_ver, doc, plugin.path()))
4438
4523
        for name_ver, doc, path in sorted(result):
4439
 
            print name_ver
4440
 
            print '   ', doc
 
4524
            self.outf.write("%s\n" % name_ver)
 
4525
            self.outf.write("   %s\n" % doc)
4441
4526
            if verbose:
4442
 
                print '   ', path
4443
 
            print
 
4527
                self.outf.write("   %s\n" % path)
 
4528
            self.outf.write("\n")
4444
4529
 
4445
4530
 
4446
4531
class cmd_testament(Command):
4447
 
    """Show testament (signing-form) of a revision."""
 
4532
    __doc__ = """Show testament (signing-form) of a revision."""
4448
4533
    takes_options = [
4449
4534
            'revision',
4450
4535
            Option('long', help='Produce long-format testament.'),
4463
4548
        else:
4464
4549
            b = Branch.open(branch)
4465
4550
        b.lock_read()
4466
 
        try:
4467
 
            if revision is None:
4468
 
                rev_id = b.last_revision()
4469
 
            else:
4470
 
                rev_id = revision[0].as_revision_id(b)
4471
 
            t = testament_class.from_revision(b.repository, rev_id)
4472
 
            if long:
4473
 
                sys.stdout.writelines(t.as_text_lines())
4474
 
            else:
4475
 
                sys.stdout.write(t.as_short_text())
4476
 
        finally:
4477
 
            b.unlock()
 
4551
        self.add_cleanup(b.unlock)
 
4552
        if revision is None:
 
4553
            rev_id = b.last_revision()
 
4554
        else:
 
4555
            rev_id = revision[0].as_revision_id(b)
 
4556
        t = testament_class.from_revision(b.repository, rev_id)
 
4557
        if long:
 
4558
            sys.stdout.writelines(t.as_text_lines())
 
4559
        else:
 
4560
            sys.stdout.write(t.as_short_text())
4478
4561
 
4479
4562
 
4480
4563
class cmd_annotate(Command):
4481
 
    """Show the origin of each line in a file.
 
4564
    __doc__ = """Show the origin of each line in a file.
4482
4565
 
4483
4566
    This prints out the given file with an annotation on the left side
4484
4567
    indicating which revision, author and date introduced the change.
4506
4589
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4507
4590
        if wt is not None:
4508
4591
            wt.lock_read()
 
4592
            self.add_cleanup(wt.unlock)
4509
4593
        else:
4510
4594
            branch.lock_read()
4511
 
        try:
4512
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4513
 
            if wt is not None:
4514
 
                file_id = wt.path2id(relpath)
4515
 
            else:
4516
 
                file_id = tree.path2id(relpath)
4517
 
            if file_id is None:
4518
 
                raise errors.NotVersionedError(filename)
4519
 
            file_version = tree.inventory[file_id].revision
4520
 
            if wt is not None and revision is None:
4521
 
                # If there is a tree and we're not annotating historical
4522
 
                # versions, annotate the working tree's content.
4523
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4524
 
                    show_ids=show_ids)
4525
 
            else:
4526
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4527
 
                              show_ids=show_ids)
4528
 
        finally:
4529
 
            if wt is not None:
4530
 
                wt.unlock()
4531
 
            else:
4532
 
                branch.unlock()
 
4595
            self.add_cleanup(branch.unlock)
 
4596
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4597
        tree.lock_read()
 
4598
        self.add_cleanup(tree.unlock)
 
4599
        if wt is not None:
 
4600
            file_id = wt.path2id(relpath)
 
4601
        else:
 
4602
            file_id = tree.path2id(relpath)
 
4603
        if file_id is None:
 
4604
            raise errors.NotVersionedError(filename)
 
4605
        file_version = tree.inventory[file_id].revision
 
4606
        if wt is not None and revision is None:
 
4607
            # If there is a tree and we're not annotating historical
 
4608
            # versions, annotate the working tree's content.
 
4609
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4610
                show_ids=show_ids)
 
4611
        else:
 
4612
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4613
                          show_ids=show_ids)
4533
4614
 
4534
4615
 
4535
4616
class cmd_re_sign(Command):
4536
 
    """Create a digital signature for an existing revision."""
 
4617
    __doc__ = """Create a digital signature for an existing revision."""
4537
4618
    # TODO be able to replace existing ones.
4538
4619
 
4539
4620
    hidden = True # is this right ?
4547
4628
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4548
4629
        b = WorkingTree.open_containing(u'.')[0].branch
4549
4630
        b.lock_write()
4550
 
        try:
4551
 
            return self._run(b, revision_id_list, revision)
4552
 
        finally:
4553
 
            b.unlock()
 
4631
        self.add_cleanup(b.unlock)
 
4632
        return self._run(b, revision_id_list, revision)
4554
4633
 
4555
4634
    def _run(self, b, revision_id_list, revision):
4556
4635
        import bzrlib.gpg as gpg
4601
4680
 
4602
4681
 
4603
4682
class cmd_bind(Command):
4604
 
    """Convert the current branch into a checkout of the supplied branch.
 
4683
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4684
    If no branch is supplied, rebind to the last bound location.
4605
4685
 
4606
4686
    Once converted into a checkout, commits must succeed on the master branch
4607
4687
    before they will be applied to the local branch.
4625
4705
                    'This format does not remember old locations.')
4626
4706
            else:
4627
4707
                if location is None:
4628
 
                    raise errors.BzrCommandError('No location supplied and no '
4629
 
                        'previous location known')
 
4708
                    if b.get_bound_location() is not None:
 
4709
                        raise errors.BzrCommandError('Branch is already bound')
 
4710
                    else:
 
4711
                        raise errors.BzrCommandError('No location supplied '
 
4712
                            'and no previous location known')
4630
4713
        b_other = Branch.open(location)
4631
4714
        try:
4632
4715
            b.bind(b_other)
4638
4721
 
4639
4722
 
4640
4723
class cmd_unbind(Command):
4641
 
    """Convert the current checkout into a regular branch.
 
4724
    __doc__ = """Convert the current checkout into a regular branch.
4642
4725
 
4643
4726
    After unbinding, the local branch is considered independent and subsequent
4644
4727
    commits will be local only.
4655
4738
 
4656
4739
 
4657
4740
class cmd_uncommit(Command):
4658
 
    """Remove the last committed revision.
 
4741
    __doc__ = """Remove the last committed revision.
4659
4742
 
4660
4743
    --verbose will print out what is being removed.
4661
4744
    --dry-run will go through all the motions, but not actually
4702
4785
 
4703
4786
        if tree is not None:
4704
4787
            tree.lock_write()
 
4788
            self.add_cleanup(tree.unlock)
4705
4789
        else:
4706
4790
            b.lock_write()
4707
 
        try:
4708
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4709
 
                             local=local)
4710
 
        finally:
4711
 
            if tree is not None:
4712
 
                tree.unlock()
4713
 
            else:
4714
 
                b.unlock()
 
4791
            self.add_cleanup(b.unlock)
 
4792
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4715
4793
 
4716
4794
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4717
4795
        from bzrlib.log import log_formatter, show_log
4749
4827
                 end_revision=last_revno)
4750
4828
 
4751
4829
        if dry_run:
4752
 
            print 'Dry-run, pretending to remove the above revisions.'
4753
 
            if not force:
4754
 
                val = raw_input('Press <enter> to continue')
 
4830
            self.outf.write('Dry-run, pretending to remove'
 
4831
                            ' the above revisions.\n')
4755
4832
        else:
4756
 
            print 'The above revision(s) will be removed.'
4757
 
            if not force:
4758
 
                val = raw_input('Are you sure [y/N]? ')
4759
 
                if val.lower() not in ('y', 'yes'):
4760
 
                    print 'Canceled'
4761
 
                    return 0
 
4833
            self.outf.write('The above revision(s) will be removed.\n')
 
4834
 
 
4835
        if not force:
 
4836
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4837
                self.outf.write('Canceled')
 
4838
                return 0
4762
4839
 
4763
4840
        mutter('Uncommitting from {%s} to {%s}',
4764
4841
               last_rev_id, rev_id)
4765
4842
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4766
4843
                 revno=revno, local=local)
4767
 
        note('You can restore the old tip by running:\n'
4768
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4844
        self.outf.write('You can restore the old tip by running:\n'
 
4845
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4769
4846
 
4770
4847
 
4771
4848
class cmd_break_lock(Command):
4772
 
    """Break a dead lock on a repository, branch or working directory.
 
4849
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4773
4850
 
4774
4851
    CAUTION: Locks should only be broken when you are sure that the process
4775
4852
    holding the lock has been stopped.
4776
4853
 
4777
 
    You can get information on what locks are open via the 'bzr info' command.
 
4854
    You can get information on what locks are open via the 'bzr info
 
4855
    [location]' command.
4778
4856
 
4779
4857
    :Examples:
4780
4858
        bzr break-lock
 
4859
        bzr break-lock bzr+ssh://example.com/bzr/foo
4781
4860
    """
4782
4861
    takes_args = ['location?']
4783
4862
 
4792
4871
 
4793
4872
 
4794
4873
class cmd_wait_until_signalled(Command):
4795
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4874
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4796
4875
 
4797
4876
    This just prints a line to signal when it is ready, then blocks on stdin.
4798
4877
    """
4806
4885
 
4807
4886
 
4808
4887
class cmd_serve(Command):
4809
 
    """Run the bzr server."""
 
4888
    __doc__ = """Run the bzr server."""
4810
4889
 
4811
4890
    aliases = ['server']
4812
4891
 
4872
4951
 
4873
4952
 
4874
4953
class cmd_join(Command):
4875
 
    """Combine a tree into its containing tree.
 
4954
    __doc__ = """Combine a tree into its containing tree.
4876
4955
 
4877
4956
    This command requires the target tree to be in a rich-root format.
4878
4957
 
4918
4997
 
4919
4998
 
4920
4999
class cmd_split(Command):
4921
 
    """Split a subdirectory of a tree into a separate tree.
 
5000
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4922
5001
 
4923
5002
    This command will produce a target tree in a format that supports
4924
5003
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4944
5023
 
4945
5024
 
4946
5025
class cmd_merge_directive(Command):
4947
 
    """Generate a merge directive for auto-merge tools.
 
5026
    __doc__ = """Generate a merge directive for auto-merge tools.
4948
5027
 
4949
5028
    A directive requests a merge to be performed, and also provides all the
4950
5029
    information necessary to do so.  This means it must either include a
5043
5122
 
5044
5123
 
5045
5124
class cmd_send(Command):
5046
 
    """Mail or create a merge-directive for submitting changes.
 
5125
    __doc__ = """Mail or create a merge-directive for submitting changes.
5047
5126
 
5048
5127
    A merge directive provides many things needed for requesting merges:
5049
5128
 
5055
5134
      directly from the merge directive, without retrieving data from a
5056
5135
      branch.
5057
5136
 
5058
 
    If --no-bundle is specified, then public_branch is needed (and must be
5059
 
    up-to-date), so that the receiver can perform the merge using the
5060
 
    public_branch.  The public_branch is always included if known, so that
5061
 
    people can check it later.
5062
 
 
5063
 
    The submit branch defaults to the parent, but can be overridden.  Both
5064
 
    submit branch and public branch will be remembered if supplied.
5065
 
 
5066
 
    If a public_branch is known for the submit_branch, that public submit
5067
 
    branch is used in the merge instructions.  This means that a local mirror
5068
 
    can be used as your actual submit branch, once you have set public_branch
5069
 
    for that mirror.
 
5137
    `bzr send` creates a compact data set that, when applied using bzr
 
5138
    merge, has the same effect as merging from the source branch.  
 
5139
    
 
5140
    By default the merge directive is self-contained and can be applied to any
 
5141
    branch containing submit_branch in its ancestory without needing access to
 
5142
    the source branch.
 
5143
    
 
5144
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5145
    revisions, but only a structured request to merge from the
 
5146
    public_location.  In that case the public_branch is needed and it must be
 
5147
    up-to-date and accessible to the recipient.  The public_branch is always
 
5148
    included if known, so that people can check it later.
 
5149
 
 
5150
    The submit branch defaults to the parent of the source branch, but can be
 
5151
    overridden.  Both submit branch and public branch will be remembered in
 
5152
    branch.conf the first time they are used for a particular branch.  The
 
5153
    source branch defaults to that containing the working directory, but can
 
5154
    be changed using --from.
 
5155
 
 
5156
    In order to calculate those changes, bzr must analyse the submit branch.
 
5157
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5158
    If a public location is known for the submit_branch, that location is used
 
5159
    in the merge directive.
 
5160
 
 
5161
    The default behaviour is to send the merge directive by mail, unless -o is
 
5162
    given, in which case it is sent to a file.
5070
5163
 
5071
5164
    Mail is sent using your preferred mail program.  This should be transparent
5072
5165
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5092
5185
 
5093
5186
    The merge directives created by bzr send may be applied using bzr merge or
5094
5187
    bzr pull by specifying a file containing a merge directive as the location.
 
5188
 
 
5189
    bzr send makes extensive use of public locations to map local locations into
 
5190
    URLs that can be used by other people.  See `bzr help configuration` to
 
5191
    set them, and use `bzr info` to display them.
5095
5192
    """
5096
5193
 
5097
5194
    encoding_type = 'exact'
5113
5210
               short_name='f',
5114
5211
               type=unicode),
5115
5212
        Option('output', short_name='o',
5116
 
               help='Write merge directive to this file; '
 
5213
               help='Write merge directive to this file or directory; '
5117
5214
                    'use - for stdout.',
5118
5215
               type=unicode),
5119
5216
        Option('strict',
5142
5239
 
5143
5240
 
5144
5241
class cmd_bundle_revisions(cmd_send):
5145
 
    """Create a merge-directive for submitting changes.
 
5242
    __doc__ = """Create a merge-directive for submitting changes.
5146
5243
 
5147
5244
    A merge directive provides many things needed for requesting merges:
5148
5245
 
5215
5312
 
5216
5313
 
5217
5314
class cmd_tag(Command):
5218
 
    """Create, remove or modify a tag naming a revision.
 
5315
    __doc__ = """Create, remove or modify a tag naming a revision.
5219
5316
 
5220
5317
    Tags give human-meaningful names to revisions.  Commands that take a -r
5221
5318
    (--revision) option can be given -rtag:X, where X is any previously
5229
5326
 
5230
5327
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5231
5328
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5329
 
 
5330
    If no tag name is specified it will be determined through the 
 
5331
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5332
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5333
    details.
5232
5334
    """
5233
5335
 
5234
5336
    _see_also = ['commit', 'tags']
5235
 
    takes_args = ['tag_name']
 
5337
    takes_args = ['tag_name?']
5236
5338
    takes_options = [
5237
5339
        Option('delete',
5238
5340
            help='Delete this tag rather than placing it.',
5248
5350
        'revision',
5249
5351
        ]
5250
5352
 
5251
 
    def run(self, tag_name,
 
5353
    def run(self, tag_name=None,
5252
5354
            delete=None,
5253
5355
            directory='.',
5254
5356
            force=None,
5256
5358
            ):
5257
5359
        branch, relpath = Branch.open_containing(directory)
5258
5360
        branch.lock_write()
5259
 
        try:
5260
 
            if delete:
5261
 
                branch.tags.delete_tag(tag_name)
5262
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5361
        self.add_cleanup(branch.unlock)
 
5362
        if delete:
 
5363
            if tag_name is None:
 
5364
                raise errors.BzrCommandError("No tag specified to delete.")
 
5365
            branch.tags.delete_tag(tag_name)
 
5366
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5367
        else:
 
5368
            if revision:
 
5369
                if len(revision) != 1:
 
5370
                    raise errors.BzrCommandError(
 
5371
                        "Tags can only be placed on a single revision, "
 
5372
                        "not on a range")
 
5373
                revision_id = revision[0].as_revision_id(branch)
5263
5374
            else:
5264
 
                if revision:
5265
 
                    if len(revision) != 1:
5266
 
                        raise errors.BzrCommandError(
5267
 
                            "Tags can only be placed on a single revision, "
5268
 
                            "not on a range")
5269
 
                    revision_id = revision[0].as_revision_id(branch)
5270
 
                else:
5271
 
                    revision_id = branch.last_revision()
5272
 
                if (not force) and branch.tags.has_tag(tag_name):
5273
 
                    raise errors.TagAlreadyExists(tag_name)
5274
 
                branch.tags.set_tag(tag_name, revision_id)
5275
 
                self.outf.write('Created tag %s.\n' % tag_name)
5276
 
        finally:
5277
 
            branch.unlock()
 
5375
                revision_id = branch.last_revision()
 
5376
            if tag_name is None:
 
5377
                tag_name = branch.automatic_tag_name(revision_id)
 
5378
                if tag_name is None:
 
5379
                    raise errors.BzrCommandError(
 
5380
                        "Please specify a tag name.")
 
5381
            if (not force) and branch.tags.has_tag(tag_name):
 
5382
                raise errors.TagAlreadyExists(tag_name)
 
5383
            branch.tags.set_tag(tag_name, revision_id)
 
5384
            self.outf.write('Created tag %s.\n' % tag_name)
5278
5385
 
5279
5386
 
5280
5387
class cmd_tags(Command):
5281
 
    """List tags.
 
5388
    __doc__ = """List tags.
5282
5389
 
5283
5390
    This command shows a table of tag names and the revisions they reference.
5284
5391
    """
5313
5420
            return
5314
5421
 
5315
5422
        branch.lock_read()
5316
 
        try:
5317
 
            if revision:
5318
 
                graph = branch.repository.get_graph()
5319
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5320
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5321
 
                # only show revisions between revid1 and revid2 (inclusive)
5322
 
                tags = [(tag, revid) for tag, revid in tags if
5323
 
                    graph.is_between(revid, revid1, revid2)]
5324
 
            if sort == 'alpha':
5325
 
                tags.sort()
5326
 
            elif sort == 'time':
5327
 
                timestamps = {}
5328
 
                for tag, revid in tags:
5329
 
                    try:
5330
 
                        revobj = branch.repository.get_revision(revid)
5331
 
                    except errors.NoSuchRevision:
5332
 
                        timestamp = sys.maxint # place them at the end
5333
 
                    else:
5334
 
                        timestamp = revobj.timestamp
5335
 
                    timestamps[revid] = timestamp
5336
 
                tags.sort(key=lambda x: timestamps[x[1]])
5337
 
            if not show_ids:
5338
 
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5339
 
                for index, (tag, revid) in enumerate(tags):
5340
 
                    try:
5341
 
                        revno = branch.revision_id_to_dotted_revno(revid)
5342
 
                        if isinstance(revno, tuple):
5343
 
                            revno = '.'.join(map(str, revno))
5344
 
                    except errors.NoSuchRevision:
5345
 
                        # Bad tag data/merges can lead to tagged revisions
5346
 
                        # which are not in this branch. Fail gracefully ...
5347
 
                        revno = '?'
5348
 
                    tags[index] = (tag, revno)
5349
 
        finally:
5350
 
            branch.unlock()
 
5423
        self.add_cleanup(branch.unlock)
 
5424
        if revision:
 
5425
            graph = branch.repository.get_graph()
 
5426
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5427
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5428
            # only show revisions between revid1 and revid2 (inclusive)
 
5429
            tags = [(tag, revid) for tag, revid in tags if
 
5430
                graph.is_between(revid, revid1, revid2)]
 
5431
        if sort == 'alpha':
 
5432
            tags.sort()
 
5433
        elif sort == 'time':
 
5434
            timestamps = {}
 
5435
            for tag, revid in tags:
 
5436
                try:
 
5437
                    revobj = branch.repository.get_revision(revid)
 
5438
                except errors.NoSuchRevision:
 
5439
                    timestamp = sys.maxint # place them at the end
 
5440
                else:
 
5441
                    timestamp = revobj.timestamp
 
5442
                timestamps[revid] = timestamp
 
5443
            tags.sort(key=lambda x: timestamps[x[1]])
 
5444
        if not show_ids:
 
5445
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5446
            for index, (tag, revid) in enumerate(tags):
 
5447
                try:
 
5448
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5449
                    if isinstance(revno, tuple):
 
5450
                        revno = '.'.join(map(str, revno))
 
5451
                except errors.NoSuchRevision:
 
5452
                    # Bad tag data/merges can lead to tagged revisions
 
5453
                    # which are not in this branch. Fail gracefully ...
 
5454
                    revno = '?'
 
5455
                tags[index] = (tag, revno)
 
5456
        self.cleanup_now()
5351
5457
        for tag, revspec in tags:
5352
5458
            self.outf.write('%-20s %s\n' % (tag, revspec))
5353
5459
 
5354
5460
 
5355
5461
class cmd_reconfigure(Command):
5356
 
    """Reconfigure the type of a bzr directory.
 
5462
    __doc__ = """Reconfigure the type of a bzr directory.
5357
5463
 
5358
5464
    A target configuration must be specified.
5359
5465
 
5444
5550
 
5445
5551
 
5446
5552
class cmd_switch(Command):
5447
 
    """Set the branch of a checkout and update.
 
5553
    __doc__ = """Set the branch of a checkout and update.
5448
5554
 
5449
5555
    For lightweight checkouts, this changes the branch being referenced.
5450
5556
    For heavyweight checkouts, this checks that there are no local commits
5466
5572
    that of the master.
5467
5573
    """
5468
5574
 
5469
 
    takes_args = ['to_location']
 
5575
    takes_args = ['to_location?']
5470
5576
    takes_options = [Option('force',
5471
5577
                        help='Switch even if local commits will be lost.'),
 
5578
                     'revision',
5472
5579
                     Option('create-branch', short_name='b',
5473
5580
                        help='Create the target branch from this one before'
5474
5581
                             ' switching to it.'),
5475
 
                     ]
 
5582
                    ]
5476
5583
 
5477
 
    def run(self, to_location, force=False, create_branch=False):
 
5584
    def run(self, to_location=None, force=False, create_branch=False,
 
5585
            revision=None):
5478
5586
        from bzrlib import switch
5479
5587
        tree_location = '.'
 
5588
        revision = _get_one_revision('switch', revision)
5480
5589
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5590
        if to_location is None:
 
5591
            if revision is None:
 
5592
                raise errors.BzrCommandError('You must supply either a'
 
5593
                                             ' revision or a location')
 
5594
            to_location = '.'
5481
5595
        try:
5482
5596
            branch = control_dir.open_branch()
5483
5597
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5488
5602
            if branch is None:
5489
5603
                raise errors.BzrCommandError('cannot create branch without'
5490
5604
                                             ' source branch')
 
5605
            to_location = directory_service.directories.dereference(
 
5606
                              to_location)
5491
5607
            if '/' not in to_location and '\\' not in to_location:
5492
5608
                # This path is meant to be relative to the existing branch
5493
5609
                this_url = self._get_branch_location(control_dir)
5495
5611
            to_branch = branch.bzrdir.sprout(to_location,
5496
5612
                                 possible_transports=[branch.bzrdir.root_transport],
5497
5613
                                 source_branch=branch).open_branch()
5498
 
            # try:
5499
 
            #     from_branch = control_dir.open_branch()
5500
 
            # except errors.NotBranchError:
5501
 
            #     raise BzrCommandError('Cannot create a branch from this'
5502
 
            #         ' location when we cannot open this branch')
5503
 
            # from_branch.bzrdir.sprout(
5504
 
            pass
5505
5614
        else:
5506
5615
            try:
5507
5616
                to_branch = Branch.open(to_location)
5509
5618
                this_url = self._get_branch_location(control_dir)
5510
5619
                to_branch = Branch.open(
5511
5620
                    urlutils.join(this_url, '..', to_location))
5512
 
        switch.switch(control_dir, to_branch, force)
 
5621
        if revision is not None:
 
5622
            revision = revision.as_revision_id(to_branch)
 
5623
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5513
5624
        if had_explicit_nick:
5514
5625
            branch = control_dir.open_branch() #get the new branch!
5515
5626
            branch.nick = to_branch.nick
5535
5646
 
5536
5647
 
5537
5648
class cmd_view(Command):
5538
 
    """Manage filtered views.
 
5649
    __doc__ = """Manage filtered views.
5539
5650
 
5540
5651
    Views provide a mask over the tree so that users can focus on
5541
5652
    a subset of a tree when doing their work. After creating a view,
5689
5800
 
5690
5801
 
5691
5802
class cmd_hooks(Command):
5692
 
    """Show hooks."""
 
5803
    __doc__ = """Show hooks."""
5693
5804
 
5694
5805
    hidden = True
5695
5806
 
5708
5819
                    self.outf.write("    <no hooks installed>\n")
5709
5820
 
5710
5821
 
 
5822
class cmd_remove_branch(Command):
 
5823
    __doc__ = """Remove a branch.
 
5824
 
 
5825
    This will remove the branch from the specified location but 
 
5826
    will keep any working tree or repository in place.
 
5827
 
 
5828
    :Examples:
 
5829
 
 
5830
      Remove the branch at repo/trunk::
 
5831
 
 
5832
        bzr remove-branch repo/trunk
 
5833
 
 
5834
    """
 
5835
 
 
5836
    takes_args = ["location?"]
 
5837
 
 
5838
    aliases = ["rmbranch"]
 
5839
 
 
5840
    def run(self, location=None):
 
5841
        if location is None:
 
5842
            location = "."
 
5843
        branch = Branch.open_containing(location)[0]
 
5844
        branch.bzrdir.destroy_branch()
 
5845
        
 
5846
 
5711
5847
class cmd_shelve(Command):
5712
 
    """Temporarily set aside some changes from the current tree.
 
5848
    __doc__ = """Temporarily set aside some changes from the current tree.
5713
5849
 
5714
5850
    Shelve allows you to temporarily put changes you've made "on the shelf",
5715
5851
    ie. out of the way, until a later time when you can bring them back from
5769
5905
    def run_for_list(self):
5770
5906
        tree = WorkingTree.open_containing('.')[0]
5771
5907
        tree.lock_read()
5772
 
        try:
5773
 
            manager = tree.get_shelf_manager()
5774
 
            shelves = manager.active_shelves()
5775
 
            if len(shelves) == 0:
5776
 
                note('No shelved changes.')
5777
 
                return 0
5778
 
            for shelf_id in reversed(shelves):
5779
 
                message = manager.get_metadata(shelf_id).get('message')
5780
 
                if message is None:
5781
 
                    message = '<no message>'
5782
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5783
 
            return 1
5784
 
        finally:
5785
 
            tree.unlock()
 
5908
        self.add_cleanup(tree.unlock)
 
5909
        manager = tree.get_shelf_manager()
 
5910
        shelves = manager.active_shelves()
 
5911
        if len(shelves) == 0:
 
5912
            note('No shelved changes.')
 
5913
            return 0
 
5914
        for shelf_id in reversed(shelves):
 
5915
            message = manager.get_metadata(shelf_id).get('message')
 
5916
            if message is None:
 
5917
                message = '<no message>'
 
5918
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5919
        return 1
5786
5920
 
5787
5921
 
5788
5922
class cmd_unshelve(Command):
5789
 
    """Restore shelved changes.
 
5923
    __doc__ = """Restore shelved changes.
5790
5924
 
5791
5925
    By default, the most recently shelved changes are restored. However if you
5792
5926
    specify a shelf by id those changes will be restored instead.  This works
5800
5934
            enum_switch=False, value_switches=True,
5801
5935
            apply="Apply changes and remove from the shelf.",
5802
5936
            dry_run="Show changes, but do not apply or remove them.",
 
5937
            preview="Instead of unshelving the changes, show the diff that "
 
5938
                    "would result from unshelving.",
5803
5939
            delete_only="Delete changes without applying them.",
5804
5940
            keep="Apply changes but don't delete them.",
5805
5941
        )
5816
5952
 
5817
5953
 
5818
5954
class cmd_clean_tree(Command):
5819
 
    """Remove unwanted files from working tree.
 
5955
    __doc__ = """Remove unwanted files from working tree.
5820
5956
 
5821
5957
    By default, only unknown files, not ignored files, are deleted.  Versioned
5822
5958
    files are never deleted.
5850
5986
 
5851
5987
 
5852
5988
class cmd_reference(Command):
5853
 
    """list, view and set branch locations for nested trees.
 
5989
    __doc__ = """list, view and set branch locations for nested trees.
5854
5990
 
5855
5991
    If no arguments are provided, lists the branch locations for nested trees.
5856
5992
    If one argument is provided, display the branch location for that tree.
5896
6032
            self.outf.write('%s %s\n' % (path, location))
5897
6033
 
5898
6034
 
5899
 
# these get imported and then picked up by the scan for cmd_*
5900
 
# TODO: Some more consistent way to split command definitions across files;
5901
 
# we do need to load at least some information about them to know of
5902
 
# aliases.  ideally we would avoid loading the implementation until the
5903
 
# details were needed.
5904
 
from bzrlib.cmd_version_info import cmd_version_info
5905
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5906
 
from bzrlib.bundle.commands import (
5907
 
    cmd_bundle_info,
5908
 
    )
5909
 
from bzrlib.foreign import cmd_dpush
5910
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5911
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5912
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6035
def _register_lazy_builtins():
 
6036
    # register lazy builtins from other modules; called at startup and should
 
6037
    # be only called once.
 
6038
    for (name, aliases, module_name) in [
 
6039
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6040
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6041
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6042
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6043
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6044
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6045
        ]:
 
6046
        builtin_command_registry.register_lazy(name, aliases, module_name)