/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,
43
44
    reconfigure,
44
45
    rename_map,
45
46
    revision as _mod_revision,
 
47
    static_tuple,
46
48
    symbol_versioning,
47
49
    timestamp,
48
50
    transport,
52
54
    )
53
55
from bzrlib.branch import Branch
54
56
from bzrlib.conflicts import ConflictList
 
57
from bzrlib.transport import memory
55
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
59
from bzrlib.smtp_connection import SMTPConnection
57
60
from bzrlib.workingtree import WorkingTree
58
61
""")
59
62
 
60
 
from bzrlib.commands import Command, display_command
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
61
68
from bzrlib.option import (
62
69
    ListOption,
63
70
    Option,
232
239
# opens the branch?)
233
240
 
234
241
class cmd_status(Command):
235
 
    """Display status summary.
 
242
    __doc__ = """Display status summary.
236
243
 
237
244
    This reports on versioned and unknown files, reporting them
238
245
    grouped by state.  Possible states are:
258
265
    unknown
259
266
        Not versioned and not matching an ignore pattern.
260
267
 
 
268
    Additionally for directories, symlinks and files with an executable
 
269
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
270
    or '*' respectively.
 
271
 
261
272
    To see ignored files use 'bzr ignored'.  For details on the
262
273
    changes to file texts, use 'bzr diff'.
263
274
 
321
332
 
322
333
 
323
334
class cmd_cat_revision(Command):
324
 
    """Write out metadata for a revision.
 
335
    __doc__ = """Write out metadata for a revision.
325
336
 
326
337
    The revision to print can either be specified by a specific
327
338
    revision identifier, or you can use --revision.
333
344
    # cat-revision is more for frontends so should be exact
334
345
    encoding = 'strict'
335
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
 
336
355
    @display_command
337
356
    def run(self, revision_id=None, revision=None):
338
357
        if revision_id is not None and revision is not None:
343
362
                                         ' --revision or a revision_id')
344
363
        b = WorkingTree.open_containing(u'.')[0].branch
345
364
 
346
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
347
 
        if revision_id is not None:
348
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
349
 
            try:
350
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
351
 
            except errors.NoSuchRevision:
352
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
353
 
                    revision_id)
354
 
                raise errors.BzrCommandError(msg)
355
 
        elif revision is not None:
356
 
            for rev in revision:
357
 
                if rev is None:
358
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
359
 
                                                 ' revision.')
360
 
                rev_id = rev.as_revision_id(b)
361
 
                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')
362
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
        
363
391
 
364
392
class cmd_dump_btree(Command):
365
 
    """Dump the contents of a btree index file to stdout.
 
393
    __doc__ = """Dump the contents of a btree index file to stdout.
366
394
 
367
395
    PATH is a btree index file, it can be any URL. This includes things like
368
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
432
460
        for node in bt.iter_all_entries():
433
461
            # Node is made up of:
434
462
            # (index, key, value, [references])
435
 
            refs_as_tuples = tuple([tuple([tuple(ref) for ref in ref_list])
436
 
                                   for ref_list in 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)
437
469
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
438
470
            self.outf.write('%s\n' % (as_tuple,))
439
471
 
440
472
 
441
473
class cmd_remove_tree(Command):
442
 
    """Remove the working tree from a given branch/checkout.
 
474
    __doc__ = """Remove the working tree from a given branch/checkout.
443
475
 
444
476
    Since a lightweight checkout is little more than a working tree
445
477
    this will refuse to run against one.
447
479
    To re-create the working tree, use "bzr checkout".
448
480
    """
449
481
    _see_also = ['checkout', 'working-trees']
450
 
    takes_args = ['location?']
 
482
    takes_args = ['location*']
451
483
    takes_options = [
452
484
        Option('force',
453
485
               help='Remove the working tree even if it has '
454
486
                    'uncommitted changes.'),
455
487
        ]
456
488
 
457
 
    def run(self, location='.', force=False):
458
 
        d = bzrdir.BzrDir.open(location)
459
 
 
460
 
        try:
461
 
            working = d.open_workingtree()
462
 
        except errors.NoWorkingTree:
463
 
            raise errors.BzrCommandError("No working tree to remove")
464
 
        except errors.NotLocalUrl:
465
 
            raise errors.BzrCommandError("You cannot remove the working tree"
466
 
                                         " of a remote path")
467
 
        if not force:
468
 
            if (working.has_changes()):
469
 
                raise errors.UncommittedChanges(working)
470
 
 
471
 
        working_path = working.bzrdir.root_transport.base
472
 
        branch_path = working.branch.bzrdir.root_transport.base
473
 
        if working_path != branch_path:
474
 
            raise errors.BzrCommandError("You cannot remove the working tree"
475
 
                                         " from a lightweight checkout")
476
 
 
477
 
        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()
478
512
 
479
513
 
480
514
class cmd_revno(Command):
481
 
    """Show current revision number.
 
515
    __doc__ = """Show current revision number.
482
516
 
483
517
    This is equal to the number of revisions on this branch.
484
518
    """
497
531
                wt.lock_read()
498
532
            except (errors.NoWorkingTree, errors.NotLocalUrl):
499
533
                raise errors.NoWorkingTree(location)
 
534
            self.add_cleanup(wt.unlock)
 
535
            revid = wt.last_revision()
500
536
            try:
501
 
                revid = wt.last_revision()
502
 
                try:
503
 
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
504
 
                except errors.NoSuchRevision:
505
 
                    revno_t = ('???',)
506
 
                revno = ".".join(str(n) for n in revno_t)
507
 
            finally:
508
 
                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)
509
541
        else:
510
542
            b = Branch.open_containing(location)[0]
511
543
            b.lock_read()
512
 
            try:
513
 
                revno = b.revno()
514
 
            finally:
515
 
                b.unlock()
516
 
 
 
544
            self.add_cleanup(b.unlock)
 
545
            revno = b.revno()
 
546
        self.cleanup_now()
517
547
        self.outf.write(str(revno) + '\n')
518
548
 
519
549
 
520
550
class cmd_revision_info(Command):
521
 
    """Show revision number and revision id for a given revision identifier.
 
551
    __doc__ = """Show revision number and revision id for a given revision identifier.
522
552
    """
523
553
    hidden = True
524
554
    takes_args = ['revision_info*']
541
571
            wt = WorkingTree.open_containing(directory)[0]
542
572
            b = wt.branch
543
573
            wt.lock_read()
 
574
            self.add_cleanup(wt.unlock)
544
575
        except (errors.NoWorkingTree, errors.NotLocalUrl):
545
576
            wt = None
546
577
            b = Branch.open_containing(directory)[0]
547
578
            b.lock_read()
548
 
        try:
549
 
            revision_ids = []
550
 
            if revision is not None:
551
 
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
552
 
            if revision_info_list is not None:
553
 
                for rev_str in revision_info_list:
554
 
                    rev_spec = RevisionSpec.from_string(rev_str)
555
 
                    revision_ids.append(rev_spec.as_revision_id(b))
556
 
            # No arguments supplied, default to the last revision
557
 
            if len(revision_ids) == 0:
558
 
                if tree:
559
 
                    if wt is None:
560
 
                        raise errors.NoWorkingTree(directory)
561
 
                    revision_ids.append(wt.last_revision())
562
 
                else:
563
 
                    revision_ids.append(b.last_revision())
564
 
 
565
 
            revinfos = []
566
 
            maxlen = 0
567
 
            for revision_id in revision_ids:
568
 
                try:
569
 
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
570
 
                    revno = '.'.join(str(i) for i in dotted_revno)
571
 
                except errors.NoSuchRevision:
572
 
                    revno = '???'
573
 
                maxlen = max(maxlen, len(revno))
574
 
                revinfos.append([revno, revision_id])
575
 
        finally:
576
 
            if wt is None:
577
 
                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())
578
593
            else:
579
 
                wt.unlock()
580
 
 
 
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()
581
608
        for ri in revinfos:
582
609
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
583
610
 
584
611
 
585
612
class cmd_add(Command):
586
 
    """Add specified files or directories.
 
613
    __doc__ = """Add specified files or directories.
587
614
 
588
615
    In non-recursive mode, all the named items are added, regardless
589
616
    of whether they were previously ignored.  A warning is given if
655
682
 
656
683
        if base_tree:
657
684
            base_tree.lock_read()
658
 
        try:
659
 
            tree, file_list = tree_files_for_add(file_list)
660
 
            added, ignored = tree.smart_add(file_list, not
661
 
                no_recurse, action=action, save=not dry_run)
662
 
        finally:
663
 
            if base_tree is not None:
664
 
                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()
665
690
        if len(ignored) > 0:
666
691
            if verbose:
667
692
                for glob in sorted(ignored.keys()):
671
696
 
672
697
 
673
698
class cmd_mkdir(Command):
674
 
    """Create a new versioned directory.
 
699
    __doc__ = """Create a new versioned directory.
675
700
 
676
701
    This is equivalent to creating the directory and then adding it.
677
702
    """
681
706
 
682
707
    def run(self, dir_list):
683
708
        for d in dir_list:
684
 
            os.mkdir(d)
685
709
            wt, dd = WorkingTree.open_containing(d)
686
 
            wt.add([dd])
687
 
            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)
688
718
 
689
719
 
690
720
class cmd_relpath(Command):
691
 
    """Show path of a file relative to root"""
 
721
    __doc__ = """Show path of a file relative to root"""
692
722
 
693
723
    takes_args = ['filename']
694
724
    hidden = True
703
733
 
704
734
 
705
735
class cmd_inventory(Command):
706
 
    """Show inventory of the current working copy or a revision.
 
736
    __doc__ = """Show inventory of the current working copy or a revision.
707
737
 
708
738
    It is possible to limit the output to a particular entry
709
739
    type using the --kind option.  For example: --kind file.
731
761
        revision = _get_one_revision('inventory', revision)
732
762
        work_tree, file_list = tree_files(file_list)
733
763
        work_tree.lock_read()
734
 
        try:
735
 
            if revision is not None:
736
 
                tree = revision.as_tree(work_tree.branch)
737
 
 
738
 
                extra_trees = [work_tree]
739
 
                tree.lock_read()
740
 
            else:
741
 
                tree = work_tree
742
 
                extra_trees = []
743
 
 
744
 
            if file_list is not None:
745
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
746
 
                                          require_versioned=True)
747
 
                # find_ids_across_trees may include some paths that don't
748
 
                # exist in 'tree'.
749
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
750
 
                                 for file_id in file_ids if file_id in tree)
751
 
            else:
752
 
                entries = tree.inventory.entries()
753
 
        finally:
754
 
            tree.unlock()
755
 
            if tree is not work_tree:
756
 
                work_tree.unlock()
757
 
 
 
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()
758
786
        for path, entry in entries:
759
787
            if kind and kind != entry.kind:
760
788
                continue
766
794
 
767
795
 
768
796
class cmd_mv(Command):
769
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
770
798
 
771
799
    :Usage:
772
800
        bzr mv OLDNAME NEWNAME
806
834
            raise errors.BzrCommandError("missing file argument")
807
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
808
836
        tree.lock_tree_write()
809
 
        try:
810
 
            self._run(tree, names_list, rel_names, after)
811
 
        finally:
812
 
            tree.unlock()
 
837
        self.add_cleanup(tree.unlock)
 
838
        self._run(tree, names_list, rel_names, after)
813
839
 
814
840
    def run_auto(self, names_list, after, dry_run):
815
841
        if names_list is not None and len(names_list) > 1:
820
846
                                         ' --auto.')
821
847
        work_tree, file_list = tree_files(names_list, default_branch='.')
822
848
        work_tree.lock_tree_write()
823
 
        try:
824
 
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
825
 
        finally:
826
 
            work_tree.unlock()
 
849
        self.add_cleanup(work_tree.unlock)
 
850
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
827
851
 
828
852
    def _run(self, tree, names_list, rel_names, after):
829
853
        into_existing = osutils.isdir(names_list[-1])
907
931
 
908
932
 
909
933
class cmd_pull(Command):
910
 
    """Turn this branch into a mirror of another branch.
 
934
    __doc__ = """Turn this branch into a mirror of another branch.
911
935
 
912
 
    This command only works on branches that have not diverged.  Branches are
913
 
    considered diverged if the destination branch's most recent commit is one
914
 
    that has not been merged (directly or indirectly) into the parent.
 
936
    By default, this command only works on branches that have not diverged.
 
937
    Branches are considered diverged if the destination branch's most recent 
 
938
    commit is one that has not been merged (directly or indirectly) into the 
 
939
    parent.
915
940
 
916
941
    If branches have diverged, you can use 'bzr merge' to integrate the changes
917
942
    from one into the other.  Once one branch has merged, the other should
918
943
    be able to pull it again.
919
944
 
920
 
    If you want to forget your local changes and just update your branch to
921
 
    match the remote one, use pull --overwrite.
 
945
    If you want to replace your local changes and just want your branch to
 
946
    match the remote one, use pull --overwrite. This will work even if the two
 
947
    branches have diverged.
922
948
 
923
949
    If there is no default location set, the first pull will set it.  After
924
950
    that, you can omit the location to use the default.  To change the
960
986
        try:
961
987
            tree_to = WorkingTree.open_containing(directory)[0]
962
988
            branch_to = tree_to.branch
 
989
            tree_to.lock_write()
 
990
            self.add_cleanup(tree_to.unlock)
963
991
        except errors.NoWorkingTree:
964
992
            tree_to = None
965
993
            branch_to = Branch.open_containing(directory)[0]
966
 
        
 
994
            branch_to.lock_write()
 
995
            self.add_cleanup(branch_to.unlock)
 
996
 
967
997
        if local and not branch_to.get_bound_location():
968
998
            raise errors.LocalRequiresBoundBranch()
969
999
 
999
1029
        else:
1000
1030
            branch_from = Branch.open(location,
1001
1031
                possible_transports=possible_transports)
 
1032
            branch_from.lock_read()
 
1033
            self.add_cleanup(branch_from.unlock)
1002
1034
 
1003
1035
            if branch_to.get_parent() is None or remember:
1004
1036
                branch_to.set_parent(branch_from.base)
1005
1037
 
1006
 
        if branch_from is not branch_to:
1007
 
            branch_from.lock_read()
1008
 
        try:
1009
 
            if revision is not None:
1010
 
                revision_id = revision.as_revision_id(branch_from)
1011
 
 
1012
 
            branch_to.lock_write()
1013
 
            try:
1014
 
                if tree_to is not None:
1015
 
                    view_info = _get_view_info_for_change_reporter(tree_to)
1016
 
                    change_reporter = delta._ChangeReporter(
1017
 
                        unversioned_filter=tree_to.is_ignored,
1018
 
                        view_info=view_info)
1019
 
                    result = tree_to.pull(
1020
 
                        branch_from, overwrite, revision_id, change_reporter,
1021
 
                        possible_transports=possible_transports, local=local)
1022
 
                else:
1023
 
                    result = branch_to.pull(
1024
 
                        branch_from, overwrite, revision_id, local=local)
1025
 
 
1026
 
                result.report(self.outf)
1027
 
                if verbose and result.old_revid != result.new_revid:
1028
 
                    log.show_branch_change(
1029
 
                        branch_to, self.outf, result.old_revno,
1030
 
                        result.old_revid)
1031
 
            finally:
1032
 
                branch_to.unlock()
1033
 
        finally:
1034
 
            if branch_from is not branch_to:
1035
 
                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)
1036
1058
 
1037
1059
 
1038
1060
class cmd_push(Command):
1039
 
    """Update a mirror of this branch.
 
1061
    __doc__ = """Update a mirror of this branch.
1040
1062
 
1041
1063
    The target branch will not have its working tree populated because this
1042
1064
    is both expensive, and is not supported on remote file systems.
1103
1125
        # Get the source branch
1104
1126
        (tree, br_from,
1105
1127
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1106
 
        if strict is None:
1107
 
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
1108
 
        if strict is None: strict = True # default value
1109
1128
        # Get the tip's revision_id
1110
1129
        revision = _get_one_revision('push', revision)
1111
1130
        if revision is not None:
1112
1131
            revision_id = revision.in_history(br_from).rev_id
1113
1132
        else:
1114
1133
            revision_id = None
1115
 
        if strict and tree is not None and revision_id is None:
1116
 
            if (tree.has_changes()):
1117
 
                raise errors.UncommittedChanges(
1118
 
                    tree, more='Use --no-strict to force the push.')
1119
 
            if tree.last_revision() != tree.branch.last_revision():
1120
 
                # The tree has lost sync with its branch, there is little
1121
 
                # chance that the user is aware of it but he can still force
1122
 
                # the push with --no-strict
1123
 
                raise errors.OutOfDateTree(
1124
 
                    tree, more='Use --no-strict to force the push.')
1125
 
 
 
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.')
1126
1139
        # Get the stacked_on branch, if any
1127
1140
        if stacked_on is not None:
1128
1141
            stacked_on = urlutils.normalize_url(stacked_on)
1160
1173
 
1161
1174
 
1162
1175
class cmd_branch(Command):
1163
 
    """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.
1164
1177
 
1165
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1193
1206
                    ' directory exists, but does not already'
1194
1207
                    ' have a control directory.  This flag will'
1195
1208
                    ' allow branch to proceed.'),
 
1209
        Option('bind',
 
1210
            help="Bind new branch to from location."),
1196
1211
        ]
1197
1212
    aliases = ['get', 'clone']
1198
1213
 
1199
1214
    def run(self, from_location, to_location=None, revision=None,
1200
1215
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1201
 
            use_existing_dir=False, switch=False):
 
1216
            use_existing_dir=False, switch=False, bind=False):
1202
1217
        from bzrlib import switch as _mod_switch
1203
1218
        from bzrlib.tag import _merge_tags_if_possible
1204
1219
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1205
1220
            from_location)
1206
 
        if (accelerator_tree is not None and
1207
 
            accelerator_tree.supports_content_filtering()):
1208
 
            accelerator_tree = None
1209
1221
        revision = _get_one_revision('branch', revision)
1210
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)
1211
1234
        try:
1212
 
            if revision is not None:
1213
 
                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)
1214
1240
            else:
1215
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1216
 
                # None or perhaps NULL_REVISION to mean copy nothing
1217
 
                # RBC 20060209
1218
 
                revision_id = br_from.last_revision()
1219
 
            if to_location is None:
1220
 
                to_location = urlutils.derive_to_location(from_location)
1221
 
            to_transport = transport.get_transport(to_location)
1222
 
            try:
1223
 
                to_transport.mkdir('.')
1224
 
            except errors.FileExists:
1225
 
                if not use_existing_dir:
1226
 
                    raise errors.BzrCommandError('Target directory "%s" '
1227
 
                        'already exists.' % to_location)
 
1241
                try:
 
1242
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1243
                except errors.NotBranchError:
 
1244
                    pass
1228
1245
                else:
1229
 
                    try:
1230
 
                        bzrdir.BzrDir.open_from_transport(to_transport)
1231
 
                    except errors.NotBranchError:
1232
 
                        pass
1233
 
                    else:
1234
 
                        raise errors.AlreadyBranchError(to_location)
1235
 
            except errors.NoSuchFile:
1236
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1237
 
                                             % to_location)
1238
 
            try:
1239
 
                # preserve whatever source format we have.
1240
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1241
 
                                            possible_transports=[to_transport],
1242
 
                                            accelerator_tree=accelerator_tree,
1243
 
                                            hardlink=hardlink, stacked=stacked,
1244
 
                                            force_new_repo=standalone,
1245
 
                                            create_tree_if_local=not no_tree,
1246
 
                                            source_branch=br_from)
1247
 
                branch = dir.open_branch()
1248
 
            except errors.NoSuchRevision:
1249
 
                to_transport.delete_tree('.')
1250
 
                msg = "The branch %s has no revision %s." % (from_location,
1251
 
                    revision)
1252
 
                raise errors.BzrCommandError(msg)
1253
 
            _merge_tags_if_possible(br_from, branch)
1254
 
            # If the source branch is stacked, the new branch may
1255
 
            # be stacked whether we asked for that explicitly or not.
1256
 
            # We therefore need a try/except here and not just 'if stacked:'
1257
 
            try:
1258
 
                note('Created new stacked branch referring to %s.' %
1259
 
                    branch.get_stacked_on_url())
1260
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1261
 
                errors.UnstackableRepositoryFormat), e:
1262
 
                note('Branched %d revision(s).' % branch.revno())
1263
 
            if switch:
1264
 
                # Switch to the new branch
1265
 
                wt, _ = WorkingTree.open_containing('.')
1266
 
                _mod_switch.switch(wt.bzrdir, branch)
1267
 
                note('Switched to branch: %s',
1268
 
                    urlutils.unescape_for_display(branch.base, 'utf-8'))
1269
 
        finally:
1270
 
            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'))
1271
1286
 
1272
1287
 
1273
1288
class cmd_checkout(Command):
1274
 
    """Create a new checkout of an existing branch.
 
1289
    __doc__ = """Create a new checkout of an existing branch.
1275
1290
 
1276
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1277
1292
    the branch found in '.'. This is useful if you have removed the working tree
1340
1355
 
1341
1356
 
1342
1357
class cmd_renames(Command):
1343
 
    """Show list of renamed files.
 
1358
    __doc__ = """Show list of renamed files.
1344
1359
    """
1345
1360
    # TODO: Option to show renames between two historical versions.
1346
1361
 
1352
1367
    def run(self, dir=u'.'):
1353
1368
        tree = WorkingTree.open_containing(dir)[0]
1354
1369
        tree.lock_read()
1355
 
        try:
1356
 
            new_inv = tree.inventory
1357
 
            old_tree = tree.basis_tree()
1358
 
            old_tree.lock_read()
1359
 
            try:
1360
 
                old_inv = old_tree.inventory
1361
 
                renames = []
1362
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1363
 
                for f, paths, c, v, p, n, k, e in iterator:
1364
 
                    if paths[0] == paths[1]:
1365
 
                        continue
1366
 
                    if None in (paths):
1367
 
                        continue
1368
 
                    renames.append(paths)
1369
 
                renames.sort()
1370
 
                for old_name, new_name in renames:
1371
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1372
 
            finally:
1373
 
                old_tree.unlock()
1374
 
        finally:
1375
 
            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))
1376
1387
 
1377
1388
 
1378
1389
class cmd_update(Command):
1379
 
    """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.
1380
1391
 
1381
1392
    This will perform a merge into the working tree, and may generate
1382
1393
    conflicts. If you have any local changes, you will still
1384
1395
 
1385
1396
    If you want to discard your local changes, you can just do a
1386
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.
1387
1401
    """
1388
1402
 
1389
1403
    _see_also = ['pull', 'working-trees', 'status-flags']
1390
1404
    takes_args = ['dir?']
 
1405
    takes_options = ['revision']
1391
1406
    aliases = ['up']
1392
1407
 
1393
 
    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")
1394
1412
        tree = WorkingTree.open_containing(dir)[0]
 
1413
        branch = tree.branch
1395
1414
        possible_transports = []
1396
 
        master = tree.branch.get_master_branch(
 
1415
        master = branch.get_master_branch(
1397
1416
            possible_transports=possible_transports)
1398
1417
        if master is not None:
1399
1418
            tree.lock_write()
 
1419
            branch_location = master.base
1400
1420
        else:
1401
1421
            tree.lock_tree_write()
 
1422
            branch_location = tree.branch.base
 
1423
        self.add_cleanup(tree.unlock)
 
1424
        # get rid of the final '/' and be ready for display
 
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)
1402
1449
        try:
1403
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1404
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1405
 
            if last_rev == _mod_revision.ensure_null(
1406
 
                tree.branch.last_revision()):
1407
 
                # may be up to date, check master too.
1408
 
                if master is None or last_rev == _mod_revision.ensure_null(
1409
 
                    master.last_revision()):
1410
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1411
 
                    note("Tree is up to date at revision %d." % (revno,))
1412
 
                    return 0
1413
 
            view_info = _get_view_info_for_change_reporter(tree)
1414
1450
            conflicts = tree.update(
1415
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1416
 
                view_info=view_info), possible_transports=possible_transports)
1417
 
            revno = tree.branch.revision_id_to_revno(
1418
 
                _mod_revision.ensure_null(tree.last_revision()))
1419
 
            note('Updated to revision %d.' % (revno,))
1420
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1421
 
                note('Your local commits will now show as pending merges with '
1422
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1423
 
            if conflicts != 0:
1424
 
                return 1
1425
 
            else:
1426
 
                return 0
1427
 
        finally:
1428
 
            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
1429
1473
 
1430
1474
 
1431
1475
class cmd_info(Command):
1432
 
    """Show information about a working tree, branch or repository.
 
1476
    __doc__ = """Show information about a working tree, branch or repository.
1433
1477
 
1434
1478
    This command will show all known locations and formats associated to the
1435
1479
    tree, branch or repository.
1473
1517
 
1474
1518
 
1475
1519
class cmd_remove(Command):
1476
 
    """Remove files or directories.
 
1520
    __doc__ = """Remove files or directories.
1477
1521
 
1478
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1479
1523
    them if they can easily be recovered using revert. If no options or
1502
1546
            file_list = [f for f in file_list]
1503
1547
 
1504
1548
        tree.lock_write()
1505
 
        try:
1506
 
            # Heuristics should probably all move into tree.remove_smart or
1507
 
            # some such?
1508
 
            if new:
1509
 
                added = tree.changes_from(tree.basis_tree(),
1510
 
                    specific_files=file_list).added
1511
 
                file_list = sorted([f[0] for f in added], reverse=True)
1512
 
                if len(file_list) == 0:
1513
 
                    raise errors.BzrCommandError('No matching files.')
1514
 
            elif file_list is None:
1515
 
                # missing files show up in iter_changes(basis) as
1516
 
                # versioned-with-no-kind.
1517
 
                missing = []
1518
 
                for change in tree.iter_changes(tree.basis_tree()):
1519
 
                    # Find paths in the working tree that have no kind:
1520
 
                    if change[1][1] is not None and change[6][1] is None:
1521
 
                        missing.append(change[1][1])
1522
 
                file_list = sorted(missing, reverse=True)
1523
 
                file_deletion_strategy = 'keep'
1524
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1525
 
                keep_files=file_deletion_strategy=='keep',
1526
 
                force=file_deletion_strategy=='force')
1527
 
        finally:
1528
 
            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')
1529
1571
 
1530
1572
 
1531
1573
class cmd_file_id(Command):
1532
 
    """Print file_id of a particular file or directory.
 
1574
    __doc__ = """Print file_id of a particular file or directory.
1533
1575
 
1534
1576
    The file_id is assigned when the file is first added and remains the
1535
1577
    same through all revisions where the file exists, even when it is
1551
1593
 
1552
1594
 
1553
1595
class cmd_file_path(Command):
1554
 
    """Print path of file_ids to a file or directory.
 
1596
    __doc__ = """Print path of file_ids to a file or directory.
1555
1597
 
1556
1598
    This prints one line for each directory down to the target,
1557
1599
    starting at the branch root.
1573
1615
 
1574
1616
 
1575
1617
class cmd_reconcile(Command):
1576
 
    """Reconcile bzr metadata in a branch.
 
1618
    __doc__ = """Reconcile bzr metadata in a branch.
1577
1619
 
1578
1620
    This can correct data mismatches that may have been caused by
1579
1621
    previous ghost operations or bzr upgrades. You should only
1601
1643
 
1602
1644
 
1603
1645
class cmd_revision_history(Command):
1604
 
    """Display the list of revision ids on a branch."""
 
1646
    __doc__ = """Display the list of revision ids on a branch."""
1605
1647
 
1606
1648
    _see_also = ['log']
1607
1649
    takes_args = ['location?']
1617
1659
 
1618
1660
 
1619
1661
class cmd_ancestry(Command):
1620
 
    """List all revisions merged into this branch."""
 
1662
    __doc__ = """List all revisions merged into this branch."""
1621
1663
 
1622
1664
    _see_also = ['log', 'revision-history']
1623
1665
    takes_args = ['location?']
1642
1684
 
1643
1685
 
1644
1686
class cmd_init(Command):
1645
 
    """Make a directory into a versioned branch.
 
1687
    __doc__ = """Make a directory into a versioned branch.
1646
1688
 
1647
1689
    Use this to create an empty branch, or before importing an
1648
1690
    existing project.
1751
1793
 
1752
1794
 
1753
1795
class cmd_init_repository(Command):
1754
 
    """Create a shared repository to hold branches.
 
1796
    __doc__ = """Create a shared repository for branches to share storage space.
1755
1797
 
1756
1798
    New branches created under the repository directory will store their
1757
 
    revisions in the repository, not in the branch directory.
 
1799
    revisions in the repository, not in the branch directory.  For branches
 
1800
    with shared history, this reduces the amount of storage needed and 
 
1801
    speeds up the creation of new branches.
1758
1802
 
1759
 
    If the --no-trees option is used then the branches in the repository
1760
 
    will not have working trees by default.
 
1803
    If the --no-trees option is given then the branches in the repository
 
1804
    will not have working trees by default.  They will still exist as 
 
1805
    directories on disk, but they will not have separate copies of the 
 
1806
    files at a certain revision.  This can be useful for repositories that
 
1807
    store branches which are interacted with through checkouts or remote
 
1808
    branches, such as on a server.
1761
1809
 
1762
1810
    :Examples:
1763
 
        Create a shared repositories holding just branches::
 
1811
        Create a shared repository holding just branches::
1764
1812
 
1765
1813
            bzr init-repo --no-trees repo
1766
1814
            bzr init repo/trunk
1805
1853
 
1806
1854
 
1807
1855
class cmd_diff(Command):
1808
 
    """Show differences in the working tree, between revisions or branches.
 
1856
    __doc__ = """Show differences in the working tree, between revisions or branches.
1809
1857
 
1810
1858
    If no arguments are given, all changes for the current tree are listed.
1811
1859
    If files are given, only the changes in those files are listed.
1897
1945
            help='Use this command to compare files.',
1898
1946
            type=unicode,
1899
1947
            ),
 
1948
        RegistryOption('format',
 
1949
            help='Diff format to use.',
 
1950
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1951
            value_switches=False, title='Diff format'),
1900
1952
        ]
1901
1953
    aliases = ['di', 'dif']
1902
1954
    encoding_type = 'exact'
1903
1955
 
1904
1956
    @display_command
1905
1957
    def run(self, revision=None, file_list=None, diff_options=None,
1906
 
            prefix=None, old=None, new=None, using=None):
1907
 
        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)
1908
1961
 
1909
1962
        if (prefix is None) or (prefix == '0'):
1910
1963
            # diff -p0 format
1924
1977
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1925
1978
                                         ' one or two revision specifiers')
1926
1979
 
 
1980
        if using is not None and format is not None:
 
1981
            raise errors.BzrCommandError('--using and --format are mutually '
 
1982
                'exclusive.')
 
1983
 
1927
1984
        (old_tree, new_tree,
1928
1985
         old_branch, new_branch,
1929
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
1930
 
            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)
1931
1988
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1932
1989
                               specific_files=specific_files,
1933
1990
                               external_diff_options=diff_options,
1934
1991
                               old_label=old_label, new_label=new_label,
1935
 
                               extra_trees=extra_trees, using=using)
 
1992
                               extra_trees=extra_trees, using=using,
 
1993
                               format_cls=format)
1936
1994
 
1937
1995
 
1938
1996
class cmd_deleted(Command):
1939
 
    """List files deleted in the working tree.
 
1997
    __doc__ = """List files deleted in the working tree.
1940
1998
    """
1941
1999
    # TODO: Show files deleted since a previous revision, or
1942
2000
    # between two revisions.
1951
2009
    def run(self, show_ids=False):
1952
2010
        tree = WorkingTree.open_containing(u'.')[0]
1953
2011
        tree.lock_read()
1954
 
        try:
1955
 
            old = tree.basis_tree()
1956
 
            old.lock_read()
1957
 
            try:
1958
 
                for path, ie in old.inventory.iter_entries():
1959
 
                    if not tree.has_id(ie.file_id):
1960
 
                        self.outf.write(path)
1961
 
                        if show_ids:
1962
 
                            self.outf.write(' ')
1963
 
                            self.outf.write(ie.file_id)
1964
 
                        self.outf.write('\n')
1965
 
            finally:
1966
 
                old.unlock()
1967
 
        finally:
1968
 
            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')
1969
2023
 
1970
2024
 
1971
2025
class cmd_modified(Command):
1972
 
    """List files modified in working tree.
 
2026
    __doc__ = """List files modified in working tree.
1973
2027
    """
1974
2028
 
1975
2029
    hidden = True
1992
2046
 
1993
2047
 
1994
2048
class cmd_added(Command):
1995
 
    """List files added in working tree.
 
2049
    __doc__ = """List files added in working tree.
1996
2050
    """
1997
2051
 
1998
2052
    hidden = True
2007
2061
    def run(self, null=False):
2008
2062
        wt = WorkingTree.open_containing(u'.')[0]
2009
2063
        wt.lock_read()
2010
 
        try:
2011
 
            basis = wt.basis_tree()
2012
 
            basis.lock_read()
2013
 
            try:
2014
 
                basis_inv = basis.inventory
2015
 
                inv = wt.inventory
2016
 
                for file_id in inv:
2017
 
                    if file_id in basis_inv:
2018
 
                        continue
2019
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
2020
 
                        continue
2021
 
                    path = inv.id2path(file_id)
2022
 
                    if not os.access(osutils.abspath(path), os.F_OK):
2023
 
                        continue
2024
 
                    if null:
2025
 
                        self.outf.write(path + '\0')
2026
 
                    else:
2027
 
                        self.outf.write(osutils.quotefn(path) + '\n')
2028
 
            finally:
2029
 
                basis.unlock()
2030
 
        finally:
2031
 
            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')
2032
2082
 
2033
2083
 
2034
2084
class cmd_root(Command):
2035
 
    """Show the tree root directory.
 
2085
    __doc__ = """Show the tree root directory.
2036
2086
 
2037
2087
    The root is the nearest enclosing directory with a .bzr control
2038
2088
    directory."""
2062
2112
 
2063
2113
 
2064
2114
class cmd_log(Command):
2065
 
    """Show historical log for a branch or subset of a branch.
 
2115
    __doc__ = """Show historical log for a branch or subset of a branch.
2066
2116
 
2067
2117
    log is bzr's default tool for exploring the history of a branch.
2068
2118
    The branch to use is taken from the first parameter. If no parameters
2179
2229
    :Tips & tricks:
2180
2230
 
2181
2231
      GUI tools and IDEs are often better at exploring history than command
2182
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2183
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2184
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2185
 
 
2186
 
      Web interfaces are often better at exploring history than command line
2187
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2188
 
      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>.  
2189
2236
 
2190
2237
      You may find it useful to add the aliases below to ``bazaar.conf``::
2191
2238
 
2252
2299
                   help='Show changes made in each revision as a patch.'),
2253
2300
            Option('include-merges',
2254
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
                   )
2255
2306
            ]
2256
2307
    encoding_type = 'replace'
2257
2308
 
2267
2318
            message=None,
2268
2319
            limit=None,
2269
2320
            show_diff=False,
2270
 
            include_merges=False):
 
2321
            include_merges=False,
 
2322
            exclude_common_ancestry=False,
 
2323
            ):
2271
2324
        from bzrlib.log import (
2272
2325
            Logger,
2273
2326
            make_log_request_dict,
2274
2327
            _get_info_for_log_files,
2275
2328
            )
2276
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')
2277
2334
        if include_merges:
2278
2335
            if levels is None:
2279
2336
                levels = 0
2292
2349
 
2293
2350
        file_ids = []
2294
2351
        filter_by_dir = False
2295
 
        b = None
2296
 
        try:
2297
 
            if file_list:
2298
 
                # find the file ids to log and check for directory filtering
2299
 
                b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2300
 
                    revision, file_list)
2301
 
                for relpath, file_id, kind in file_info_list:
2302
 
                    if file_id is None:
2303
 
                        raise errors.BzrCommandError(
2304
 
                            "Path unknown at end or start of revision range: %s" %
2305
 
                            relpath)
2306
 
                    # If the relpath is the top of the tree, we log everything
2307
 
                    if relpath == '':
2308
 
                        file_ids = []
2309
 
                        break
2310
 
                    else:
2311
 
                        file_ids.append(file_id)
2312
 
                    filter_by_dir = filter_by_dir or (
2313
 
                        kind in ['directory', 'tree-reference'])
2314
 
            else:
2315
 
                # log everything
2316
 
                # FIXME ? log the current subdir only RBC 20060203
2317
 
                if revision is not None \
2318
 
                        and len(revision) > 0 and revision[0].get_branch():
2319
 
                    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
2320
2366
                else:
2321
 
                    location = '.'
2322
 
                dir, relpath = bzrdir.BzrDir.open_containing(location)
2323
 
                b = dir.open_branch()
2324
 
                b.lock_read()
2325
 
                rev1, rev2 = _get_revision_range(revision, b, self.name())
2326
 
 
2327
 
            # Decide on the type of delta & diff filtering to use
2328
 
            # TODO: add an --all-files option to make this configurable & consistent
2329
 
            if not verbose:
2330
 
                delta_type = None
2331
 
            else:
2332
 
                delta_type = 'full'
2333
 
            if not show_diff:
2334
 
                diff_type = None
2335
 
            elif file_ids:
2336
 
                diff_type = 'partial'
2337
 
            else:
2338
 
                diff_type = 'full'
2339
 
 
2340
 
            # Build the log formatter
2341
 
            if log_format is None:
2342
 
                log_format = log.log_formatter_registry.get_default(b)
2343
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2344
 
                            show_timezone=timezone,
2345
 
                            delta_format=get_verbosity_level(),
2346
 
                            levels=levels,
2347
 
                            show_advice=levels is None)
2348
 
 
2349
 
            # Choose the algorithm for doing the logging. It's annoying
2350
 
            # having multiple code paths like this but necessary until
2351
 
            # the underlying repository format is faster at generating
2352
 
            # deltas or can provide everything we need from the indices.
2353
 
            # The default algorithm - match-using-deltas - works for
2354
 
            # multiple files and directories and is faster for small
2355
 
            # amounts of history (200 revisions say). However, it's too
2356
 
            # slow for logging a single file in a repository with deep
2357
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2358
 
            # evil when adding features", we continue to use the
2359
 
            # original algorithm - per-file-graph - for the "single
2360
 
            # file that isn't a directory without showing a delta" case.
2361
 
            partial_history = revision and b.repository._format.supports_chks
2362
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2363
 
                or delta_type or partial_history)
2364
 
 
2365
 
            # Build the LogRequest and execute it
2366
 
            if len(file_ids) == 0:
2367
 
                file_ids = None
2368
 
            rqst = make_log_request_dict(
2369
 
                direction=direction, specific_fileids=file_ids,
2370
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2371
 
                message_search=message, delta_type=delta_type,
2372
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2373
 
            Logger(b, rqst).show(lf)
2374
 
        finally:
2375
 
            if b is not None:
2376
 
                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)
2377
2436
 
2378
2437
 
2379
2438
def _get_revision_range(revisionspec_list, branch, command_name):
2397
2456
            raise errors.BzrCommandError(
2398
2457
                "bzr %s doesn't accept two revisions in different"
2399
2458
                " branches." % command_name)
2400
 
        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)
2401
2464
        # Avoid loading all of history when we know a missing
2402
2465
        # end of range means the last revision ...
2403
2466
        if end_spec.spec is None:
2432
2495
 
2433
2496
 
2434
2497
class cmd_touching_revisions(Command):
2435
 
    """Return revision-ids which affected a particular file.
 
2498
    __doc__ = """Return revision-ids which affected a particular file.
2436
2499
 
2437
2500
    A more user-friendly interface is "bzr log FILE".
2438
2501
    """
2446
2509
        file_id = tree.path2id(relpath)
2447
2510
        b = tree.branch
2448
2511
        b.lock_read()
2449
 
        try:
2450
 
            touching_revs = log.find_touching_revisions(b, file_id)
2451
 
            for revno, revision_id, what in touching_revs:
2452
 
                self.outf.write("%6d %s\n" % (revno, what))
2453
 
        finally:
2454
 
            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))
2455
2516
 
2456
2517
 
2457
2518
class cmd_ls(Command):
2458
 
    """List files in a tree.
 
2519
    __doc__ = """List files in a tree.
2459
2520
    """
2460
2521
 
2461
2522
    _see_also = ['status', 'cat']
2509
2570
        if from_root:
2510
2571
            if relpath:
2511
2572
                prefix = relpath + '/'
2512
 
        elif fs_path != '.':
 
2573
        elif fs_path != '.' and not fs_path.endswith('/'):
2513
2574
            prefix = fs_path + '/'
2514
2575
 
2515
2576
        if revision is not None or tree is None:
2524
2585
                note("Ignoring files outside view. View is %s" % view_str)
2525
2586
 
2526
2587
        tree.lock_read()
2527
 
        try:
2528
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2529
 
                from_dir=relpath, recursive=recursive):
2530
 
                # Apply additional masking
2531
 
                if not all and not selection[fc]:
2532
 
                    continue
2533
 
                if kind is not None and fkind != kind:
2534
 
                    continue
2535
 
                if apply_view:
2536
 
                    try:
2537
 
                        if relpath:
2538
 
                            fullpath = osutils.pathjoin(relpath, fp)
2539
 
                        else:
2540
 
                            fullpath = fp
2541
 
                        views.check_path_in_view(tree, fullpath)
2542
 
                    except errors.FileOutsideView:
2543
 
                        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
2544
2605
 
2545
 
                # Output the entry
2546
 
                if prefix:
2547
 
                    fp = osutils.pathjoin(prefix, fp)
2548
 
                kindch = entry.kind_character()
2549
 
                outstring = fp + kindch
2550
 
                ui.ui_factory.clear_term()
2551
 
                if verbose:
2552
 
                    outstring = '%-8s %s' % (fc, outstring)
2553
 
                    if show_ids and fid is not None:
2554
 
                        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:
2555
2632
                    self.outf.write(outstring + '\n')
2556
 
                elif null:
2557
 
                    self.outf.write(fp + '\0')
2558
 
                    if show_ids:
2559
 
                        if fid is not None:
2560
 
                            self.outf.write(fid)
2561
 
                        self.outf.write('\0')
2562
 
                    self.outf.flush()
2563
 
                else:
2564
 
                    if show_ids:
2565
 
                        if fid is not None:
2566
 
                            my_id = fid
2567
 
                        else:
2568
 
                            my_id = ''
2569
 
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
2570
 
                    else:
2571
 
                        self.outf.write(outstring + '\n')
2572
 
        finally:
2573
 
            tree.unlock()
2574
2633
 
2575
2634
 
2576
2635
class cmd_unknowns(Command):
2577
 
    """List unknown files.
 
2636
    __doc__ = """List unknown files.
2578
2637
    """
2579
2638
 
2580
2639
    hidden = True
2587
2646
 
2588
2647
 
2589
2648
class cmd_ignore(Command):
2590
 
    """Ignore specified files or patterns.
 
2649
    __doc__ = """Ignore specified files or patterns.
2591
2650
 
2592
2651
    See ``bzr help patterns`` for details on the syntax of patterns.
2593
2652
 
2601
2660
    After adding, editing or deleting that file either indirectly by
2602
2661
    using this command or directly by using an editor, be sure to commit
2603
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.
2604
2676
 
2605
2677
    Note: ignore patterns containing shell wildcards must be quoted from
2606
2678
    the shell on Unix.
2610
2682
 
2611
2683
            bzr ignore ./Makefile
2612
2684
 
2613
 
        Ignore class files in all directories::
 
2685
        Ignore .class files in all directories...::
2614
2686
 
2615
2687
            bzr ignore "*.class"
2616
2688
 
 
2689
        ...but do not ignore "special.class"::
 
2690
 
 
2691
            bzr ignore "!special.class"
 
2692
 
2617
2693
        Ignore .o files under the lib directory::
2618
2694
 
2619
2695
            bzr ignore "lib/**/*.o"
2625
2701
        Ignore everything but the "debian" toplevel directory::
2626
2702
 
2627
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 "!!*~"
2628
2711
    """
2629
2712
 
2630
2713
    _see_also = ['status', 'ignored', 'patterns']
2631
2714
    takes_args = ['name_pattern*']
2632
2715
    takes_options = [
2633
 
        Option('old-default-rules',
2634
 
               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.')
2635
2718
        ]
2636
2719
 
2637
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2720
    def run(self, name_pattern_list=None, default_rules=None):
2638
2721
        from bzrlib import ignores
2639
 
        if old_default_rules is not None:
2640
 
            # dump the rules and exit
2641
 
            for pattern in ignores.OLD_DEFAULTS:
2642
 
                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)
2643
2726
            return
2644
2727
        if not name_pattern_list:
2645
2728
            raise errors.BzrCommandError("ignore requires at least one "
2646
 
                                  "NAME_PATTERN or --old-default-rules")
 
2729
                "NAME_PATTERN or --default-rules.")
2647
2730
        name_pattern_list = [globbing.normalize_pattern(p)
2648
2731
                             for p in name_pattern_list]
2649
2732
        for name_pattern in name_pattern_list:
2661
2744
            if id is not None:
2662
2745
                filename = entry[0]
2663
2746
                if ignored.match(filename):
2664
 
                    matches.append(filename.encode('utf-8'))
 
2747
                    matches.append(filename)
2665
2748
        tree.unlock()
2666
2749
        if len(matches) > 0:
2667
 
            print "Warning: the following files are version controlled and" \
2668
 
                  " match your ignore pattern:\n%s" \
2669
 
                  "\nThese files will continue to be version controlled" \
2670
 
                  " 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),))
2671
2754
 
2672
2755
 
2673
2756
class cmd_ignored(Command):
2674
 
    """List ignored files and the patterns that matched them.
 
2757
    __doc__ = """List ignored files and the patterns that matched them.
2675
2758
 
2676
2759
    List all the ignored files and the ignore pattern that caused the file to
2677
2760
    be ignored.
2688
2771
    def run(self):
2689
2772
        tree = WorkingTree.open_containing(u'.')[0]
2690
2773
        tree.lock_read()
2691
 
        try:
2692
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2693
 
                if file_class != 'I':
2694
 
                    continue
2695
 
                ## XXX: Slightly inefficient since this was already calculated
2696
 
                pat = tree.is_ignored(path)
2697
 
                self.outf.write('%-50s %s\n' % (path, pat))
2698
 
        finally:
2699
 
            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))
2700
2781
 
2701
2782
 
2702
2783
class cmd_lookup_revision(Command):
2703
 
    """Lookup the revision-id from a revision-number
 
2784
    __doc__ = """Lookup the revision-id from a revision-number
2704
2785
 
2705
2786
    :Examples:
2706
2787
        bzr lookup-revision 33
2713
2794
        try:
2714
2795
            revno = int(revno)
2715
2796
        except ValueError:
2716
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2717
 
 
2718
 
        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)
2719
2801
 
2720
2802
 
2721
2803
class cmd_export(Command):
2722
 
    """Export current or past revision to a destination directory or archive.
 
2804
    __doc__ = """Export current or past revision to a destination directory or archive.
2723
2805
 
2724
2806
    If no revision is specified this exports the last committed revision.
2725
2807
 
2757
2839
        Option('root',
2758
2840
               type=str,
2759
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.'),
2760
2845
        ]
2761
2846
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2762
 
        root=None, filters=False):
 
2847
        root=None, filters=False, per_file_timestamps=False):
2763
2848
        from bzrlib.export import export
2764
2849
 
2765
2850
        if branch_or_subdir is None:
2772
2857
 
2773
2858
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2774
2859
        try:
2775
 
            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)
2776
2862
        except errors.NoSuchExportFormat, e:
2777
2863
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2778
2864
 
2779
2865
 
2780
2866
class cmd_cat(Command):
2781
 
    """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.
2782
2868
 
2783
2869
    If no revision is nominated, the last revision is used.
2784
2870
 
2805
2891
        tree, branch, relpath = \
2806
2892
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2807
2893
        branch.lock_read()
2808
 
        try:
2809
 
            return self._run(tree, branch, relpath, filename, revision,
2810
 
                             name_from_revision, filters)
2811
 
        finally:
2812
 
            branch.unlock()
 
2894
        self.add_cleanup(branch.unlock)
 
2895
        return self._run(tree, branch, relpath, filename, revision,
 
2896
                         name_from_revision, filters)
2813
2897
 
2814
2898
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2815
2899
        filtered):
2816
2900
        if tree is None:
2817
2901
            tree = b.basis_tree()
2818
2902
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2903
        rev_tree.lock_read()
 
2904
        self.add_cleanup(rev_tree.unlock)
2819
2905
 
2820
2906
        old_file_id = rev_tree.path2id(relpath)
2821
2907
 
2856
2942
            chunks = content.splitlines(True)
2857
2943
            content = filtered_output_bytes(chunks, filters,
2858
2944
                ContentFilterContext(relpath, rev_tree))
 
2945
            self.cleanup_now()
2859
2946
            self.outf.writelines(content)
2860
2947
        else:
 
2948
            self.cleanup_now()
2861
2949
            self.outf.write(content)
2862
2950
 
2863
2951
 
2864
2952
class cmd_local_time_offset(Command):
2865
 
    """Show the offset in seconds from GMT to local time."""
 
2953
    __doc__ = """Show the offset in seconds from GMT to local time."""
2866
2954
    hidden = True
2867
2955
    @display_command
2868
2956
    def run(self):
2869
 
        print osutils.local_time_offset()
 
2957
        self.outf.write("%s\n" % osutils.local_time_offset())
2870
2958
 
2871
2959
 
2872
2960
 
2873
2961
class cmd_commit(Command):
2874
 
    """Commit changes into a new revision.
 
2962
    __doc__ = """Commit changes into a new revision.
2875
2963
 
2876
2964
    An explanatory message needs to be given for each commit. This is
2877
2965
    often done by using the --message option (getting the message from the
2985
3073
                         "the master branch until a normal commit "
2986
3074
                         "is performed."
2987
3075
                    ),
2988
 
             Option('show-diff',
 
3076
             Option('show-diff', short_name='p',
2989
3077
                    help='When no message is supplied, show the diff along'
2990
3078
                    ' with the status summary in the message editor.'),
2991
3079
             ]
3057
3145
        if local and not tree.branch.get_bound_location():
3058
3146
            raise errors.LocalRequiresBoundBranch()
3059
3147
 
 
3148
        if message is not None:
 
3149
            try:
 
3150
                file_exists = osutils.lexists(message)
 
3151
            except UnicodeError:
 
3152
                # The commit message contains unicode characters that can't be
 
3153
                # represented in the filesystem encoding, so that can't be a
 
3154
                # file.
 
3155
                file_exists = False
 
3156
            if file_exists:
 
3157
                warning_msg = (
 
3158
                    'The commit message is a file name: "%(f)s".\n'
 
3159
                    '(use --file "%(f)s" to take commit message from that file)'
 
3160
                    % { 'f': message })
 
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")
 
3168
 
3060
3169
        def get_message(commit_obj):
3061
3170
            """Callback to get commit message"""
3062
 
            my_message = message
3063
 
            if my_message is not None and '\r' in my_message:
3064
 
                my_message = my_message.replace('\r\n', '\n')
3065
 
                my_message = my_message.replace('\r', '\n')
3066
 
            if my_message is None and not file:
3067
 
                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,
3068
3180
                        selected_list, diff=show_diff,
3069
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.
3070
3187
                start_message = generate_commit_message_template(commit_obj)
3071
 
                my_message = edit_commit_message_encoded(t,
 
3188
                my_message = edit_commit_message_encoded(text,
3072
3189
                    start_message=start_message)
3073
3190
                if my_message is None:
3074
3191
                    raise errors.BzrCommandError("please specify a commit"
3075
3192
                        " message with either --message or --file")
3076
 
            elif my_message and file:
3077
 
                raise errors.BzrCommandError(
3078
 
                    "please specify either --message or --file")
3079
 
            if file:
3080
 
                my_message = codecs.open(file, 'rt',
3081
 
                                         osutils.get_user_encoding()).read()
3082
3193
            if my_message == "":
3083
3194
                raise errors.BzrCommandError("empty commit message specified")
3084
3195
            return my_message
3096
3207
                        timezone=offset,
3097
3208
                        exclude=safe_relpath_files(tree, exclude))
3098
3209
        except PointlessCommit:
3099
 
            # FIXME: This should really happen before the file is read in;
3100
 
            # perhaps prepare the commit; get the message; then actually commit
3101
3210
            raise errors.BzrCommandError("No changes to commit."
3102
3211
                              " Use --unchanged to commit anyhow.")
3103
3212
        except ConflictsInTree:
3108
3217
            raise errors.BzrCommandError("Commit refused because there are"
3109
3218
                              " unknown files in the working tree.")
3110
3219
        except errors.BoundBranchOutOfDate, e:
3111
 
            raise errors.BzrCommandError(str(e) + "\n"
3112
 
            'To commit to master branch, run update and then commit.\n'
3113
 
            'You can also pass --local to commit to continue working '
3114
 
            '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
3115
3225
 
3116
3226
 
3117
3227
class cmd_check(Command):
3118
 
    """Validate working tree structure, branch consistency and repository history.
 
3228
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3119
3229
 
3120
3230
    This command checks various invariants about branch and repository storage
3121
3231
    to detect data corruption or bzr bugs.
3185
3295
 
3186
3296
 
3187
3297
class cmd_upgrade(Command):
3188
 
    """Upgrade branch storage to current format.
 
3298
    __doc__ = """Upgrade branch storage to current format.
3189
3299
 
3190
3300
    The check command or bzr developers may sometimes advise you to run
3191
3301
    this command. When the default format has changed you may also be warned
3209
3319
 
3210
3320
 
3211
3321
class cmd_whoami(Command):
3212
 
    """Show or set bzr user id.
 
3322
    __doc__ = """Show or set bzr user id.
3213
3323
 
3214
3324
    :Examples:
3215
3325
        Show the email of the current user::
3259
3369
 
3260
3370
 
3261
3371
class cmd_nick(Command):
3262
 
    """Print or set the branch nickname.
 
3372
    __doc__ = """Print or set the branch nickname.
3263
3373
 
3264
3374
    If unset, the tree root directory name is used as the nickname.
3265
3375
    To print the current nickname, execute with no argument.
3279
3389
 
3280
3390
    @display_command
3281
3391
    def printme(self, branch):
3282
 
        print branch.nick
 
3392
        self.outf.write('%s\n' % branch.nick)
3283
3393
 
3284
3394
 
3285
3395
class cmd_alias(Command):
3286
 
    """Set/unset and display aliases.
 
3396
    __doc__ = """Set/unset and display aliases.
3287
3397
 
3288
3398
    :Examples:
3289
3399
        Show the current aliases::
3353
3463
 
3354
3464
 
3355
3465
class cmd_selftest(Command):
3356
 
    """Run internal test suite.
 
3466
    __doc__ = """Run internal test suite.
3357
3467
 
3358
3468
    If arguments are given, they are regular expressions that say which tests
3359
3469
    should run.  Tests matching any expression are run, and other tests are
3403
3513
    def get_transport_type(typestring):
3404
3514
        """Parse and return a transport specifier."""
3405
3515
        if typestring == "sftp":
3406
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3407
 
            return SFTPAbsoluteServer
 
3516
            from bzrlib.tests import stub_sftp
 
3517
            return stub_sftp.SFTPAbsoluteServer
3408
3518
        if typestring == "memory":
3409
 
            from bzrlib.transport.memory import MemoryServer
3410
 
            return MemoryServer
 
3519
            from bzrlib.tests import test_server
 
3520
            return memory.MemoryServer
3411
3521
        if typestring == "fakenfs":
3412
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3413
 
            return FakeNFSServer
 
3522
            from bzrlib.tests import test_server
 
3523
            return test_server.FakeNFSServer
3414
3524
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3415
3525
            (typestring)
3416
3526
        raise errors.BzrCommandError(msg)
3500
3610
                raise errors.BzrCommandError("subunit not available. subunit "
3501
3611
                    "needs to be installed to use --subunit.")
3502
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)
3503
3618
        if parallel:
3504
3619
            self.additional_selftest_args.setdefault(
3505
3620
                'suite_decorators', []).append(parallel)
3509
3624
            verbose = not is_quiet()
3510
3625
            # TODO: should possibly lock the history file...
3511
3626
            benchfile = open(".perf_history", "at", buffering=1)
 
3627
            self.add_cleanup(benchfile.close)
3512
3628
        else:
3513
3629
            test_suite_factory = None
3514
3630
            benchfile = None
3515
 
        try:
3516
 
            selftest_kwargs = {"verbose": verbose,
3517
 
                              "pattern": pattern,
3518
 
                              "stop_on_failure": one,
3519
 
                              "transport": transport,
3520
 
                              "test_suite_factory": test_suite_factory,
3521
 
                              "lsprof_timed": lsprof_timed,
3522
 
                              "lsprof_tests": lsprof_tests,
3523
 
                              "bench_history": benchfile,
3524
 
                              "matching_tests_first": first,
3525
 
                              "list_only": list_only,
3526
 
                              "random_seed": randomize,
3527
 
                              "exclude_pattern": exclude,
3528
 
                              "strict": strict,
3529
 
                              "load_list": load_list,
3530
 
                              "debug_flags": debugflag,
3531
 
                              "starting_with": starting_with
3532
 
                              }
3533
 
            selftest_kwargs.update(self.additional_selftest_args)
3534
 
            result = selftest(**selftest_kwargs)
3535
 
        finally:
3536
 
            if benchfile is not None:
3537
 
                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)
3538
3650
        return int(not result)
3539
3651
 
3540
3652
 
3541
3653
class cmd_version(Command):
3542
 
    """Show version of bzr."""
 
3654
    __doc__ = """Show version of bzr."""
3543
3655
 
3544
3656
    encoding_type = 'replace'
3545
3657
    takes_options = [
3556
3668
 
3557
3669
 
3558
3670
class cmd_rocks(Command):
3559
 
    """Statement of optimism."""
 
3671
    __doc__ = """Statement of optimism."""
3560
3672
 
3561
3673
    hidden = True
3562
3674
 
3563
3675
    @display_command
3564
3676
    def run(self):
3565
 
        print "It sure does!"
 
3677
        self.outf.write("It sure does!\n")
3566
3678
 
3567
3679
 
3568
3680
class cmd_find_merge_base(Command):
3569
 
    """Find and print a base revision for merging two branches."""
 
3681
    __doc__ = """Find and print a base revision for merging two branches."""
3570
3682
    # TODO: Options to specify revisions on either side, as if
3571
3683
    #       merging only part of the history.
3572
3684
    takes_args = ['branch', 'other']
3579
3691
        branch1 = Branch.open_containing(branch)[0]
3580
3692
        branch2 = Branch.open_containing(other)[0]
3581
3693
        branch1.lock_read()
3582
 
        try:
3583
 
            branch2.lock_read()
3584
 
            try:
3585
 
                last1 = ensure_null(branch1.last_revision())
3586
 
                last2 = ensure_null(branch2.last_revision())
3587
 
 
3588
 
                graph = branch1.repository.get_graph(branch2.repository)
3589
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3590
 
 
3591
 
                print 'merge base is revision %s' % base_rev_id
3592
 
            finally:
3593
 
                branch2.unlock()
3594
 
        finally:
3595
 
            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)
3596
3704
 
3597
3705
 
3598
3706
class cmd_merge(Command):
3599
 
    """Perform a three-way merge.
 
3707
    __doc__ = """Perform a three-way merge.
3600
3708
 
3601
3709
    The source of the merge can be specified either in the form of a branch,
3602
3710
    or in the form of a path to a file containing a merge directive generated
3631
3739
    committed to record the result of the merge.
3632
3740
 
3633
3741
    merge refuses to run if there are any uncommitted changes, unless
3634
 
    --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.
3635
3748
 
3636
3749
    To select only some changes to merge, use "merge -i", which will prompt
3637
3750
    you to apply each diff hunk and file change, similar to "shelve".
3652
3765
        To apply a merge directive contained in /tmp/merge::
3653
3766
 
3654
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'
3655
3775
    """
3656
3776
 
3657
3777
    encoding_type = 'exact'
3715
3835
        view_info = _get_view_info_for_change_reporter(tree)
3716
3836
        change_reporter = delta._ChangeReporter(
3717
3837
            unversioned_filter=tree.is_ignored, view_info=view_info)
3718
 
        cleanups = []
3719
 
        try:
3720
 
            pb = ui.ui_factory.nested_progress_bar()
3721
 
            cleanups.append(pb.finished)
3722
 
            tree.lock_write()
3723
 
            cleanups.append(tree.unlock)
3724
 
            if location is not None:
3725
 
                try:
3726
 
                    mergeable = bundle.read_mergeable_from_url(location,
3727
 
                        possible_transports=possible_transports)
3728
 
                except errors.NotABundle:
3729
 
                    mergeable = None
3730
 
                else:
3731
 
                    if uncommitted:
3732
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3733
 
                            ' with bundles or merge directives.')
3734
 
 
3735
 
                    if revision is not None:
3736
 
                        raise errors.BzrCommandError(
3737
 
                            'Cannot use -r with merge directives or bundles')
3738
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3739
 
                       mergeable, pb)
3740
 
 
3741
 
            if merger is None and uncommitted:
3742
 
                if revision is not None and len(revision) > 0:
3743
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3744
 
                        ' --revision at the same time.')
3745
 
                merger = self.get_merger_from_uncommitted(tree, location, pb,
3746
 
                                                          cleanups)
3747
 
                allow_pending = False
3748
 
 
3749
 
            if merger is None:
3750
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3751
 
                    location, revision, remember, possible_transports, pb)
3752
 
 
3753
 
            merger.merge_type = merge_type
3754
 
            merger.reprocess = reprocess
3755
 
            merger.show_base = show_base
3756
 
            self.sanity_check_merger(merger)
3757
 
            if (merger.base_rev_id == merger.other_rev_id and
3758
 
                merger.other_rev_id is not None):
3759
 
                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)
3760
3885
                return 0
3761
 
            if pull:
3762
 
                if merger.interesting_files is not None:
3763
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3764
 
                if (merger.base_rev_id == tree.last_revision()):
3765
 
                    result = tree.pull(merger.other_branch, False,
3766
 
                                       merger.other_rev_id)
3767
 
                    result.report(self.outf)
3768
 
                    return 0
3769
 
            if merger.this_basis is None:
3770
 
                raise errors.BzrCommandError(
3771
 
                    "This branch has no commits."
3772
 
                    " (perhaps you would prefer 'bzr pull')")
3773
 
            if preview:
3774
 
                return self._do_preview(merger, cleanups)
3775
 
            elif interactive:
3776
 
                return self._do_interactive(merger, cleanups)
3777
 
            else:
3778
 
                return self._do_merge(merger, change_reporter, allow_pending,
3779
 
                                      verified)
3780
 
        finally:
3781
 
            for cleanup in reversed(cleanups):
3782
 
                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)
3783
3897
 
3784
 
    def _get_preview(self, merger, cleanups):
 
3898
    def _get_preview(self, merger):
3785
3899
        tree_merger = merger.make_merger()
3786
3900
        tt = tree_merger.make_preview_transform()
3787
 
        cleanups.append(tt.finalize)
 
3901
        self.add_cleanup(tt.finalize)
3788
3902
        result_tree = tt.get_preview_tree()
3789
3903
        return result_tree
3790
3904
 
3791
 
    def _do_preview(self, merger, cleanups):
 
3905
    def _do_preview(self, merger):
3792
3906
        from bzrlib.diff import show_diff_trees
3793
 
        result_tree = self._get_preview(merger, cleanups)
 
3907
        result_tree = self._get_preview(merger)
3794
3908
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3795
3909
                        old_label='', new_label='')
3796
3910
 
3806
3920
        else:
3807
3921
            return 0
3808
3922
 
3809
 
    def _do_interactive(self, merger, cleanups):
 
3923
    def _do_interactive(self, merger):
3810
3924
        """Perform an interactive merge.
3811
3925
 
3812
3926
        This works by generating a preview tree of the merge, then using
3814
3928
        and the preview tree.
3815
3929
        """
3816
3930
        from bzrlib import shelf_ui
3817
 
        result_tree = self._get_preview(merger, cleanups)
 
3931
        result_tree = self._get_preview(merger)
3818
3932
        writer = bzrlib.option.diff_writer_registry.get()
3819
3933
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3820
3934
                                   reporter=shelf_ui.ApplyReporter(),
3821
3935
                                   diff_writer=writer(sys.stdout))
3822
 
        shelver.run()
 
3936
        try:
 
3937
            shelver.run()
 
3938
        finally:
 
3939
            shelver.finalize()
3823
3940
 
3824
3941
    def sanity_check_merger(self, merger):
3825
3942
        if (merger.show_base and
3885
4002
            allow_pending = True
3886
4003
        return merger, allow_pending
3887
4004
 
3888
 
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
4005
    def get_merger_from_uncommitted(self, tree, location, pb):
3889
4006
        """Get a merger for uncommitted changes.
3890
4007
 
3891
4008
        :param tree: The tree the merger should apply to.
3892
4009
        :param location: The location containing uncommitted changes.
3893
4010
        :param pb: The progress bar to use for showing progress.
3894
 
        :param cleanups: A list of operations to perform to clean up the
3895
 
            temporary directories, unfinalized objects, etc.
3896
4011
        """
3897
4012
        location = self._select_branch_location(tree, location)[0]
3898
4013
        other_tree, other_path = WorkingTree.open_containing(location)
3950
4065
 
3951
4066
 
3952
4067
class cmd_remerge(Command):
3953
 
    """Redo a merge.
 
4068
    __doc__ = """Redo a merge.
3954
4069
 
3955
4070
    Use this if you want to try a different merge technique while resolving
3956
4071
    conflicts.  Some merge techniques are better than others, and remerge
3981
4096
 
3982
4097
    def run(self, file_list=None, merge_type=None, show_base=False,
3983
4098
            reprocess=False):
 
4099
        from bzrlib.conflicts import restore
3984
4100
        if merge_type is None:
3985
4101
            merge_type = _mod_merge.Merge3Merger
3986
4102
        tree, file_list = tree_files(file_list)
3987
4103
        tree.lock_write()
3988
 
        try:
3989
 
            parents = tree.get_parent_ids()
3990
 
            if len(parents) != 2:
3991
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3992
 
                                             " merges.  Not cherrypicking or"
3993
 
                                             " multi-merges.")
3994
 
            repository = tree.branch.repository
3995
 
            interesting_ids = None
3996
 
            new_conflicts = []
3997
 
            conflicts = tree.conflicts()
3998
 
            if file_list is not None:
3999
 
                interesting_ids = set()
4000
 
                for filename in file_list:
4001
 
                    file_id = tree.path2id(filename)
4002
 
                    if file_id is None:
4003
 
                        raise errors.NotVersionedError(filename)
4004
 
                    interesting_ids.add(file_id)
4005
 
                    if tree.kind(file_id) != "directory":
4006
 
                        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
4007
4123
 
4008
 
                    for name, ie in tree.inventory.iter_entries(file_id):
4009
 
                        interesting_ids.add(ie.file_id)
4010
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4011
 
            else:
4012
 
                # Remerge only supports resolving contents conflicts
4013
 
                allowed_conflicts = ('text conflict', 'contents conflict')
4014
 
                restore_files = [c.path for c in conflicts
4015
 
                                 if c.typestring in allowed_conflicts]
4016
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4017
 
            tree.set_conflicts(ConflictList(new_conflicts))
4018
 
            if file_list is not None:
4019
 
                restore_files = file_list
4020
 
            for filename in restore_files:
4021
 
                try:
4022
 
                    restore(tree.abspath(filename))
4023
 
                except errors.NotConflicted:
4024
 
                    pass
4025
 
            # Disable pending merges, because the file texts we are remerging
4026
 
            # have not had those merges performed.  If we use the wrong parents
4027
 
            # list, we imply that the working tree text has seen and rejected
4028
 
            # all the changes from the other tree, when in fact those changes
4029
 
            # have not yet been seen.
4030
 
            pb = ui.ui_factory.nested_progress_bar()
4031
 
            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:
4032
4137
            try:
4033
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
4034
 
                                                             tree, parents[1])
4035
 
                merger.interesting_ids = interesting_ids
4036
 
                merger.merge_type = merge_type
4037
 
                merger.show_base = show_base
4038
 
                merger.reprocess = reprocess
4039
 
                conflicts = merger.do_merge()
4040
 
            finally:
4041
 
                tree.set_parent_ids(parents)
4042
 
                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()
4043
4154
        finally:
4044
 
            tree.unlock()
 
4155
            tree.set_parent_ids(parents)
4045
4156
        if conflicts > 0:
4046
4157
            return 1
4047
4158
        else:
4049
4160
 
4050
4161
 
4051
4162
class cmd_revert(Command):
4052
 
    """Revert files to a previous revision.
 
4163
    __doc__ = """Revert files to a previous revision.
4053
4164
 
4054
4165
    Giving a list of files will revert only those files.  Otherwise, all files
4055
4166
    will be reverted.  If the revision is not specified with '--revision', the
4074
4185
    created as above.  Directories containing unknown files will not be
4075
4186
    deleted.
4076
4187
 
4077
 
    The working tree contains a list of pending merged revisions, which will
4078
 
    be included as parents in the next commit.  Normally, revert clears that
4079
 
    list as well as reverting the files.  If any files are specified, revert
4080
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
4081
 
    revert ." in the tree root to revert all files but keep the merge record,
4082
 
    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
4083
4195
    reverting any files.
 
4196
 
 
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
 
4205
    target branches.
4084
4206
    """
4085
4207
 
4086
4208
    _see_also = ['cat', 'export']
4095
4217
    def run(self, revision=None, no_backup=False, file_list=None,
4096
4218
            forget_merges=None):
4097
4219
        tree, file_list = tree_files(file_list)
4098
 
        tree.lock_write()
4099
 
        try:
4100
 
            if forget_merges:
4101
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
4102
 
            else:
4103
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4104
 
        finally:
4105
 
            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)
4106
4226
 
4107
4227
    @staticmethod
4108
4228
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4109
4229
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4110
 
        pb = ui.ui_factory.nested_progress_bar()
4111
 
        try:
4112
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
4113
 
                report_changes=True)
4114
 
        finally:
4115
 
            pb.finished()
 
4230
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4231
            report_changes=True)
4116
4232
 
4117
4233
 
4118
4234
class cmd_assert_fail(Command):
4119
 
    """Test reporting of assertion failures"""
 
4235
    __doc__ = """Test reporting of assertion failures"""
4120
4236
    # intended just for use in testing
4121
4237
 
4122
4238
    hidden = True
4126
4242
 
4127
4243
 
4128
4244
class cmd_help(Command):
4129
 
    """Show help on a command or other topic.
 
4245
    __doc__ = """Show help on a command or other topic.
4130
4246
    """
4131
4247
 
4132
4248
    _see_also = ['topics']
4145
4261
 
4146
4262
 
4147
4263
class cmd_shell_complete(Command):
4148
 
    """Show appropriate completions for context.
 
4264
    __doc__ = """Show appropriate completions for context.
4149
4265
 
4150
4266
    For a list of all available commands, say 'bzr shell-complete'.
4151
4267
    """
4160
4276
 
4161
4277
 
4162
4278
class cmd_missing(Command):
4163
 
    """Show unmerged/unpulled revisions between two branches.
 
4279
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4164
4280
 
4165
4281
    OTHER_BRANCH may be local or remote.
4166
4282
 
4167
4283
    To filter on a range of revisions, you can use the command -r begin..end
4168
4284
    -r revision requests a specific revision, -r ..end or -r begin.. are
4169
4285
    also valid.
 
4286
            
 
4287
    :Exit values:
 
4288
        1 - some missing revisions
 
4289
        0 - no missing revisions
4170
4290
 
4171
4291
    :Examples:
4172
4292
 
4240
4360
            restrict = 'remote'
4241
4361
 
4242
4362
        local_branch = Branch.open_containing(u".")[0]
 
4363
        local_branch.lock_read()
 
4364
        self.add_cleanup(local_branch.unlock)
 
4365
 
4243
4366
        parent = local_branch.get_parent()
4244
4367
        if other_branch is None:
4245
4368
            other_branch = parent
4254
4377
        remote_branch = Branch.open(other_branch)
4255
4378
        if remote_branch.base == local_branch.base:
4256
4379
            remote_branch = local_branch
 
4380
        else:
 
4381
            remote_branch.lock_read()
 
4382
            self.add_cleanup(remote_branch.unlock)
4257
4383
 
4258
4384
        local_revid_range = _revision_range_to_revid_range(
4259
4385
            _get_revision_range(my_revision, local_branch,
4263
4389
            _get_revision_range(revision,
4264
4390
                remote_branch, self.name()))
4265
4391
 
4266
 
        local_branch.lock_read()
4267
 
        try:
4268
 
            remote_branch.lock_read()
4269
 
            try:
4270
 
                local_extra, remote_extra = find_unmerged(
4271
 
                    local_branch, remote_branch, restrict,
4272
 
                    backward=not reverse,
4273
 
                    include_merges=include_merges,
4274
 
                    local_revid_range=local_revid_range,
4275
 
                    remote_revid_range=remote_revid_range)
4276
 
 
4277
 
                if log_format is None:
4278
 
                    registry = log.log_formatter_registry
4279
 
                    log_format = registry.get_default(local_branch)
4280
 
                lf = log_format(to_file=self.outf,
4281
 
                                show_ids=show_ids,
4282
 
                                show_timezone='original')
4283
 
 
4284
 
                status_code = 0
4285
 
                if local_extra and not theirs_only:
4286
 
                    message("You have %d extra revision(s):\n" %
4287
 
                        len(local_extra))
4288
 
                    for revision in iter_log_revisions(local_extra,
4289
 
                                        local_branch.repository,
4290
 
                                        verbose):
4291
 
                        lf.log_revision(revision)
4292
 
                    printed_local = True
4293
 
                    status_code = 1
4294
 
                else:
4295
 
                    printed_local = False
4296
 
 
4297
 
                if remote_extra and not mine_only:
4298
 
                    if printed_local is True:
4299
 
                        message("\n\n\n")
4300
 
                    message("You are missing %d revision(s):\n" %
4301
 
                        len(remote_extra))
4302
 
                    for revision in iter_log_revisions(remote_extra,
4303
 
                                        remote_branch.repository,
4304
 
                                        verbose):
4305
 
                        lf.log_revision(revision)
4306
 
                    status_code = 1
4307
 
 
4308
 
                if mine_only and not local_extra:
4309
 
                    # We checked local, and found nothing extra
4310
 
                    message('This branch is up to date.\n')
4311
 
                elif theirs_only and not remote_extra:
4312
 
                    # We checked remote, and found nothing extra
4313
 
                    message('Other branch is up to date.\n')
4314
 
                elif not (mine_only or theirs_only or local_extra or
4315
 
                          remote_extra):
4316
 
                    # We checked both branches, and neither one had extra
4317
 
                    # revisions
4318
 
                    message("Branches are up to date.\n")
4319
 
            finally:
4320
 
                remote_branch.unlock()
4321
 
        finally:
4322
 
            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()
4323
4442
        if not status_code and parent is None and other_branch is not None:
4324
4443
            local_branch.lock_write()
4325
 
            try:
4326
 
                # handle race conditions - a parent might be set while we run.
4327
 
                if local_branch.get_parent() is None:
4328
 
                    local_branch.set_parent(remote_branch.base)
4329
 
            finally:
4330
 
                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)
4331
4448
        return status_code
4332
4449
 
4333
4450
 
4334
4451
class cmd_pack(Command):
4335
 
    """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
    """
4336
4469
 
4337
4470
    _see_also = ['repositories']
4338
4471
    takes_args = ['branch_or_repo?']
 
4472
    takes_options = [
 
4473
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4474
        ]
4339
4475
 
4340
 
    def run(self, branch_or_repo='.'):
 
4476
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4341
4477
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4342
4478
        try:
4343
4479
            branch = dir.open_branch()
4344
4480
            repository = branch.repository
4345
4481
        except errors.NotBranchError:
4346
4482
            repository = dir.open_repository()
4347
 
        repository.pack()
 
4483
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4348
4484
 
4349
4485
 
4350
4486
class cmd_plugins(Command):
4351
 
    """List the installed plugins.
 
4487
    __doc__ = """List the installed plugins.
4352
4488
 
4353
4489
    This command displays the list of installed plugins including
4354
4490
    version of plugin and a short description of each.
4361
4497
    adding new commands, providing additional network transports and
4362
4498
    customizing log output.
4363
4499
 
4364
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4365
 
    information on plugins including where to find them and how to
4366
 
    install them. Instructions are also provided there on how to
4367
 
    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.
4368
4504
    """
4369
4505
    takes_options = ['verbose']
4370
4506
 
4385
4521
                doc = '(no description)'
4386
4522
            result.append((name_ver, doc, plugin.path()))
4387
4523
        for name_ver, doc, path in sorted(result):
4388
 
            print name_ver
4389
 
            print '   ', doc
 
4524
            self.outf.write("%s\n" % name_ver)
 
4525
            self.outf.write("   %s\n" % doc)
4390
4526
            if verbose:
4391
 
                print '   ', path
4392
 
            print
 
4527
                self.outf.write("   %s\n" % path)
 
4528
            self.outf.write("\n")
4393
4529
 
4394
4530
 
4395
4531
class cmd_testament(Command):
4396
 
    """Show testament (signing-form) of a revision."""
 
4532
    __doc__ = """Show testament (signing-form) of a revision."""
4397
4533
    takes_options = [
4398
4534
            'revision',
4399
4535
            Option('long', help='Produce long-format testament.'),
4412
4548
        else:
4413
4549
            b = Branch.open(branch)
4414
4550
        b.lock_read()
4415
 
        try:
4416
 
            if revision is None:
4417
 
                rev_id = b.last_revision()
4418
 
            else:
4419
 
                rev_id = revision[0].as_revision_id(b)
4420
 
            t = testament_class.from_revision(b.repository, rev_id)
4421
 
            if long:
4422
 
                sys.stdout.writelines(t.as_text_lines())
4423
 
            else:
4424
 
                sys.stdout.write(t.as_short_text())
4425
 
        finally:
4426
 
            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())
4427
4561
 
4428
4562
 
4429
4563
class cmd_annotate(Command):
4430
 
    """Show the origin of each line in a file.
 
4564
    __doc__ = """Show the origin of each line in a file.
4431
4565
 
4432
4566
    This prints out the given file with an annotation on the left side
4433
4567
    indicating which revision, author and date introduced the change.
4455
4589
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4456
4590
        if wt is not None:
4457
4591
            wt.lock_read()
 
4592
            self.add_cleanup(wt.unlock)
4458
4593
        else:
4459
4594
            branch.lock_read()
4460
 
        try:
4461
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4462
 
            if wt is not None:
4463
 
                file_id = wt.path2id(relpath)
4464
 
            else:
4465
 
                file_id = tree.path2id(relpath)
4466
 
            if file_id is None:
4467
 
                raise errors.NotVersionedError(filename)
4468
 
            file_version = tree.inventory[file_id].revision
4469
 
            if wt is not None and revision is None:
4470
 
                # If there is a tree and we're not annotating historical
4471
 
                # versions, annotate the working tree's content.
4472
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4473
 
                    show_ids=show_ids)
4474
 
            else:
4475
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4476
 
                              show_ids=show_ids)
4477
 
        finally:
4478
 
            if wt is not None:
4479
 
                wt.unlock()
4480
 
            else:
4481
 
                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)
4482
4614
 
4483
4615
 
4484
4616
class cmd_re_sign(Command):
4485
 
    """Create a digital signature for an existing revision."""
 
4617
    __doc__ = """Create a digital signature for an existing revision."""
4486
4618
    # TODO be able to replace existing ones.
4487
4619
 
4488
4620
    hidden = True # is this right ?
4496
4628
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4497
4629
        b = WorkingTree.open_containing(u'.')[0].branch
4498
4630
        b.lock_write()
4499
 
        try:
4500
 
            return self._run(b, revision_id_list, revision)
4501
 
        finally:
4502
 
            b.unlock()
 
4631
        self.add_cleanup(b.unlock)
 
4632
        return self._run(b, revision_id_list, revision)
4503
4633
 
4504
4634
    def _run(self, b, revision_id_list, revision):
4505
4635
        import bzrlib.gpg as gpg
4550
4680
 
4551
4681
 
4552
4682
class cmd_bind(Command):
4553
 
    """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.
4554
4685
 
4555
4686
    Once converted into a checkout, commits must succeed on the master branch
4556
4687
    before they will be applied to the local branch.
4574
4705
                    'This format does not remember old locations.')
4575
4706
            else:
4576
4707
                if location is None:
4577
 
                    raise errors.BzrCommandError('No location supplied and no '
4578
 
                        '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')
4579
4713
        b_other = Branch.open(location)
4580
4714
        try:
4581
4715
            b.bind(b_other)
4587
4721
 
4588
4722
 
4589
4723
class cmd_unbind(Command):
4590
 
    """Convert the current checkout into a regular branch.
 
4724
    __doc__ = """Convert the current checkout into a regular branch.
4591
4725
 
4592
4726
    After unbinding, the local branch is considered independent and subsequent
4593
4727
    commits will be local only.
4604
4738
 
4605
4739
 
4606
4740
class cmd_uncommit(Command):
4607
 
    """Remove the last committed revision.
 
4741
    __doc__ = """Remove the last committed revision.
4608
4742
 
4609
4743
    --verbose will print out what is being removed.
4610
4744
    --dry-run will go through all the motions, but not actually
4651
4785
 
4652
4786
        if tree is not None:
4653
4787
            tree.lock_write()
 
4788
            self.add_cleanup(tree.unlock)
4654
4789
        else:
4655
4790
            b.lock_write()
4656
 
        try:
4657
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4658
 
                             local=local)
4659
 
        finally:
4660
 
            if tree is not None:
4661
 
                tree.unlock()
4662
 
            else:
4663
 
                b.unlock()
 
4791
            self.add_cleanup(b.unlock)
 
4792
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4664
4793
 
4665
4794
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4666
4795
        from bzrlib.log import log_formatter, show_log
4698
4827
                 end_revision=last_revno)
4699
4828
 
4700
4829
        if dry_run:
4701
 
            print 'Dry-run, pretending to remove the above revisions.'
4702
 
            if not force:
4703
 
                val = raw_input('Press <enter> to continue')
 
4830
            self.outf.write('Dry-run, pretending to remove'
 
4831
                            ' the above revisions.\n')
4704
4832
        else:
4705
 
            print 'The above revision(s) will be removed.'
4706
 
            if not force:
4707
 
                val = raw_input('Are you sure [y/N]? ')
4708
 
                if val.lower() not in ('y', 'yes'):
4709
 
                    print 'Canceled'
4710
 
                    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
4711
4839
 
4712
4840
        mutter('Uncommitting from {%s} to {%s}',
4713
4841
               last_rev_id, rev_id)
4714
4842
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4715
4843
                 revno=revno, local=local)
4716
 
        note('You can restore the old tip by running:\n'
4717
 
             '  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)
4718
4846
 
4719
4847
 
4720
4848
class cmd_break_lock(Command):
4721
 
    """Break a dead lock on a repository, branch or working directory.
 
4849
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4722
4850
 
4723
4851
    CAUTION: Locks should only be broken when you are sure that the process
4724
4852
    holding the lock has been stopped.
4725
4853
 
4726
 
    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.
4727
4856
 
4728
4857
    :Examples:
4729
4858
        bzr break-lock
 
4859
        bzr break-lock bzr+ssh://example.com/bzr/foo
4730
4860
    """
4731
4861
    takes_args = ['location?']
4732
4862
 
4741
4871
 
4742
4872
 
4743
4873
class cmd_wait_until_signalled(Command):
4744
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4874
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4745
4875
 
4746
4876
    This just prints a line to signal when it is ready, then blocks on stdin.
4747
4877
    """
4755
4885
 
4756
4886
 
4757
4887
class cmd_serve(Command):
4758
 
    """Run the bzr server."""
 
4888
    __doc__ = """Run the bzr server."""
4759
4889
 
4760
4890
    aliases = ['server']
4761
4891
 
4821
4951
 
4822
4952
 
4823
4953
class cmd_join(Command):
4824
 
    """Combine a tree into its containing tree.
 
4954
    __doc__ = """Combine a tree into its containing tree.
4825
4955
 
4826
4956
    This command requires the target tree to be in a rich-root format.
4827
4957
 
4867
4997
 
4868
4998
 
4869
4999
class cmd_split(Command):
4870
 
    """Split a subdirectory of a tree into a separate tree.
 
5000
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4871
5001
 
4872
5002
    This command will produce a target tree in a format that supports
4873
5003
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4893
5023
 
4894
5024
 
4895
5025
class cmd_merge_directive(Command):
4896
 
    """Generate a merge directive for auto-merge tools.
 
5026
    __doc__ = """Generate a merge directive for auto-merge tools.
4897
5027
 
4898
5028
    A directive requests a merge to be performed, and also provides all the
4899
5029
    information necessary to do so.  This means it must either include a
4992
5122
 
4993
5123
 
4994
5124
class cmd_send(Command):
4995
 
    """Mail or create a merge-directive for submitting changes.
 
5125
    __doc__ = """Mail or create a merge-directive for submitting changes.
4996
5126
 
4997
5127
    A merge directive provides many things needed for requesting merges:
4998
5128
 
5004
5134
      directly from the merge directive, without retrieving data from a
5005
5135
      branch.
5006
5136
 
5007
 
    If --no-bundle is specified, then public_branch is needed (and must be
5008
 
    up-to-date), so that the receiver can perform the merge using the
5009
 
    public_branch.  The public_branch is always included if known, so that
5010
 
    people can check it later.
5011
 
 
5012
 
    The submit branch defaults to the parent, but can be overridden.  Both
5013
 
    submit branch and public branch will be remembered if supplied.
5014
 
 
5015
 
    If a public_branch is known for the submit_branch, that public submit
5016
 
    branch is used in the merge instructions.  This means that a local mirror
5017
 
    can be used as your actual submit branch, once you have set public_branch
5018
 
    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.
5019
5163
 
5020
5164
    Mail is sent using your preferred mail program.  This should be transparent
5021
5165
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5041
5185
 
5042
5186
    The merge directives created by bzr send may be applied using bzr merge or
5043
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.
5044
5192
    """
5045
5193
 
5046
5194
    encoding_type = 'exact'
5062
5210
               short_name='f',
5063
5211
               type=unicode),
5064
5212
        Option('output', short_name='o',
5065
 
               help='Write merge directive to this file; '
 
5213
               help='Write merge directive to this file or directory; '
5066
5214
                    'use - for stdout.',
5067
5215
               type=unicode),
5068
5216
        Option('strict',
5091
5239
 
5092
5240
 
5093
5241
class cmd_bundle_revisions(cmd_send):
5094
 
    """Create a merge-directive for submitting changes.
 
5242
    __doc__ = """Create a merge-directive for submitting changes.
5095
5243
 
5096
5244
    A merge directive provides many things needed for requesting merges:
5097
5245
 
5164
5312
 
5165
5313
 
5166
5314
class cmd_tag(Command):
5167
 
    """Create, remove or modify a tag naming a revision.
 
5315
    __doc__ = """Create, remove or modify a tag naming a revision.
5168
5316
 
5169
5317
    Tags give human-meaningful names to revisions.  Commands that take a -r
5170
5318
    (--revision) option can be given -rtag:X, where X is any previously
5178
5326
 
5179
5327
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5180
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.
5181
5334
    """
5182
5335
 
5183
5336
    _see_also = ['commit', 'tags']
5184
 
    takes_args = ['tag_name']
 
5337
    takes_args = ['tag_name?']
5185
5338
    takes_options = [
5186
5339
        Option('delete',
5187
5340
            help='Delete this tag rather than placing it.',
5197
5350
        'revision',
5198
5351
        ]
5199
5352
 
5200
 
    def run(self, tag_name,
 
5353
    def run(self, tag_name=None,
5201
5354
            delete=None,
5202
5355
            directory='.',
5203
5356
            force=None,
5205
5358
            ):
5206
5359
        branch, relpath = Branch.open_containing(directory)
5207
5360
        branch.lock_write()
5208
 
        try:
5209
 
            if delete:
5210
 
                branch.tags.delete_tag(tag_name)
5211
 
                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)
5212
5374
            else:
5213
 
                if revision:
5214
 
                    if len(revision) != 1:
5215
 
                        raise errors.BzrCommandError(
5216
 
                            "Tags can only be placed on a single revision, "
5217
 
                            "not on a range")
5218
 
                    revision_id = revision[0].as_revision_id(branch)
5219
 
                else:
5220
 
                    revision_id = branch.last_revision()
5221
 
                if (not force) and branch.tags.has_tag(tag_name):
5222
 
                    raise errors.TagAlreadyExists(tag_name)
5223
 
                branch.tags.set_tag(tag_name, revision_id)
5224
 
                self.outf.write('Created tag %s.\n' % tag_name)
5225
 
        finally:
5226
 
            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)
5227
5385
 
5228
5386
 
5229
5387
class cmd_tags(Command):
5230
 
    """List tags.
 
5388
    __doc__ = """List tags.
5231
5389
 
5232
5390
    This command shows a table of tag names and the revisions they reference.
5233
5391
    """
5262
5420
            return
5263
5421
 
5264
5422
        branch.lock_read()
5265
 
        try:
5266
 
            if revision:
5267
 
                graph = branch.repository.get_graph()
5268
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5269
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5270
 
                # only show revisions between revid1 and revid2 (inclusive)
5271
 
                tags = [(tag, revid) for tag, revid in tags if
5272
 
                    graph.is_between(revid, revid1, revid2)]
5273
 
            if sort == 'alpha':
5274
 
                tags.sort()
5275
 
            elif sort == 'time':
5276
 
                timestamps = {}
5277
 
                for tag, revid in tags:
5278
 
                    try:
5279
 
                        revobj = branch.repository.get_revision(revid)
5280
 
                    except errors.NoSuchRevision:
5281
 
                        timestamp = sys.maxint # place them at the end
5282
 
                    else:
5283
 
                        timestamp = revobj.timestamp
5284
 
                    timestamps[revid] = timestamp
5285
 
                tags.sort(key=lambda x: timestamps[x[1]])
5286
 
            if not show_ids:
5287
 
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5288
 
                for index, (tag, revid) in enumerate(tags):
5289
 
                    try:
5290
 
                        revno = branch.revision_id_to_dotted_revno(revid)
5291
 
                        if isinstance(revno, tuple):
5292
 
                            revno = '.'.join(map(str, revno))
5293
 
                    except errors.NoSuchRevision:
5294
 
                        # Bad tag data/merges can lead to tagged revisions
5295
 
                        # which are not in this branch. Fail gracefully ...
5296
 
                        revno = '?'
5297
 
                    tags[index] = (tag, revno)
5298
 
        finally:
5299
 
            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()
5300
5457
        for tag, revspec in tags:
5301
5458
            self.outf.write('%-20s %s\n' % (tag, revspec))
5302
5459
 
5303
5460
 
5304
5461
class cmd_reconfigure(Command):
5305
 
    """Reconfigure the type of a bzr directory.
 
5462
    __doc__ = """Reconfigure the type of a bzr directory.
5306
5463
 
5307
5464
    A target configuration must be specified.
5308
5465
 
5393
5550
 
5394
5551
 
5395
5552
class cmd_switch(Command):
5396
 
    """Set the branch of a checkout and update.
 
5553
    __doc__ = """Set the branch of a checkout and update.
5397
5554
 
5398
5555
    For lightweight checkouts, this changes the branch being referenced.
5399
5556
    For heavyweight checkouts, this checks that there are no local commits
5415
5572
    that of the master.
5416
5573
    """
5417
5574
 
5418
 
    takes_args = ['to_location']
 
5575
    takes_args = ['to_location?']
5419
5576
    takes_options = [Option('force',
5420
5577
                        help='Switch even if local commits will be lost.'),
 
5578
                     'revision',
5421
5579
                     Option('create-branch', short_name='b',
5422
5580
                        help='Create the target branch from this one before'
5423
5581
                             ' switching to it.'),
5424
 
                     ]
 
5582
                    ]
5425
5583
 
5426
 
    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):
5427
5586
        from bzrlib import switch
5428
5587
        tree_location = '.'
 
5588
        revision = _get_one_revision('switch', revision)
5429
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 = '.'
5430
5595
        try:
5431
5596
            branch = control_dir.open_branch()
5432
5597
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5437
5602
            if branch is None:
5438
5603
                raise errors.BzrCommandError('cannot create branch without'
5439
5604
                                             ' source branch')
 
5605
            to_location = directory_service.directories.dereference(
 
5606
                              to_location)
5440
5607
            if '/' not in to_location and '\\' not in to_location:
5441
5608
                # This path is meant to be relative to the existing branch
5442
5609
                this_url = self._get_branch_location(control_dir)
5444
5611
            to_branch = branch.bzrdir.sprout(to_location,
5445
5612
                                 possible_transports=[branch.bzrdir.root_transport],
5446
5613
                                 source_branch=branch).open_branch()
5447
 
            # try:
5448
 
            #     from_branch = control_dir.open_branch()
5449
 
            # except errors.NotBranchError:
5450
 
            #     raise BzrCommandError('Cannot create a branch from this'
5451
 
            #         ' location when we cannot open this branch')
5452
 
            # from_branch.bzrdir.sprout(
5453
 
            pass
5454
5614
        else:
5455
5615
            try:
5456
5616
                to_branch = Branch.open(to_location)
5458
5618
                this_url = self._get_branch_location(control_dir)
5459
5619
                to_branch = Branch.open(
5460
5620
                    urlutils.join(this_url, '..', to_location))
5461
 
        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)
5462
5624
        if had_explicit_nick:
5463
5625
            branch = control_dir.open_branch() #get the new branch!
5464
5626
            branch.nick = to_branch.nick
5484
5646
 
5485
5647
 
5486
5648
class cmd_view(Command):
5487
 
    """Manage filtered views.
 
5649
    __doc__ = """Manage filtered views.
5488
5650
 
5489
5651
    Views provide a mask over the tree so that users can focus on
5490
5652
    a subset of a tree when doing their work. After creating a view,
5638
5800
 
5639
5801
 
5640
5802
class cmd_hooks(Command):
5641
 
    """Show hooks."""
 
5803
    __doc__ = """Show hooks."""
5642
5804
 
5643
5805
    hidden = True
5644
5806
 
5657
5819
                    self.outf.write("    <no hooks installed>\n")
5658
5820
 
5659
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
 
5660
5847
class cmd_shelve(Command):
5661
 
    """Temporarily set aside some changes from the current tree.
 
5848
    __doc__ = """Temporarily set aside some changes from the current tree.
5662
5849
 
5663
5850
    Shelve allows you to temporarily put changes you've made "on the shelf",
5664
5851
    ie. out of the way, until a later time when you can bring them back from
5718
5905
    def run_for_list(self):
5719
5906
        tree = WorkingTree.open_containing('.')[0]
5720
5907
        tree.lock_read()
5721
 
        try:
5722
 
            manager = tree.get_shelf_manager()
5723
 
            shelves = manager.active_shelves()
5724
 
            if len(shelves) == 0:
5725
 
                note('No shelved changes.')
5726
 
                return 0
5727
 
            for shelf_id in reversed(shelves):
5728
 
                message = manager.get_metadata(shelf_id).get('message')
5729
 
                if message is None:
5730
 
                    message = '<no message>'
5731
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5732
 
            return 1
5733
 
        finally:
5734
 
            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
5735
5920
 
5736
5921
 
5737
5922
class cmd_unshelve(Command):
5738
 
    """Restore shelved changes.
 
5923
    __doc__ = """Restore shelved changes.
5739
5924
 
5740
5925
    By default, the most recently shelved changes are restored. However if you
5741
5926
    specify a shelf by id those changes will be restored instead.  This works
5749
5934
            enum_switch=False, value_switches=True,
5750
5935
            apply="Apply changes and remove from the shelf.",
5751
5936
            dry_run="Show changes, but do not apply or remove them.",
5752
 
            delete_only="Delete changes without applying them."
 
5937
            preview="Instead of unshelving the changes, show the diff that "
 
5938
                    "would result from unshelving.",
 
5939
            delete_only="Delete changes without applying them.",
 
5940
            keep="Apply changes but don't delete them.",
5753
5941
        )
5754
5942
    ]
5755
5943
    _see_also = ['shelve']
5764
5952
 
5765
5953
 
5766
5954
class cmd_clean_tree(Command):
5767
 
    """Remove unwanted files from working tree.
 
5955
    __doc__ = """Remove unwanted files from working tree.
5768
5956
 
5769
5957
    By default, only unknown files, not ignored files, are deleted.  Versioned
5770
5958
    files are never deleted.
5798
5986
 
5799
5987
 
5800
5988
class cmd_reference(Command):
5801
 
    """list, view and set branch locations for nested trees.
 
5989
    __doc__ = """list, view and set branch locations for nested trees.
5802
5990
 
5803
5991
    If no arguments are provided, lists the branch locations for nested trees.
5804
5992
    If one argument is provided, display the branch location for that tree.
5844
6032
            self.outf.write('%s %s\n' % (path, location))
5845
6033
 
5846
6034
 
5847
 
# these get imported and then picked up by the scan for cmd_*
5848
 
# TODO: Some more consistent way to split command definitions across files;
5849
 
# we do need to load at least some information about them to know of
5850
 
# aliases.  ideally we would avoid loading the implementation until the
5851
 
# details were needed.
5852
 
from bzrlib.cmd_version_info import cmd_version_info
5853
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5854
 
from bzrlib.bundle.commands import (
5855
 
    cmd_bundle_info,
5856
 
    )
5857
 
from bzrlib.foreign import cmd_dpush
5858
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5859
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5860
 
        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)