~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

NEWS section template into a separate file

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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,
35
34
    delta,
36
35
    config,
37
36
    errors,
44
43
    reconfigure,
45
44
    rename_map,
46
45
    revision as _mod_revision,
47
 
    static_tuple,
48
46
    symbol_versioning,
49
 
    timestamp,
50
47
    transport,
51
48
    ui,
52
49
    urlutils,
54
51
    )
55
52
from bzrlib.branch import Branch
56
53
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
55
from bzrlib.smtp_connection import SMTPConnection
60
56
from bzrlib.workingtree import WorkingTree
61
57
""")
62
58
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
59
from bzrlib.commands import Command, display_command
68
60
from bzrlib.option import (
69
61
    ListOption,
70
62
    Option,
239
231
# opens the branch?)
240
232
 
241
233
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
234
    """Display status summary.
243
235
 
244
236
    This reports on versioned and unknown files, reporting them
245
237
    grouped by state.  Possible states are:
265
257
    unknown
266
258
        Not versioned and not matching an ignore pattern.
267
259
 
268
 
    Additionally for directories, symlinks and files with an executable
269
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
270
 
    or '*' respectively.
271
 
 
272
260
    To see ignored files use 'bzr ignored'.  For details on the
273
261
    changes to file texts, use 'bzr diff'.
274
262
 
332
320
 
333
321
 
334
322
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
323
    """Write out metadata for a revision.
336
324
 
337
325
    The revision to print can either be specified by a specific
338
326
    revision identifier, or you can use --revision.
344
332
    # cat-revision is more for frontends so should be exact
345
333
    encoding = 'strict'
346
334
 
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
 
 
355
335
    @display_command
356
336
    def run(self, revision_id=None, revision=None):
357
337
        if revision_id is not None and revision is not None:
362
342
                                         ' --revision or a revision_id')
363
343
        b = WorkingTree.open_containing(u'.')[0].branch
364
344
 
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')
 
345
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
346
        if revision_id is not None:
 
347
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
348
            try:
 
349
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
350
            except errors.NoSuchRevision:
 
351
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
352
                    revision_id)
 
353
                raise errors.BzrCommandError(msg)
 
354
        elif revision is not None:
 
355
            for rev in revision:
 
356
                if rev is None:
 
357
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
358
                                                 ' revision.')
 
359
                rev_id = rev.as_revision_id(b)
 
360
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
361
 
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
 
        
391
362
 
392
363
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
364
    """Dump the contents of a btree index file to stdout.
394
365
 
395
366
    PATH is a btree index file, it can be any URL. This includes things like
396
367
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
431
        for node in bt.iter_all_entries():
461
432
            # Node is made up of:
462
433
            # (index, key, value, [references])
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)
469
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
 
            self.outf.write('%s\n' % (as_tuple,))
 
434
            self.outf.write('%s\n' % (node[1:],))
471
435
 
472
436
 
473
437
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
438
    """Remove the working tree from a given branch/checkout.
475
439
 
476
440
    Since a lightweight checkout is little more than a working tree
477
441
    this will refuse to run against one.
479
443
    To re-create the working tree, use "bzr checkout".
480
444
    """
481
445
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
446
    takes_args = ['location?']
483
447
    takes_options = [
484
448
        Option('force',
485
449
               help='Remove the working tree even if it has '
486
450
                    'uncommitted changes.'),
487
451
        ]
488
452
 
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()
 
453
    def run(self, location='.', force=False):
 
454
        d = bzrdir.BzrDir.open(location)
 
455
 
 
456
        try:
 
457
            working = d.open_workingtree()
 
458
        except errors.NoWorkingTree:
 
459
            raise errors.BzrCommandError("No working tree to remove")
 
460
        except errors.NotLocalUrl:
 
461
            raise errors.BzrCommandError("You cannot remove the working tree"
 
462
                                         " of a remote path")
 
463
        if not force:
 
464
            # XXX: What about pending merges ? -- vila 20090629
 
465
            if working.has_changes(working.basis_tree()):
 
466
                raise errors.UncommittedChanges(working)
 
467
 
 
468
        working_path = working.bzrdir.root_transport.base
 
469
        branch_path = working.branch.bzrdir.root_transport.base
 
470
        if working_path != branch_path:
 
471
            raise errors.BzrCommandError("You cannot remove the working tree"
 
472
                                         " from a lightweight checkout")
 
473
 
 
474
        d.destroy_workingtree()
512
475
 
513
476
 
514
477
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
478
    """Show current revision number.
516
479
 
517
480
    This is equal to the number of revisions on this branch.
518
481
    """
531
494
                wt.lock_read()
532
495
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
496
                raise errors.NoWorkingTree(location)
534
 
            self.add_cleanup(wt.unlock)
535
 
            revid = wt.last_revision()
536
497
            try:
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)
 
498
                revid = wt.last_revision()
 
499
                try:
 
500
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
501
                except errors.NoSuchRevision:
 
502
                    revno_t = ('???',)
 
503
                revno = ".".join(str(n) for n in revno_t)
 
504
            finally:
 
505
                wt.unlock()
541
506
        else:
542
507
            b = Branch.open_containing(location)[0]
543
508
            b.lock_read()
544
 
            self.add_cleanup(b.unlock)
545
 
            revno = b.revno()
546
 
        self.cleanup_now()
 
509
            try:
 
510
                revno = b.revno()
 
511
            finally:
 
512
                b.unlock()
 
513
 
547
514
        self.outf.write(str(revno) + '\n')
548
515
 
549
516
 
550
517
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
518
    """Show revision number and revision id for a given revision identifier.
552
519
    """
553
520
    hidden = True
554
521
    takes_args = ['revision_info*']
571
538
            wt = WorkingTree.open_containing(directory)[0]
572
539
            b = wt.branch
573
540
            wt.lock_read()
574
 
            self.add_cleanup(wt.unlock)
575
541
        except (errors.NoWorkingTree, errors.NotLocalUrl):
576
542
            wt = None
577
543
            b = Branch.open_containing(directory)[0]
578
544
            b.lock_read()
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())
 
545
        try:
 
546
            revision_ids = []
 
547
            if revision is not None:
 
548
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
549
            if revision_info_list is not None:
 
550
                for rev_str in revision_info_list:
 
551
                    rev_spec = RevisionSpec.from_string(rev_str)
 
552
                    revision_ids.append(rev_spec.as_revision_id(b))
 
553
            # No arguments supplied, default to the last revision
 
554
            if len(revision_ids) == 0:
 
555
                if tree:
 
556
                    if wt is None:
 
557
                        raise errors.NoWorkingTree(directory)
 
558
                    revision_ids.append(wt.last_revision())
 
559
                else:
 
560
                    revision_ids.append(b.last_revision())
 
561
 
 
562
            revinfos = []
 
563
            maxlen = 0
 
564
            for revision_id in revision_ids:
 
565
                try:
 
566
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
567
                    revno = '.'.join(str(i) for i in dotted_revno)
 
568
                except errors.NoSuchRevision:
 
569
                    revno = '???'
 
570
                maxlen = max(maxlen, len(revno))
 
571
                revinfos.append([revno, revision_id])
 
572
        finally:
 
573
            if wt is None:
 
574
                b.unlock()
593
575
            else:
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()
 
576
                wt.unlock()
 
577
 
608
578
        for ri in revinfos:
609
579
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
610
580
 
611
581
 
612
582
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
583
    """Add specified files or directories.
614
584
 
615
585
    In non-recursive mode, all the named items are added, regardless
616
586
    of whether they were previously ignored.  A warning is given if
682
652
 
683
653
        if base_tree:
684
654
            base_tree.lock_read()
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()
 
655
        try:
 
656
            file_list = self._maybe_expand_globs(file_list)
 
657
            tree, file_list = tree_files_for_add(file_list)
 
658
            added, ignored = tree.smart_add(file_list, not
 
659
                no_recurse, action=action, save=not dry_run)
 
660
        finally:
 
661
            if base_tree is not None:
 
662
                base_tree.unlock()
690
663
        if len(ignored) > 0:
691
664
            if verbose:
692
665
                for glob in sorted(ignored.keys()):
696
669
 
697
670
 
698
671
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
672
    """Create a new versioned directory.
700
673
 
701
674
    This is equivalent to creating the directory and then adding it.
702
675
    """
706
679
 
707
680
    def run(self, dir_list):
708
681
        for d in dir_list:
 
682
            os.mkdir(d)
709
683
            wt, dd = WorkingTree.open_containing(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)
 
684
            wt.add([dd])
 
685
            self.outf.write('added %s\n' % d)
718
686
 
719
687
 
720
688
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
689
    """Show path of a file relative to root"""
722
690
 
723
691
    takes_args = ['filename']
724
692
    hidden = True
733
701
 
734
702
 
735
703
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
704
    """Show inventory of the current working copy or a revision.
737
705
 
738
706
    It is possible to limit the output to a particular entry
739
707
    type using the --kind option.  For example: --kind file.
761
729
        revision = _get_one_revision('inventory', revision)
762
730
        work_tree, file_list = tree_files(file_list)
763
731
        work_tree.lock_read()
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()
 
732
        try:
 
733
            if revision is not None:
 
734
                tree = revision.as_tree(work_tree.branch)
 
735
 
 
736
                extra_trees = [work_tree]
 
737
                tree.lock_read()
 
738
            else:
 
739
                tree = work_tree
 
740
                extra_trees = []
 
741
 
 
742
            if file_list is not None:
 
743
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
744
                                          require_versioned=True)
 
745
                # find_ids_across_trees may include some paths that don't
 
746
                # exist in 'tree'.
 
747
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
748
                                 for file_id in file_ids if file_id in tree)
 
749
            else:
 
750
                entries = tree.inventory.entries()
 
751
        finally:
 
752
            tree.unlock()
 
753
            if tree is not work_tree:
 
754
                work_tree.unlock()
 
755
 
786
756
        for path, entry in entries:
787
757
            if kind and kind != entry.kind:
788
758
                continue
794
764
 
795
765
 
796
766
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
767
    """Move or rename a file.
798
768
 
799
769
    :Usage:
800
770
        bzr mv OLDNAME NEWNAME
834
804
            raise errors.BzrCommandError("missing file argument")
835
805
        tree, rel_names = tree_files(names_list, canonicalize=False)
836
806
        tree.lock_tree_write()
837
 
        self.add_cleanup(tree.unlock)
838
 
        self._run(tree, names_list, rel_names, after)
 
807
        try:
 
808
            self._run(tree, names_list, rel_names, after)
 
809
        finally:
 
810
            tree.unlock()
839
811
 
840
812
    def run_auto(self, names_list, after, dry_run):
841
813
        if names_list is not None and len(names_list) > 1:
846
818
                                         ' --auto.')
847
819
        work_tree, file_list = tree_files(names_list, default_branch='.')
848
820
        work_tree.lock_tree_write()
849
 
        self.add_cleanup(work_tree.unlock)
850
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
821
        try:
 
822
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
823
        finally:
 
824
            work_tree.unlock()
851
825
 
852
826
    def _run(self, tree, names_list, rel_names, after):
853
827
        into_existing = osutils.isdir(names_list[-1])
874
848
            # All entries reference existing inventory items, so fix them up
875
849
            # for cicp file-systems.
876
850
            rel_names = tree.get_canonical_inventory_paths(rel_names)
877
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
878
 
                if not is_quiet():
879
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
851
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
852
                self.outf.write("%s => %s\n" % pair)
880
853
        else:
881
854
            if len(names_list) != 2:
882
855
                raise errors.BzrCommandError('to mv multiple files the'
926
899
            dest = osutils.pathjoin(dest_parent, dest_tail)
927
900
            mutter("attempting to move %s => %s", src, dest)
928
901
            tree.rename_one(src, dest, after=after)
929
 
            if not is_quiet():
930
 
                self.outf.write("%s => %s\n" % (src, dest))
 
902
            self.outf.write("%s => %s\n" % (src, dest))
931
903
 
932
904
 
933
905
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
906
    """Turn this branch into a mirror of another branch.
935
907
 
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.
 
908
    This command only works on branches that have not diverged.  Branches are
 
909
    considered diverged if the destination branch's most recent commit is one
 
910
    that has not been merged (directly or indirectly) into the parent.
940
911
 
941
912
    If branches have diverged, you can use 'bzr merge' to integrate the changes
942
913
    from one into the other.  Once one branch has merged, the other should
943
914
    be able to pull it again.
944
915
 
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.
 
916
    If you want to forget your local changes and just update your branch to
 
917
    match the remote one, use pull --overwrite.
948
918
 
949
919
    If there is no default location set, the first pull will set it.  After
950
920
    that, you can omit the location to use the default.  To change the
986
956
        try:
987
957
            tree_to = WorkingTree.open_containing(directory)[0]
988
958
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
959
        except errors.NoWorkingTree:
992
960
            tree_to = None
993
961
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
996
 
 
 
962
        
997
963
        if local and not branch_to.get_bound_location():
998
964
            raise errors.LocalRequiresBoundBranch()
999
965
 
1029
995
        else:
1030
996
            branch_from = Branch.open(location,
1031
997
                possible_transports=possible_transports)
1032
 
            branch_from.lock_read()
1033
 
            self.add_cleanup(branch_from.unlock)
1034
998
 
1035
999
            if branch_to.get_parent() is None or remember:
1036
1000
                branch_to.set_parent(branch_from.base)
1037
1001
 
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)
 
1002
        if branch_from is not branch_to:
 
1003
            branch_from.lock_read()
 
1004
        try:
 
1005
            if revision is not None:
 
1006
                revision_id = revision.as_revision_id(branch_from)
 
1007
 
 
1008
            branch_to.lock_write()
 
1009
            try:
 
1010
                if tree_to is not None:
 
1011
                    view_info = _get_view_info_for_change_reporter(tree_to)
 
1012
                    change_reporter = delta._ChangeReporter(
 
1013
                        unversioned_filter=tree_to.is_ignored,
 
1014
                        view_info=view_info)
 
1015
                    result = tree_to.pull(
 
1016
                        branch_from, overwrite, revision_id, change_reporter,
 
1017
                        possible_transports=possible_transports, local=local)
 
1018
                else:
 
1019
                    result = branch_to.pull(
 
1020
                        branch_from, overwrite, revision_id, local=local)
 
1021
 
 
1022
                result.report(self.outf)
 
1023
                if verbose and result.old_revid != result.new_revid:
 
1024
                    log.show_branch_change(
 
1025
                        branch_to, self.outf, result.old_revno,
 
1026
                        result.old_revid)
 
1027
            finally:
 
1028
                branch_to.unlock()
 
1029
        finally:
 
1030
            if branch_from is not branch_to:
 
1031
                branch_from.unlock()
1058
1032
 
1059
1033
 
1060
1034
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
 
1035
    """Update a mirror of this branch.
1062
1036
 
1063
1037
    The target branch will not have its working tree populated because this
1064
1038
    is both expensive, and is not supported on remote file systems.
1125
1099
        # Get the source branch
1126
1100
        (tree, br_from,
1127
1101
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1102
        if strict is None:
 
1103
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1104
        if strict is None: strict = True # default value
1128
1105
        # Get the tip's revision_id
1129
1106
        revision = _get_one_revision('push', revision)
1130
1107
        if revision is not None:
1131
1108
            revision_id = revision.in_history(br_from).rev_id
1132
1109
        else:
1133
1110
            revision_id = None
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.')
 
1111
        if strict and tree is not None and revision_id is None:
 
1112
            if (tree.has_changes(tree.basis_tree())
 
1113
                or len(tree.get_parent_ids()) > 1):
 
1114
                raise errors.UncommittedChanges(
 
1115
                    tree, more='Use --no-strict to force the push.')
 
1116
            if tree.last_revision() != tree.branch.last_revision():
 
1117
                # The tree has lost sync with its branch, there is little
 
1118
                # chance that the user is aware of it but he can still force
 
1119
                # the push with --no-strict
 
1120
                raise errors.OutOfDateTree(
 
1121
                    tree, more='Use --no-strict to force the push.')
 
1122
 
1139
1123
        # Get the stacked_on branch, if any
1140
1124
        if stacked_on is not None:
1141
1125
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1157
 
1174
1158
 
1175
1159
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1160
    """Create a new branch that is a copy of an existing branch.
1177
1161
 
1178
1162
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1163
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1206
1190
                    ' directory exists, but does not already'
1207
1191
                    ' have a control directory.  This flag will'
1208
1192
                    ' allow branch to proceed.'),
1209
 
        Option('bind',
1210
 
            help="Bind new branch to from location."),
1211
1193
        ]
1212
1194
    aliases = ['get', 'clone']
1213
1195
 
1214
1196
    def run(self, from_location, to_location=None, revision=None,
1215
1197
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
 
1198
            use_existing_dir=False, switch=False):
1217
1199
        from bzrlib import switch as _mod_switch
1218
1200
        from bzrlib.tag import _merge_tags_if_possible
1219
1201
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
1202
            from_location)
 
1203
        if (accelerator_tree is not None and
 
1204
            accelerator_tree.supports_content_filtering()):
 
1205
            accelerator_tree = None
1221
1206
        revision = _get_one_revision('branch', revision)
1222
1207
        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)
1234
1208
        try:
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)
 
1209
            if revision is not None:
 
1210
                revision_id = revision.as_revision_id(br_from)
1240
1211
            else:
1241
 
                try:
1242
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1243
 
                except errors.NotBranchError:
1244
 
                    pass
 
1212
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1213
                # None or perhaps NULL_REVISION to mean copy nothing
 
1214
                # RBC 20060209
 
1215
                revision_id = br_from.last_revision()
 
1216
            if to_location is None:
 
1217
                to_location = urlutils.derive_to_location(from_location)
 
1218
            to_transport = transport.get_transport(to_location)
 
1219
            try:
 
1220
                to_transport.mkdir('.')
 
1221
            except errors.FileExists:
 
1222
                if not use_existing_dir:
 
1223
                    raise errors.BzrCommandError('Target directory "%s" '
 
1224
                        'already exists.' % to_location)
1245
1225
                else:
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'))
 
1226
                    try:
 
1227
                        bzrdir.BzrDir.open_from_transport(to_transport)
 
1228
                    except errors.NotBranchError:
 
1229
                        pass
 
1230
                    else:
 
1231
                        raise errors.AlreadyBranchError(to_location)
 
1232
            except errors.NoSuchFile:
 
1233
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1234
                                             % to_location)
 
1235
            try:
 
1236
                # preserve whatever source format we have.
 
1237
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1238
                                            possible_transports=[to_transport],
 
1239
                                            accelerator_tree=accelerator_tree,
 
1240
                                            hardlink=hardlink, stacked=stacked,
 
1241
                                            force_new_repo=standalone,
 
1242
                                            create_tree_if_local=not no_tree,
 
1243
                                            source_branch=br_from)
 
1244
                branch = dir.open_branch()
 
1245
            except errors.NoSuchRevision:
 
1246
                to_transport.delete_tree('.')
 
1247
                msg = "The branch %s has no revision %s." % (from_location,
 
1248
                    revision)
 
1249
                raise errors.BzrCommandError(msg)
 
1250
            _merge_tags_if_possible(br_from, branch)
 
1251
            # If the source branch is stacked, the new branch may
 
1252
            # be stacked whether we asked for that explicitly or not.
 
1253
            # We therefore need a try/except here and not just 'if stacked:'
 
1254
            try:
 
1255
                note('Created new stacked branch referring to %s.' %
 
1256
                    branch.get_stacked_on_url())
 
1257
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1258
                errors.UnstackableRepositoryFormat), e:
 
1259
                note('Branched %d revision(s).' % branch.revno())
 
1260
            if switch:
 
1261
                # Switch to the new branch
 
1262
                wt, _ = WorkingTree.open_containing('.')
 
1263
                _mod_switch.switch(wt.bzrdir, branch)
 
1264
                note('Switched to branch: %s',
 
1265
                    urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1266
        finally:
 
1267
            br_from.unlock()
1286
1268
 
1287
1269
 
1288
1270
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1271
    """Create a new checkout of an existing branch.
1290
1272
 
1291
1273
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1274
    the branch found in '.'. This is useful if you have removed the working tree
1355
1337
 
1356
1338
 
1357
1339
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1340
    """Show list of renamed files.
1359
1341
    """
1360
1342
    # TODO: Option to show renames between two historical versions.
1361
1343
 
1367
1349
    def run(self, dir=u'.'):
1368
1350
        tree = WorkingTree.open_containing(dir)[0]
1369
1351
        tree.lock_read()
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))
 
1352
        try:
 
1353
            new_inv = tree.inventory
 
1354
            old_tree = tree.basis_tree()
 
1355
            old_tree.lock_read()
 
1356
            try:
 
1357
                old_inv = old_tree.inventory
 
1358
                renames = []
 
1359
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1360
                for f, paths, c, v, p, n, k, e in iterator:
 
1361
                    if paths[0] == paths[1]:
 
1362
                        continue
 
1363
                    if None in (paths):
 
1364
                        continue
 
1365
                    renames.append(paths)
 
1366
                renames.sort()
 
1367
                for old_name, new_name in renames:
 
1368
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1369
            finally:
 
1370
                old_tree.unlock()
 
1371
        finally:
 
1372
            tree.unlock()
1387
1373
 
1388
1374
 
1389
1375
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1376
    """Update a tree to have the latest code committed to its branch.
1391
1377
 
1392
1378
    This will perform a merge into the working tree, and may generate
1393
1379
    conflicts. If you have any local changes, you will still
1395
1381
 
1396
1382
    If you want to discard your local changes, you can just do a
1397
1383
    '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.
1401
1384
    """
1402
1385
 
1403
1386
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1387
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
1406
1388
    aliases = ['up']
1407
1389
 
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")
 
1390
    def run(self, dir='.'):
1412
1391
        tree = WorkingTree.open_containing(dir)[0]
1413
 
        branch = tree.branch
1414
1392
        possible_transports = []
1415
 
        master = branch.get_master_branch(
 
1393
        master = tree.branch.get_master_branch(
1416
1394
            possible_transports=possible_transports)
1417
1395
        if master is not None:
1418
1396
            tree.lock_write()
1419
 
            branch_location = master.base
1420
1397
        else:
1421
1398
            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)
1449
1399
        try:
 
1400
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1401
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1402
            if last_rev == _mod_revision.ensure_null(
 
1403
                tree.branch.last_revision()):
 
1404
                # may be up to date, check master too.
 
1405
                if master is None or last_rev == _mod_revision.ensure_null(
 
1406
                    master.last_revision()):
 
1407
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1408
                    note("Tree is up to date at revision %d." % (revno,))
 
1409
                    return 0
 
1410
            view_info = _get_view_info_for_change_reporter(tree)
1450
1411
            conflicts = tree.update(
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
 
1412
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1413
                view_info=view_info), possible_transports=possible_transports)
 
1414
            revno = tree.branch.revision_id_to_revno(
 
1415
                _mod_revision.ensure_null(tree.last_revision()))
 
1416
            note('Updated to revision %d.' % (revno,))
 
1417
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1418
                note('Your local commits will now show as pending merges with '
 
1419
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1420
            if conflicts != 0:
 
1421
                return 1
 
1422
            else:
 
1423
                return 0
 
1424
        finally:
 
1425
            tree.unlock()
1473
1426
 
1474
1427
 
1475
1428
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1429
    """Show information about a working tree, branch or repository.
1477
1430
 
1478
1431
    This command will show all known locations and formats associated to the
1479
1432
    tree, branch or repository.
1517
1470
 
1518
1471
 
1519
1472
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1473
    """Remove files or directories.
1521
1474
 
1522
1475
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1476
    them if they can easily be recovered using revert. If no options or
1546
1499
            file_list = [f for f in file_list]
1547
1500
 
1548
1501
        tree.lock_write()
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')
 
1502
        try:
 
1503
            # Heuristics should probably all move into tree.remove_smart or
 
1504
            # some such?
 
1505
            if new:
 
1506
                added = tree.changes_from(tree.basis_tree(),
 
1507
                    specific_files=file_list).added
 
1508
                file_list = sorted([f[0] for f in added], reverse=True)
 
1509
                if len(file_list) == 0:
 
1510
                    raise errors.BzrCommandError('No matching files.')
 
1511
            elif file_list is None:
 
1512
                # missing files show up in iter_changes(basis) as
 
1513
                # versioned-with-no-kind.
 
1514
                missing = []
 
1515
                for change in tree.iter_changes(tree.basis_tree()):
 
1516
                    # Find paths in the working tree that have no kind:
 
1517
                    if change[1][1] is not None and change[6][1] is None:
 
1518
                        missing.append(change[1][1])
 
1519
                file_list = sorted(missing, reverse=True)
 
1520
                file_deletion_strategy = 'keep'
 
1521
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1522
                keep_files=file_deletion_strategy=='keep',
 
1523
                force=file_deletion_strategy=='force')
 
1524
        finally:
 
1525
            tree.unlock()
1571
1526
 
1572
1527
 
1573
1528
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1529
    """Print file_id of a particular file or directory.
1575
1530
 
1576
1531
    The file_id is assigned when the file is first added and remains the
1577
1532
    same through all revisions where the file exists, even when it is
1593
1548
 
1594
1549
 
1595
1550
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1551
    """Print path of file_ids to a file or directory.
1597
1552
 
1598
1553
    This prints one line for each directory down to the target,
1599
1554
    starting at the branch root.
1615
1570
 
1616
1571
 
1617
1572
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1573
    """Reconcile bzr metadata in a branch.
1619
1574
 
1620
1575
    This can correct data mismatches that may have been caused by
1621
1576
    previous ghost operations or bzr upgrades. You should only
1643
1598
 
1644
1599
 
1645
1600
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1601
    """Display the list of revision ids on a branch."""
1647
1602
 
1648
1603
    _see_also = ['log']
1649
1604
    takes_args = ['location?']
1659
1614
 
1660
1615
 
1661
1616
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1617
    """List all revisions merged into this branch."""
1663
1618
 
1664
1619
    _see_also = ['log', 'revision-history']
1665
1620
    takes_args = ['location?']
1684
1639
 
1685
1640
 
1686
1641
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1642
    """Make a directory into a versioned branch.
1688
1643
 
1689
1644
    Use this to create an empty branch, or before importing an
1690
1645
    existing project.
1793
1748
 
1794
1749
 
1795
1750
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1751
    """Create a shared repository to hold branches.
1797
1752
 
1798
1753
    New branches created under the repository directory will store their
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.
 
1754
    revisions in the repository, not in the branch directory.
1802
1755
 
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.
 
1756
    If the --no-trees option is used then the branches in the repository
 
1757
    will not have working trees by default.
1809
1758
 
1810
1759
    :Examples:
1811
 
        Create a shared repository holding just branches::
 
1760
        Create a shared repositories holding just branches::
1812
1761
 
1813
1762
            bzr init-repo --no-trees repo
1814
1763
            bzr init repo/trunk
1853
1802
 
1854
1803
 
1855
1804
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1805
    """Show differences in the working tree, between revisions or branches.
1857
1806
 
1858
1807
    If no arguments are given, all changes for the current tree are listed.
1859
1808
    If files are given, only the changes in those files are listed.
1880
1829
 
1881
1830
            bzr diff -r1
1882
1831
 
1883
 
        Difference between revision 3 and revision 1::
1884
 
 
1885
 
            bzr diff -r1..3
1886
 
 
1887
 
        Difference between revision 3 and revision 1 for branch xxx::
1888
 
 
1889
 
            bzr diff -r1..3 xxx
1890
 
 
1891
 
        To see the changes introduced in revision X::
1892
 
        
1893
 
            bzr diff -cX
1894
 
 
1895
 
        Note that in the case of a merge, the -c option shows the changes
1896
 
        compared to the left hand parent. To see the changes against
1897
 
        another parent, use::
1898
 
 
1899
 
            bzr diff -r<chosen_parent>..X
1900
 
 
1901
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1902
 
 
1903
 
            bzr diff -c2
 
1832
        Difference between revision 2 and revision 1::
 
1833
 
 
1834
            bzr diff -r1..2
 
1835
 
 
1836
        Difference between revision 2 and revision 1 for branch xxx::
 
1837
 
 
1838
            bzr diff -r1..2 xxx
1904
1839
 
1905
1840
        Show just the differences for file NEWS::
1906
1841
 
1945
1880
            help='Use this command to compare files.',
1946
1881
            type=unicode,
1947
1882
            ),
1948
 
        RegistryOption('format',
1949
 
            help='Diff format to use.',
1950
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
1952
1883
        ]
1953
1884
    aliases = ['di', 'dif']
1954
1885
    encoding_type = 'exact'
1955
1886
 
1956
1887
    @display_command
1957
1888
    def run(self, revision=None, file_list=None, diff_options=None,
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)
 
1889
            prefix=None, old=None, new=None, using=None):
 
1890
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1961
1891
 
1962
1892
        if (prefix is None) or (prefix == '0'):
1963
1893
            # diff -p0 format
1977
1907
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1908
                                         ' one or two revision specifiers')
1979
1909
 
1980
 
        if using is not None and format is not None:
1981
 
            raise errors.BzrCommandError('--using and --format are mutually '
1982
 
                'exclusive.')
1983
 
 
1984
 
        (old_tree, new_tree,
1985
 
         old_branch, new_branch,
1986
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1910
        old_tree, new_tree, specific_files, extra_trees = \
 
1911
                _get_trees_to_diff(file_list, revision, old, new,
 
1912
                apply_view=True)
1988
1913
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
1914
                               specific_files=specific_files,
1990
1915
                               external_diff_options=diff_options,
1991
1916
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
1993
 
                               format_cls=format)
 
1917
                               extra_trees=extra_trees, using=using)
1994
1918
 
1995
1919
 
1996
1920
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1921
    """List files deleted in the working tree.
1998
1922
    """
1999
1923
    # TODO: Show files deleted since a previous revision, or
2000
1924
    # between two revisions.
2009
1933
    def run(self, show_ids=False):
2010
1934
        tree = WorkingTree.open_containing(u'.')[0]
2011
1935
        tree.lock_read()
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')
 
1936
        try:
 
1937
            old = tree.basis_tree()
 
1938
            old.lock_read()
 
1939
            try:
 
1940
                for path, ie in old.inventory.iter_entries():
 
1941
                    if not tree.has_id(ie.file_id):
 
1942
                        self.outf.write(path)
 
1943
                        if show_ids:
 
1944
                            self.outf.write(' ')
 
1945
                            self.outf.write(ie.file_id)
 
1946
                        self.outf.write('\n')
 
1947
            finally:
 
1948
                old.unlock()
 
1949
        finally:
 
1950
            tree.unlock()
2023
1951
 
2024
1952
 
2025
1953
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
1954
    """List files modified in working tree.
2027
1955
    """
2028
1956
 
2029
1957
    hidden = True
2046
1974
 
2047
1975
 
2048
1976
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
1977
    """List files added in working tree.
2050
1978
    """
2051
1979
 
2052
1980
    hidden = True
2061
1989
    def run(self, null=False):
2062
1990
        wt = WorkingTree.open_containing(u'.')[0]
2063
1991
        wt.lock_read()
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')
 
1992
        try:
 
1993
            basis = wt.basis_tree()
 
1994
            basis.lock_read()
 
1995
            try:
 
1996
                basis_inv = basis.inventory
 
1997
                inv = wt.inventory
 
1998
                for file_id in inv:
 
1999
                    if file_id in basis_inv:
 
2000
                        continue
 
2001
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
2002
                        continue
 
2003
                    path = inv.id2path(file_id)
 
2004
                    if not os.access(osutils.abspath(path), os.F_OK):
 
2005
                        continue
 
2006
                    if null:
 
2007
                        self.outf.write(path + '\0')
 
2008
                    else:
 
2009
                        self.outf.write(osutils.quotefn(path) + '\n')
 
2010
            finally:
 
2011
                basis.unlock()
 
2012
        finally:
 
2013
            wt.unlock()
2082
2014
 
2083
2015
 
2084
2016
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
2017
    """Show the tree root directory.
2086
2018
 
2087
2019
    The root is the nearest enclosing directory with a .bzr control
2088
2020
    directory."""
2112
2044
 
2113
2045
 
2114
2046
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2047
    """Show historical log for a branch or subset of a branch.
2116
2048
 
2117
2049
    log is bzr's default tool for exploring the history of a branch.
2118
2050
    The branch to use is taken from the first parameter. If no parameters
2229
2161
    :Tips & tricks:
2230
2162
 
2231
2163
      GUI tools and IDEs are often better at exploring history than command
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>.  
 
2164
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2165
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2166
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2167
 
 
2168
      Web interfaces are often better at exploring history than command line
 
2169
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2170
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2236
2171
 
2237
2172
      You may find it useful to add the aliases below to ``bazaar.conf``::
2238
2173
 
2299
2234
                   help='Show changes made in each revision as a patch.'),
2300
2235
            Option('include-merges',
2301
2236
                   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
 
                   )
2306
2237
            ]
2307
2238
    encoding_type = 'replace'
2308
2239
 
2318
2249
            message=None,
2319
2250
            limit=None,
2320
2251
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
 
2252
            include_merges=False):
2324
2253
        from bzrlib.log import (
2325
2254
            Logger,
2326
2255
            make_log_request_dict,
2327
2256
            _get_info_for_log_files,
2328
2257
            )
2329
2258
        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')
2334
2259
        if include_merges:
2335
2260
            if levels is None:
2336
2261
                levels = 0
2349
2274
 
2350
2275
        file_ids = []
2351
2276
        filter_by_dir = False
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
 
2277
        b = None
 
2278
        try:
 
2279
            if file_list:
 
2280
                # find the file ids to log and check for directory filtering
 
2281
                b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2282
                    revision, file_list)
 
2283
                for relpath, file_id, kind in file_info_list:
 
2284
                    if file_id is None:
 
2285
                        raise errors.BzrCommandError(
 
2286
                            "Path unknown at end or start of revision range: %s" %
 
2287
                            relpath)
 
2288
                    # If the relpath is the top of the tree, we log everything
 
2289
                    if relpath == '':
 
2290
                        file_ids = []
 
2291
                        break
 
2292
                    else:
 
2293
                        file_ids.append(file_id)
 
2294
                    filter_by_dir = filter_by_dir or (
 
2295
                        kind in ['directory', 'tree-reference'])
 
2296
            else:
 
2297
                # log everything
 
2298
                # FIXME ? log the current subdir only RBC 20060203
 
2299
                if revision is not None \
 
2300
                        and len(revision) > 0 and revision[0].get_branch():
 
2301
                    location = revision[0].get_branch()
2366
2302
                else:
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)
 
2303
                    location = '.'
 
2304
                dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2305
                b = dir.open_branch()
 
2306
                b.lock_read()
 
2307
                rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2308
 
 
2309
            # Decide on the type of delta & diff filtering to use
 
2310
            # TODO: add an --all-files option to make this configurable & consistent
 
2311
            if not verbose:
 
2312
                delta_type = None
 
2313
            else:
 
2314
                delta_type = 'full'
 
2315
            if not show_diff:
 
2316
                diff_type = None
 
2317
            elif file_ids:
 
2318
                diff_type = 'partial'
 
2319
            else:
 
2320
                diff_type = 'full'
 
2321
 
 
2322
            # Build the log formatter
 
2323
            if log_format is None:
 
2324
                log_format = log.log_formatter_registry.get_default(b)
 
2325
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2326
                            show_timezone=timezone,
 
2327
                            delta_format=get_verbosity_level(),
 
2328
                            levels=levels,
 
2329
                            show_advice=levels is None)
 
2330
 
 
2331
            # Choose the algorithm for doing the logging. It's annoying
 
2332
            # having multiple code paths like this but necessary until
 
2333
            # the underlying repository format is faster at generating
 
2334
            # deltas or can provide everything we need from the indices.
 
2335
            # The default algorithm - match-using-deltas - works for
 
2336
            # multiple files and directories and is faster for small
 
2337
            # amounts of history (200 revisions say). However, it's too
 
2338
            # slow for logging a single file in a repository with deep
 
2339
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2340
            # evil when adding features", we continue to use the
 
2341
            # original algorithm - per-file-graph - for the "single
 
2342
            # file that isn't a directory without showing a delta" case.
 
2343
            partial_history = revision and b.repository._format.supports_chks
 
2344
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2345
                or delta_type or partial_history)
 
2346
 
 
2347
            # Build the LogRequest and execute it
 
2348
            if len(file_ids) == 0:
 
2349
                file_ids = None
 
2350
            rqst = make_log_request_dict(
 
2351
                direction=direction, specific_fileids=file_ids,
 
2352
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2353
                message_search=message, delta_type=delta_type,
 
2354
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2355
            Logger(b, rqst).show(lf)
 
2356
        finally:
 
2357
            if b is not None:
 
2358
                b.unlock()
2436
2359
 
2437
2360
 
2438
2361
def _get_revision_range(revisionspec_list, branch, command_name):
2456
2379
            raise errors.BzrCommandError(
2457
2380
                "bzr %s doesn't accept two revisions in different"
2458
2381
                " branches." % command_name)
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)
 
2382
        rev1 = start_spec.in_history(branch)
2464
2383
        # Avoid loading all of history when we know a missing
2465
2384
        # end of range means the last revision ...
2466
2385
        if end_spec.spec is None:
2495
2414
 
2496
2415
 
2497
2416
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2417
    """Return revision-ids which affected a particular file.
2499
2418
 
2500
2419
    A more user-friendly interface is "bzr log FILE".
2501
2420
    """
2509
2428
        file_id = tree.path2id(relpath)
2510
2429
        b = tree.branch
2511
2430
        b.lock_read()
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))
 
2431
        try:
 
2432
            touching_revs = log.find_touching_revisions(b, file_id)
 
2433
            for revno, revision_id, what in touching_revs:
 
2434
                self.outf.write("%6d %s\n" % (revno, what))
 
2435
        finally:
 
2436
            b.unlock()
2516
2437
 
2517
2438
 
2518
2439
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2440
    """List files in a tree.
2520
2441
    """
2521
2442
 
2522
2443
    _see_also = ['status', 'cat']
2570
2491
        if from_root:
2571
2492
            if relpath:
2572
2493
                prefix = relpath + '/'
2573
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2494
        elif fs_path != '.':
2574
2495
            prefix = fs_path + '/'
2575
2496
 
2576
2497
        if revision is not None or tree is None:
2585
2506
                note("Ignoring files outside view. View is %s" % view_str)
2586
2507
 
2587
2508
        tree.lock_read()
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
 
2509
        try:
 
2510
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2511
                from_dir=relpath, recursive=recursive):
 
2512
                # Apply additional masking
 
2513
                if not all and not selection[fc]:
 
2514
                    continue
 
2515
                if kind is not None and fkind != kind:
 
2516
                    continue
 
2517
                if apply_view:
 
2518
                    try:
 
2519
                        if relpath:
 
2520
                            fullpath = osutils.pathjoin(relpath, fp)
 
2521
                        else:
 
2522
                            fullpath = fp
 
2523
                        views.check_path_in_view(tree, fullpath)
 
2524
                    except errors.FileOutsideView:
 
2525
                        continue
2605
2526
 
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:
 
2527
                # Output the entry
 
2528
                if prefix:
 
2529
                    fp = osutils.pathjoin(prefix, fp)
 
2530
                kindch = entry.kind_character()
 
2531
                outstring = fp + kindch
 
2532
                ui.ui_factory.clear_term()
 
2533
                if verbose:
 
2534
                    outstring = '%-8s %s' % (fc, outstring)
 
2535
                    if show_ids and fid is not None:
 
2536
                        outstring = "%-50s %s" % (outstring, fid)
2632
2537
                    self.outf.write(outstring + '\n')
 
2538
                elif null:
 
2539
                    self.outf.write(fp + '\0')
 
2540
                    if show_ids:
 
2541
                        if fid is not None:
 
2542
                            self.outf.write(fid)
 
2543
                        self.outf.write('\0')
 
2544
                    self.outf.flush()
 
2545
                else:
 
2546
                    if show_ids:
 
2547
                        if fid is not None:
 
2548
                            my_id = fid
 
2549
                        else:
 
2550
                            my_id = ''
 
2551
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2552
                    else:
 
2553
                        self.outf.write(outstring + '\n')
 
2554
        finally:
 
2555
            tree.unlock()
2633
2556
 
2634
2557
 
2635
2558
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2559
    """List unknown files.
2637
2560
    """
2638
2561
 
2639
2562
    hidden = True
2646
2569
 
2647
2570
 
2648
2571
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2572
    """Ignore specified files or patterns.
2650
2573
 
2651
2574
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2575
 
2653
 
    If a .bzrignore file does not exist, the ignore command
2654
 
    will create one and add the specified files or patterns to the newly
2655
 
    created file. The ignore command will also automatically add the 
2656
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2657
 
    the use of the ignore command will require an explicit add command.
2658
 
 
2659
2576
    To remove patterns from the ignore list, edit the .bzrignore file.
2660
2577
    After adding, editing or deleting that file either indirectly by
2661
2578
    using this command or directly by using an editor, be sure to commit
2662
2579
    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.
2676
2580
 
2677
2581
    Note: ignore patterns containing shell wildcards must be quoted from
2678
2582
    the shell on Unix.
2682
2586
 
2683
2587
            bzr ignore ./Makefile
2684
2588
 
2685
 
        Ignore .class files in all directories...::
 
2589
        Ignore class files in all directories::
2686
2590
 
2687
2591
            bzr ignore "*.class"
2688
2592
 
2689
 
        ...but do not ignore "special.class"::
2690
 
 
2691
 
            bzr ignore "!special.class"
2692
 
 
2693
2593
        Ignore .o files under the lib directory::
2694
2594
 
2695
2595
            bzr ignore "lib/**/*.o"
2701
2601
        Ignore everything but the "debian" toplevel directory::
2702
2602
 
2703
2603
            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 "!!*~"
2711
2604
    """
2712
2605
 
2713
2606
    _see_also = ['status', 'ignored', 'patterns']
2714
2607
    takes_args = ['name_pattern*']
2715
2608
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2609
        Option('old-default-rules',
 
2610
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2611
        ]
2719
2612
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2613
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2614
        from bzrlib import ignores
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)
 
2615
        if old_default_rules is not None:
 
2616
            # dump the rules and exit
 
2617
            for pattern in ignores.OLD_DEFAULTS:
 
2618
                print pattern
2726
2619
            return
2727
2620
        if not name_pattern_list:
2728
2621
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
 
2622
                                  "NAME_PATTERN or --old-default-rules")
2730
2623
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2624
                             for p in name_pattern_list]
2732
2625
        for name_pattern in name_pattern_list:
2744
2637
            if id is not None:
2745
2638
                filename = entry[0]
2746
2639
                if ignored.match(filename):
2747
 
                    matches.append(filename)
 
2640
                    matches.append(filename.encode('utf-8'))
2748
2641
        tree.unlock()
2749
2642
        if len(matches) > 0:
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),))
 
2643
            print "Warning: the following files are version controlled and" \
 
2644
                  " match your ignore pattern:\n%s" \
 
2645
                  "\nThese files will continue to be version controlled" \
 
2646
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2754
2647
 
2755
2648
 
2756
2649
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2650
    """List ignored files and the patterns that matched them.
2758
2651
 
2759
2652
    List all the ignored files and the ignore pattern that caused the file to
2760
2653
    be ignored.
2771
2664
    def run(self):
2772
2665
        tree = WorkingTree.open_containing(u'.')[0]
2773
2666
        tree.lock_read()
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))
 
2667
        try:
 
2668
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2669
                if file_class != 'I':
 
2670
                    continue
 
2671
                ## XXX: Slightly inefficient since this was already calculated
 
2672
                pat = tree.is_ignored(path)
 
2673
                self.outf.write('%-50s %s\n' % (path, pat))
 
2674
        finally:
 
2675
            tree.unlock()
2781
2676
 
2782
2677
 
2783
2678
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2679
    """Lookup the revision-id from a revision-number
2785
2680
 
2786
2681
    :Examples:
2787
2682
        bzr lookup-revision 33
2794
2689
        try:
2795
2690
            revno = int(revno)
2796
2691
        except ValueError:
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)
 
2692
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2693
 
 
2694
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2801
2695
 
2802
2696
 
2803
2697
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2698
    """Export current or past revision to a destination directory or archive.
2805
2699
 
2806
2700
    If no revision is specified this exports the last committed revision.
2807
2701
 
2839
2733
        Option('root',
2840
2734
               type=str,
2841
2735
               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.'),
2845
2736
        ]
2846
2737
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2738
        root=None, filters=False):
2848
2739
        from bzrlib.export import export
2849
2740
 
2850
2741
        if branch_or_subdir is None:
2857
2748
 
2858
2749
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2859
2750
        try:
2860
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2861
 
                   per_file_timestamps=per_file_timestamps)
 
2751
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2862
2752
        except errors.NoSuchExportFormat, e:
2863
2753
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2864
2754
 
2865
2755
 
2866
2756
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2757
    """Write the contents of a file as of a given revision to standard output.
2868
2758
 
2869
2759
    If no revision is nominated, the last revision is used.
2870
2760
 
2891
2781
        tree, branch, relpath = \
2892
2782
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
2783
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
2895
 
        return self._run(tree, branch, relpath, filename, revision,
2896
 
                         name_from_revision, filters)
 
2784
        try:
 
2785
            return self._run(tree, branch, relpath, filename, revision,
 
2786
                             name_from_revision, filters)
 
2787
        finally:
 
2788
            branch.unlock()
2897
2789
 
2898
2790
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2899
2791
        filtered):
2900
2792
        if tree is None:
2901
2793
            tree = b.basis_tree()
2902
2794
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
2905
2795
 
2906
2796
        old_file_id = rev_tree.path2id(relpath)
2907
2797
 
2942
2832
            chunks = content.splitlines(True)
2943
2833
            content = filtered_output_bytes(chunks, filters,
2944
2834
                ContentFilterContext(relpath, rev_tree))
2945
 
            self.cleanup_now()
2946
2835
            self.outf.writelines(content)
2947
2836
        else:
2948
 
            self.cleanup_now()
2949
2837
            self.outf.write(content)
2950
2838
 
2951
2839
 
2952
2840
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2841
    """Show the offset in seconds from GMT to local time."""
2954
2842
    hidden = True
2955
2843
    @display_command
2956
2844
    def run(self):
2957
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2845
        print osutils.local_time_offset()
2958
2846
 
2959
2847
 
2960
2848
 
2961
2849
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
 
2850
    """Commit changes into a new revision.
2963
2851
 
2964
2852
    An explanatory message needs to be given for each commit. This is
2965
2853
    often done by using the --message option (getting the message from the
3058
2946
             Option('strict',
3059
2947
                    help="Refuse to commit if there are unknown "
3060
2948
                    "files in the working tree."),
3061
 
             Option('commit-time', type=str,
3062
 
                    help="Manually set a commit time using commit date "
3063
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3064
2949
             ListOption('fixes', type=str,
3065
2950
                    help="Mark a bug as being fixed by this revision "
3066
2951
                         "(see \"bzr help bugs\")."),
3073
2958
                         "the master branch until a normal commit "
3074
2959
                         "is performed."
3075
2960
                    ),
3076
 
             Option('show-diff', short_name='p',
3077
 
                    help='When no message is supplied, show the diff along'
3078
 
                    ' with the status summary in the message editor.'),
 
2961
              Option('show-diff',
 
2962
                     help='When no message is supplied, show the diff along'
 
2963
                     ' with the status summary in the message editor.'),
3079
2964
             ]
3080
2965
    aliases = ['ci', 'checkin']
3081
2966
 
3100
2985
 
3101
2986
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
2987
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2988
            author=None, show_diff=False, exclude=None):
3104
2989
        from bzrlib.errors import (
3105
2990
            PointlessCommit,
3106
2991
            ConflictsInTree,
3112
2997
            make_commit_message_template_encoded
3113
2998
        )
3114
2999
 
3115
 
        commit_stamp = offset = None
3116
 
        if commit_time is not None:
3117
 
            try:
3118
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3119
 
            except ValueError, e:
3120
 
                raise errors.BzrCommandError(
3121
 
                    "Could not parse --commit-time: " + str(e))
3122
 
 
3123
3000
        # TODO: Need a blackbox test for invoking the external editor; may be
3124
3001
        # slightly problematic to run this cross-platform.
3125
3002
 
3145
3022
        if local and not tree.branch.get_bound_location():
3146
3023
            raise errors.LocalRequiresBoundBranch()
3147
3024
 
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
 
 
3169
3025
        def get_message(commit_obj):
3170
3026
            """Callback to get commit message"""
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,
 
3027
            my_message = message
 
3028
            if my_message is None and not file:
 
3029
                t = make_commit_message_template_encoded(tree,
3180
3030
                        selected_list, diff=show_diff,
3181
3031
                        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.
3187
3032
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
 
3033
                my_message = edit_commit_message_encoded(t,
3189
3034
                    start_message=start_message)
3190
3035
                if my_message is None:
3191
3036
                    raise errors.BzrCommandError("please specify a commit"
3192
3037
                        " message with either --message or --file")
 
3038
            elif my_message and file:
 
3039
                raise errors.BzrCommandError(
 
3040
                    "please specify either --message or --file")
 
3041
            if file:
 
3042
                my_message = codecs.open(file, 'rt',
 
3043
                                         osutils.get_user_encoding()).read()
3193
3044
            if my_message == "":
3194
3045
                raise errors.BzrCommandError("empty commit message specified")
3195
3046
            return my_message
3203
3054
                        specific_files=selected_list,
3204
3055
                        allow_pointless=unchanged, strict=strict, local=local,
3205
3056
                        reporter=None, verbose=verbose, revprops=properties,
3206
 
                        authors=author, timestamp=commit_stamp,
3207
 
                        timezone=offset,
 
3057
                        authors=author,
3208
3058
                        exclude=safe_relpath_files(tree, exclude))
3209
3059
        except PointlessCommit:
 
3060
            # FIXME: This should really happen before the file is read in;
 
3061
            # perhaps prepare the commit; get the message; then actually commit
3210
3062
            raise errors.BzrCommandError("No changes to commit."
3211
3063
                              " Use --unchanged to commit anyhow.")
3212
3064
        except ConflictsInTree:
3217
3069
            raise errors.BzrCommandError("Commit refused because there are"
3218
3070
                              " unknown files in the working tree.")
3219
3071
        except errors.BoundBranchOutOfDate, e:
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
 
3072
            raise errors.BzrCommandError(str(e) + "\n"
 
3073
            'To commit to master branch, run update and then commit.\n'
 
3074
            'You can also pass --local to commit to continue working '
 
3075
            'disconnected.')
3225
3076
 
3226
3077
 
3227
3078
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3079
    """Validate working tree structure, branch consistency and repository history.
3229
3080
 
3230
3081
    This command checks various invariants about branch and repository storage
3231
3082
    to detect data corruption or bzr bugs.
3295
3146
 
3296
3147
 
3297
3148
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
3149
    """Upgrade branch storage to current format.
3299
3150
 
3300
3151
    The check command or bzr developers may sometimes advise you to run
3301
3152
    this command. When the default format has changed you may also be warned
3319
3170
 
3320
3171
 
3321
3172
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
 
3173
    """Show or set bzr user id.
3323
3174
 
3324
3175
    :Examples:
3325
3176
        Show the email of the current user::
3369
3220
 
3370
3221
 
3371
3222
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
3223
    """Print or set the branch nickname.
3373
3224
 
3374
3225
    If unset, the tree root directory name is used as the nickname.
3375
3226
    To print the current nickname, execute with no argument.
3389
3240
 
3390
3241
    @display_command
3391
3242
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
3243
        print branch.nick
3393
3244
 
3394
3245
 
3395
3246
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3247
    """Set/unset and display aliases.
3397
3248
 
3398
3249
    :Examples:
3399
3250
        Show the current aliases::
3463
3314
 
3464
3315
 
3465
3316
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3317
    """Run internal test suite.
3467
3318
 
3468
3319
    If arguments are given, they are regular expressions that say which tests
3469
3320
    should run.  Tests matching any expression are run, and other tests are
3496
3347
    Tests that need working space on disk use a common temporary directory,
3497
3348
    typically inside $TMPDIR or /tmp.
3498
3349
 
3499
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
 
    into a pdb postmortem session.
3501
 
 
3502
3350
    :Examples:
3503
3351
        Run only tests relating to 'ignore'::
3504
3352
 
3513
3361
    def get_transport_type(typestring):
3514
3362
        """Parse and return a transport specifier."""
3515
3363
        if typestring == "sftp":
3516
 
            from bzrlib.tests import stub_sftp
3517
 
            return stub_sftp.SFTPAbsoluteServer
 
3364
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3365
            return SFTPAbsoluteServer
3518
3366
        if typestring == "memory":
3519
 
            from bzrlib.tests import test_server
3520
 
            return memory.MemoryServer
 
3367
            from bzrlib.transport.memory import MemoryServer
 
3368
            return MemoryServer
3521
3369
        if typestring == "fakenfs":
3522
 
            from bzrlib.tests import test_server
3523
 
            return test_server.FakeNFSServer
 
3370
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3371
            return FakeNFSServer
3524
3372
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
3373
            (typestring)
3526
3374
        raise errors.BzrCommandError(msg)
3541
3389
                     Option('lsprof-timed',
3542
3390
                            help='Generate lsprof output for benchmarked'
3543
3391
                                 ' sections of code.'),
3544
 
                     Option('lsprof-tests',
3545
 
                            help='Generate lsprof output for each test.'),
3546
3392
                     Option('cache-dir', type=str,
3547
3393
                            help='Cache intermediate benchmark output in this '
3548
3394
                                 'directory.'),
3589
3435
            first=False, list_only=False,
3590
3436
            randomize=None, exclude=None, strict=False,
3591
3437
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
 
            parallel=None, lsprof_tests=False):
 
3438
            parallel=None):
3593
3439
        from bzrlib.tests import selftest
3594
3440
        import bzrlib.benchmarks as benchmarks
3595
3441
        from bzrlib.benchmarks import tree_creator
3610
3456
                raise errors.BzrCommandError("subunit not available. subunit "
3611
3457
                    "needs to be installed to use --subunit.")
3612
3458
            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)
3618
3459
        if parallel:
3619
3460
            self.additional_selftest_args.setdefault(
3620
3461
                'suite_decorators', []).append(parallel)
3624
3465
            verbose = not is_quiet()
3625
3466
            # TODO: should possibly lock the history file...
3626
3467
            benchfile = open(".perf_history", "at", buffering=1)
3627
 
            self.add_cleanup(benchfile.close)
3628
3468
        else:
3629
3469
            test_suite_factory = None
3630
3470
            benchfile = None
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)
 
3471
        try:
 
3472
            selftest_kwargs = {"verbose": verbose,
 
3473
                              "pattern": pattern,
 
3474
                              "stop_on_failure": one,
 
3475
                              "transport": transport,
 
3476
                              "test_suite_factory": test_suite_factory,
 
3477
                              "lsprof_timed": lsprof_timed,
 
3478
                              "bench_history": benchfile,
 
3479
                              "matching_tests_first": first,
 
3480
                              "list_only": list_only,
 
3481
                              "random_seed": randomize,
 
3482
                              "exclude_pattern": exclude,
 
3483
                              "strict": strict,
 
3484
                              "load_list": load_list,
 
3485
                              "debug_flags": debugflag,
 
3486
                              "starting_with": starting_with
 
3487
                              }
 
3488
            selftest_kwargs.update(self.additional_selftest_args)
 
3489
            result = selftest(**selftest_kwargs)
 
3490
        finally:
 
3491
            if benchfile is not None:
 
3492
                benchfile.close()
3650
3493
        return int(not result)
3651
3494
 
3652
3495
 
3653
3496
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3497
    """Show version of bzr."""
3655
3498
 
3656
3499
    encoding_type = 'replace'
3657
3500
    takes_options = [
3668
3511
 
3669
3512
 
3670
3513
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3514
    """Statement of optimism."""
3672
3515
 
3673
3516
    hidden = True
3674
3517
 
3675
3518
    @display_command
3676
3519
    def run(self):
3677
 
        self.outf.write("It sure does!\n")
 
3520
        print "It sure does!"
3678
3521
 
3679
3522
 
3680
3523
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3524
    """Find and print a base revision for merging two branches."""
3682
3525
    # TODO: Options to specify revisions on either side, as if
3683
3526
    #       merging only part of the history.
3684
3527
    takes_args = ['branch', 'other']
3691
3534
        branch1 = Branch.open_containing(branch)[0]
3692
3535
        branch2 = Branch.open_containing(other)[0]
3693
3536
        branch1.lock_read()
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)
 
3537
        try:
 
3538
            branch2.lock_read()
 
3539
            try:
 
3540
                last1 = ensure_null(branch1.last_revision())
 
3541
                last2 = ensure_null(branch2.last_revision())
 
3542
 
 
3543
                graph = branch1.repository.get_graph(branch2.repository)
 
3544
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3545
 
 
3546
                print 'merge base is revision %s' % base_rev_id
 
3547
            finally:
 
3548
                branch2.unlock()
 
3549
        finally:
 
3550
            branch1.unlock()
3704
3551
 
3705
3552
 
3706
3553
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
 
3554
    """Perform a three-way merge.
3708
3555
 
3709
3556
    The source of the merge can be specified either in the form of a branch,
3710
3557
    or in the form of a path to a file containing a merge directive generated
3739
3586
    committed to record the result of the merge.
3740
3587
 
3741
3588
    merge refuses to run if there are any uncommitted changes, unless
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.
 
3589
    --force is given.
3748
3590
 
3749
3591
    To select only some changes to merge, use "merge -i", which will prompt
3750
3592
    you to apply each diff hunk and file change, similar to "shelve".
3762
3604
 
3763
3605
            bzr merge -r 81..82 ../bzr.dev
3764
3606
 
3765
 
        To apply a merge directive contained in /tmp/merge::
 
3607
        To apply a merge directive contained in /tmp/merge:
3766
3608
 
3767
3609
            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'
3775
3610
    """
3776
3611
 
3777
3612
    encoding_type = 'exact'
3822
3657
        verified = 'inapplicable'
3823
3658
        tree = WorkingTree.open_containing(directory)[0]
3824
3659
 
 
3660
        # die as quickly as possible if there are uncommitted changes
3825
3661
        try:
3826
3662
            basis_tree = tree.revision_tree(tree.last_revision())
3827
3663
        except errors.NoSuchRevision:
3828
3664
            basis_tree = tree.basis_tree()
3829
 
 
3830
 
        # die as quickly as possible if there are uncommitted changes
3831
3665
        if not force:
3832
 
            if tree.has_changes():
 
3666
            if tree.has_changes(basis_tree):
3833
3667
                raise errors.UncommittedChanges(tree)
3834
3668
 
3835
3669
        view_info = _get_view_info_for_change_reporter(tree)
3836
3670
        change_reporter = delta._ChangeReporter(
3837
3671
            unversioned_filter=tree.is_ignored, view_info=view_info)
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
 
3672
        cleanups = []
 
3673
        try:
 
3674
            pb = ui.ui_factory.nested_progress_bar()
 
3675
            cleanups.append(pb.finished)
 
3676
            tree.lock_write()
 
3677
            cleanups.append(tree.unlock)
 
3678
            if location is not None:
 
3679
                try:
 
3680
                    mergeable = bundle.read_mergeable_from_url(location,
 
3681
                        possible_transports=possible_transports)
 
3682
                except errors.NotABundle:
 
3683
                    mergeable = None
 
3684
                else:
 
3685
                    if uncommitted:
 
3686
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3687
                            ' with bundles or merge directives.')
 
3688
 
 
3689
                    if revision is not None:
 
3690
                        raise errors.BzrCommandError(
 
3691
                            'Cannot use -r with merge directives or bundles')
 
3692
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3693
                       mergeable, pb)
 
3694
 
 
3695
            if merger is None and uncommitted:
 
3696
                if revision is not None and len(revision) > 0:
 
3697
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3698
                        ' --revision at the same time.')
 
3699
                merger = self.get_merger_from_uncommitted(tree, location, pb,
 
3700
                                                          cleanups)
 
3701
                allow_pending = False
 
3702
 
 
3703
            if merger is None:
 
3704
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3705
                    location, revision, remember, possible_transports, pb)
 
3706
 
 
3707
            merger.merge_type = merge_type
 
3708
            merger.reprocess = reprocess
 
3709
            merger.show_base = show_base
 
3710
            self.sanity_check_merger(merger)
 
3711
            if (merger.base_rev_id == merger.other_rev_id and
 
3712
                merger.other_rev_id is not None):
 
3713
                note('Nothing to do.')
 
3714
                return 0
 
3715
            if pull:
 
3716
                if merger.interesting_files is not None:
 
3717
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3718
                if (merger.base_rev_id == tree.last_revision()):
 
3719
                    result = tree.pull(merger.other_branch, False,
 
3720
                                       merger.other_rev_id)
 
3721
                    result.report(self.outf)
 
3722
                    return 0
 
3723
            merger.check_basis(False)
 
3724
            if preview:
 
3725
                return self._do_preview(merger, cleanups)
 
3726
            elif interactive:
 
3727
                return self._do_interactive(merger, cleanups)
3848
3728
            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)
3885
 
                return 0
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)
3897
 
 
3898
 
    def _get_preview(self, merger):
 
3729
                return self._do_merge(merger, change_reporter, allow_pending,
 
3730
                                      verified)
 
3731
        finally:
 
3732
            for cleanup in reversed(cleanups):
 
3733
                cleanup()
 
3734
 
 
3735
    def _get_preview(self, merger, cleanups):
3899
3736
        tree_merger = merger.make_merger()
3900
3737
        tt = tree_merger.make_preview_transform()
3901
 
        self.add_cleanup(tt.finalize)
 
3738
        cleanups.append(tt.finalize)
3902
3739
        result_tree = tt.get_preview_tree()
3903
3740
        return result_tree
3904
3741
 
3905
 
    def _do_preview(self, merger):
 
3742
    def _do_preview(self, merger, cleanups):
3906
3743
        from bzrlib.diff import show_diff_trees
3907
 
        result_tree = self._get_preview(merger)
 
3744
        result_tree = self._get_preview(merger, cleanups)
3908
3745
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
3746
                        old_label='', new_label='')
3910
3747
 
3920
3757
        else:
3921
3758
            return 0
3922
3759
 
3923
 
    def _do_interactive(self, merger):
 
3760
    def _do_interactive(self, merger, cleanups):
3924
3761
        """Perform an interactive merge.
3925
3762
 
3926
3763
        This works by generating a preview tree of the merge, then using
3928
3765
        and the preview tree.
3929
3766
        """
3930
3767
        from bzrlib import shelf_ui
3931
 
        result_tree = self._get_preview(merger)
 
3768
        result_tree = self._get_preview(merger, cleanups)
3932
3769
        writer = bzrlib.option.diff_writer_registry.get()
3933
3770
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3934
3771
                                   reporter=shelf_ui.ApplyReporter(),
3935
3772
                                   diff_writer=writer(sys.stdout))
3936
 
        try:
3937
 
            shelver.run()
3938
 
        finally:
3939
 
            shelver.finalize()
 
3773
        shelver.run()
3940
3774
 
3941
3775
    def sanity_check_merger(self, merger):
3942
3776
        if (merger.show_base and
4002
3836
            allow_pending = True
4003
3837
        return merger, allow_pending
4004
3838
 
4005
 
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3839
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
4006
3840
        """Get a merger for uncommitted changes.
4007
3841
 
4008
3842
        :param tree: The tree the merger should apply to.
4009
3843
        :param location: The location containing uncommitted changes.
4010
3844
        :param pb: The progress bar to use for showing progress.
 
3845
        :param cleanups: A list of operations to perform to clean up the
 
3846
            temporary directories, unfinalized objects, etc.
4011
3847
        """
4012
3848
        location = self._select_branch_location(tree, location)[0]
4013
3849
        other_tree, other_path = WorkingTree.open_containing(location)
4065
3901
 
4066
3902
 
4067
3903
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
3904
    """Redo a merge.
4069
3905
 
4070
3906
    Use this if you want to try a different merge technique while resolving
4071
3907
    conflicts.  Some merge techniques are better than others, and remerge
4096
3932
 
4097
3933
    def run(self, file_list=None, merge_type=None, show_base=False,
4098
3934
            reprocess=False):
4099
 
        from bzrlib.conflicts import restore
4100
3935
        if merge_type is None:
4101
3936
            merge_type = _mod_merge.Merge3Merger
4102
3937
        tree, file_list = tree_files(file_list)
4103
3938
        tree.lock_write()
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
 
3939
        try:
 
3940
            parents = tree.get_parent_ids()
 
3941
            if len(parents) != 2:
 
3942
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3943
                                             " merges.  Not cherrypicking or"
 
3944
                                             " multi-merges.")
 
3945
            repository = tree.branch.repository
 
3946
            interesting_ids = None
 
3947
            new_conflicts = []
 
3948
            conflicts = tree.conflicts()
 
3949
            if file_list is not None:
 
3950
                interesting_ids = set()
 
3951
                for filename in file_list:
 
3952
                    file_id = tree.path2id(filename)
 
3953
                    if file_id is None:
 
3954
                        raise errors.NotVersionedError(filename)
 
3955
                    interesting_ids.add(file_id)
 
3956
                    if tree.kind(file_id) != "directory":
 
3957
                        continue
4123
3958
 
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:
 
3959
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3960
                        interesting_ids.add(ie.file_id)
 
3961
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3962
            else:
 
3963
                # Remerge only supports resolving contents conflicts
 
3964
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3965
                restore_files = [c.path for c in conflicts
 
3966
                                 if c.typestring in allowed_conflicts]
 
3967
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3968
            tree.set_conflicts(ConflictList(new_conflicts))
 
3969
            if file_list is not None:
 
3970
                restore_files = file_list
 
3971
            for filename in restore_files:
 
3972
                try:
 
3973
                    restore(tree.abspath(filename))
 
3974
                except errors.NotConflicted:
 
3975
                    pass
 
3976
            # Disable pending merges, because the file texts we are remerging
 
3977
            # have not had those merges performed.  If we use the wrong parents
 
3978
            # list, we imply that the working tree text has seen and rejected
 
3979
            # all the changes from the other tree, when in fact those changes
 
3980
            # have not yet been seen.
 
3981
            pb = ui.ui_factory.nested_progress_bar()
 
3982
            tree.set_parent_ids(parents[:1])
4137
3983
            try:
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()
 
3984
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3985
                                                             tree, parents[1])
 
3986
                merger.interesting_ids = interesting_ids
 
3987
                merger.merge_type = merge_type
 
3988
                merger.show_base = show_base
 
3989
                merger.reprocess = reprocess
 
3990
                conflicts = merger.do_merge()
 
3991
            finally:
 
3992
                tree.set_parent_ids(parents)
 
3993
                pb.finished()
4154
3994
        finally:
4155
 
            tree.set_parent_ids(parents)
 
3995
            tree.unlock()
4156
3996
        if conflicts > 0:
4157
3997
            return 1
4158
3998
        else:
4160
4000
 
4161
4001
 
4162
4002
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
4003
    """Revert files to a previous revision.
4164
4004
 
4165
4005
    Giving a list of files will revert only those files.  Otherwise, all files
4166
4006
    will be reverted.  If the revision is not specified with '--revision', the
4180
4020
    name.  If you name a directory, all the contents of that directory will be
4181
4021
    reverted.
4182
4022
 
4183
 
    If you have newly added files since the target revision, they will be
4184
 
    removed.  If the files to be removed have been changed, backups will be
4185
 
    created as above.  Directories containing unknown files will not be
4186
 
    deleted.
 
4023
    Any files that have been newly added since that revision will be deleted,
 
4024
    with a backup kept if appropriate.  Directories containing unknown files
 
4025
    will not be deleted.
4187
4026
 
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
 
4027
    The working tree contains a list of pending merged revisions, which will
 
4028
    be included as parents in the next commit.  Normally, revert clears that
 
4029
    list as well as reverting the files.  If any files are specified, revert
 
4030
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4031
    revert ." in the tree root to revert all files but keep the merge record,
 
4032
    and "bzr revert --forget-merges" to clear the pending merge list without
4195
4033
    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.
4206
4034
    """
4207
4035
 
4208
4036
    _see_also = ['cat', 'export']
4217
4045
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4046
            forget_merges=None):
4219
4047
        tree, file_list = tree_files(file_list)
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)
 
4048
        tree.lock_write()
 
4049
        try:
 
4050
            if forget_merges:
 
4051
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4052
            else:
 
4053
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4054
        finally:
 
4055
            tree.unlock()
4226
4056
 
4227
4057
    @staticmethod
4228
4058
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4229
4059
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4230
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4231
 
            report_changes=True)
 
4060
        pb = ui.ui_factory.nested_progress_bar()
 
4061
        try:
 
4062
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4063
                report_changes=True)
 
4064
        finally:
 
4065
            pb.finished()
4232
4066
 
4233
4067
 
4234
4068
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
4069
    """Test reporting of assertion failures"""
4236
4070
    # intended just for use in testing
4237
4071
 
4238
4072
    hidden = True
4242
4076
 
4243
4077
 
4244
4078
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
4079
    """Show help on a command or other topic.
4246
4080
    """
4247
4081
 
4248
4082
    _see_also = ['topics']
4261
4095
 
4262
4096
 
4263
4097
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
4098
    """Show appropriate completions for context.
4265
4099
 
4266
4100
    For a list of all available commands, say 'bzr shell-complete'.
4267
4101
    """
4276
4110
 
4277
4111
 
4278
4112
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4113
    """Show unmerged/unpulled revisions between two branches.
4280
4114
 
4281
4115
    OTHER_BRANCH may be local or remote.
4282
4116
 
4283
4117
    To filter on a range of revisions, you can use the command -r begin..end
4284
4118
    -r revision requests a specific revision, -r ..end or -r begin.. are
4285
4119
    also valid.
4286
 
            
4287
 
    :Exit values:
4288
 
        1 - some missing revisions
4289
 
        0 - no missing revisions
4290
4120
 
4291
4121
    :Examples:
4292
4122
 
4360
4190
            restrict = 'remote'
4361
4191
 
4362
4192
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
4193
        parent = local_branch.get_parent()
4367
4194
        if other_branch is None:
4368
4195
            other_branch = parent
4377
4204
        remote_branch = Branch.open(other_branch)
4378
4205
        if remote_branch.base == local_branch.base:
4379
4206
            remote_branch = local_branch
4380
 
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
4383
4207
 
4384
4208
        local_revid_range = _revision_range_to_revid_range(
4385
4209
            _get_revision_range(my_revision, local_branch,
4389
4213
            _get_revision_range(revision,
4390
4214
                remote_branch, self.name()))
4391
4215
 
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()
 
4216
        local_branch.lock_read()
 
4217
        try:
 
4218
            remote_branch.lock_read()
 
4219
            try:
 
4220
                local_extra, remote_extra = find_unmerged(
 
4221
                    local_branch, remote_branch, restrict,
 
4222
                    backward=not reverse,
 
4223
                    include_merges=include_merges,
 
4224
                    local_revid_range=local_revid_range,
 
4225
                    remote_revid_range=remote_revid_range)
 
4226
 
 
4227
                if log_format is None:
 
4228
                    registry = log.log_formatter_registry
 
4229
                    log_format = registry.get_default(local_branch)
 
4230
                lf = log_format(to_file=self.outf,
 
4231
                                show_ids=show_ids,
 
4232
                                show_timezone='original')
 
4233
 
 
4234
                status_code = 0
 
4235
                if local_extra and not theirs_only:
 
4236
                    message("You have %d extra revision(s):\n" %
 
4237
                        len(local_extra))
 
4238
                    for revision in iter_log_revisions(local_extra,
 
4239
                                        local_branch.repository,
 
4240
                                        verbose):
 
4241
                        lf.log_revision(revision)
 
4242
                    printed_local = True
 
4243
                    status_code = 1
 
4244
                else:
 
4245
                    printed_local = False
 
4246
 
 
4247
                if remote_extra and not mine_only:
 
4248
                    if printed_local is True:
 
4249
                        message("\n\n\n")
 
4250
                    message("You are missing %d revision(s):\n" %
 
4251
                        len(remote_extra))
 
4252
                    for revision in iter_log_revisions(remote_extra,
 
4253
                                        remote_branch.repository,
 
4254
                                        verbose):
 
4255
                        lf.log_revision(revision)
 
4256
                    status_code = 1
 
4257
 
 
4258
                if mine_only and not local_extra:
 
4259
                    # We checked local, and found nothing extra
 
4260
                    message('This branch is up to date.\n')
 
4261
                elif theirs_only and not remote_extra:
 
4262
                    # We checked remote, and found nothing extra
 
4263
                    message('Other branch is up to date.\n')
 
4264
                elif not (mine_only or theirs_only or local_extra or
 
4265
                          remote_extra):
 
4266
                    # We checked both branches, and neither one had extra
 
4267
                    # revisions
 
4268
                    message("Branches are up to date.\n")
 
4269
            finally:
 
4270
                remote_branch.unlock()
 
4271
        finally:
 
4272
            local_branch.unlock()
4442
4273
        if not status_code and parent is None and other_branch is not None:
4443
4274
            local_branch.lock_write()
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)
 
4275
            try:
 
4276
                # handle race conditions - a parent might be set while we run.
 
4277
                if local_branch.get_parent() is None:
 
4278
                    local_branch.set_parent(remote_branch.base)
 
4279
            finally:
 
4280
                local_branch.unlock()
4448
4281
        return status_code
4449
4282
 
4450
4283
 
4451
4284
class cmd_pack(Command):
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
 
    """
 
4285
    """Compress the data within a repository."""
4469
4286
 
4470
4287
    _see_also = ['repositories']
4471
4288
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
4289
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4290
    def run(self, branch_or_repo='.'):
4477
4291
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
4292
        try:
4479
4293
            branch = dir.open_branch()
4480
4294
            repository = branch.repository
4481
4295
        except errors.NotBranchError:
4482
4296
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4297
        repository.pack()
4484
4298
 
4485
4299
 
4486
4300
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
 
4301
    """List the installed plugins.
4488
4302
 
4489
4303
    This command displays the list of installed plugins including
4490
4304
    version of plugin and a short description of each.
4497
4311
    adding new commands, providing additional network transports and
4498
4312
    customizing log output.
4499
4313
 
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.
 
4314
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4315
    information on plugins including where to find them and how to
 
4316
    install them. Instructions are also provided there on how to
 
4317
    write new plugins using the Python programming language.
4504
4318
    """
4505
4319
    takes_options = ['verbose']
4506
4320
 
4521
4335
                doc = '(no description)'
4522
4336
            result.append((name_ver, doc, plugin.path()))
4523
4337
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
 
4338
            print name_ver
 
4339
            print '   ', doc
4526
4340
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
4341
                print '   ', path
 
4342
            print
4529
4343
 
4530
4344
 
4531
4345
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4346
    """Show testament (signing-form) of a revision."""
4533
4347
    takes_options = [
4534
4348
            'revision',
4535
4349
            Option('long', help='Produce long-format testament.'),
4548
4362
        else:
4549
4363
            b = Branch.open(branch)
4550
4364
        b.lock_read()
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())
 
4365
        try:
 
4366
            if revision is None:
 
4367
                rev_id = b.last_revision()
 
4368
            else:
 
4369
                rev_id = revision[0].as_revision_id(b)
 
4370
            t = testament_class.from_revision(b.repository, rev_id)
 
4371
            if long:
 
4372
                sys.stdout.writelines(t.as_text_lines())
 
4373
            else:
 
4374
                sys.stdout.write(t.as_short_text())
 
4375
        finally:
 
4376
            b.unlock()
4561
4377
 
4562
4378
 
4563
4379
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4380
    """Show the origin of each line in a file.
4565
4381
 
4566
4382
    This prints out the given file with an annotation on the left side
4567
4383
    indicating which revision, author and date introduced the change.
4589
4405
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4590
4406
        if wt is not None:
4591
4407
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
4593
4408
        else:
4594
4409
            branch.lock_read()
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)
 
4410
        try:
 
4411
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4412
            tree.lock_read()
 
4413
            try:
 
4414
                if wt is not None:
 
4415
                    file_id = wt.path2id(relpath)
 
4416
                else:
 
4417
                    file_id = tree.path2id(relpath)
 
4418
                if file_id is None:
 
4419
                    raise errors.NotVersionedError(filename)
 
4420
                file_version = tree.inventory[file_id].revision
 
4421
                if wt is not None and revision is None:
 
4422
                    # If there is a tree and we're not annotating historical
 
4423
                    # versions, annotate the working tree's content.
 
4424
                    annotate_file_tree(wt, file_id, self.outf, long, all,
 
4425
                        show_ids=show_ids)
 
4426
                else:
 
4427
                    annotate_file(branch, file_version, file_id, long, all,
 
4428
                        self.outf, show_ids=show_ids)
 
4429
            finally:
 
4430
                tree.unlock()
 
4431
        finally:
 
4432
            if wt is not None:
 
4433
                wt.unlock()
 
4434
            else:
 
4435
                branch.unlock()
4614
4436
 
4615
4437
 
4616
4438
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4439
    """Create a digital signature for an existing revision."""
4618
4440
    # TODO be able to replace existing ones.
4619
4441
 
4620
4442
    hidden = True # is this right ?
4628
4450
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4629
4451
        b = WorkingTree.open_containing(u'.')[0].branch
4630
4452
        b.lock_write()
4631
 
        self.add_cleanup(b.unlock)
4632
 
        return self._run(b, revision_id_list, revision)
 
4453
        try:
 
4454
            return self._run(b, revision_id_list, revision)
 
4455
        finally:
 
4456
            b.unlock()
4633
4457
 
4634
4458
    def _run(self, b, revision_id_list, revision):
4635
4459
        import bzrlib.gpg as gpg
4680
4504
 
4681
4505
 
4682
4506
class cmd_bind(Command):
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.
 
4507
    """Convert the current branch into a checkout of the supplied branch.
4685
4508
 
4686
4509
    Once converted into a checkout, commits must succeed on the master branch
4687
4510
    before they will be applied to the local branch.
4688
4511
 
4689
4512
    Bound branches use the nickname of its master branch unless it is set
4690
 
    locally, in which case binding will update the local nickname to be
 
4513
    locally, in which case binding will update the the local nickname to be
4691
4514
    that of the master.
4692
4515
    """
4693
4516
 
4705
4528
                    'This format does not remember old locations.')
4706
4529
            else:
4707
4530
                if location is None:
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')
 
4531
                    raise errors.BzrCommandError('No location supplied and no '
 
4532
                        'previous location known')
4713
4533
        b_other = Branch.open(location)
4714
4534
        try:
4715
4535
            b.bind(b_other)
4721
4541
 
4722
4542
 
4723
4543
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4544
    """Convert the current checkout into a regular branch.
4725
4545
 
4726
4546
    After unbinding, the local branch is considered independent and subsequent
4727
4547
    commits will be local only.
4738
4558
 
4739
4559
 
4740
4560
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4561
    """Remove the last committed revision.
4742
4562
 
4743
4563
    --verbose will print out what is being removed.
4744
4564
    --dry-run will go through all the motions, but not actually
4785
4605
 
4786
4606
        if tree is not None:
4787
4607
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
4789
4608
        else:
4790
4609
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
4792
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4610
        try:
 
4611
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4612
                             local=local)
 
4613
        finally:
 
4614
            if tree is not None:
 
4615
                tree.unlock()
 
4616
            else:
 
4617
                b.unlock()
4793
4618
 
4794
4619
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4795
4620
        from bzrlib.log import log_formatter, show_log
4827
4652
                 end_revision=last_revno)
4828
4653
 
4829
4654
        if dry_run:
4830
 
            self.outf.write('Dry-run, pretending to remove'
4831
 
                            ' the above revisions.\n')
 
4655
            print 'Dry-run, pretending to remove the above revisions.'
 
4656
            if not force:
 
4657
                val = raw_input('Press <enter> to continue')
4832
4658
        else:
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
 
4659
            print 'The above revision(s) will be removed.'
 
4660
            if not force:
 
4661
                val = raw_input('Are you sure [y/N]? ')
 
4662
                if val.lower() not in ('y', 'yes'):
 
4663
                    print 'Canceled'
 
4664
                    return 0
4839
4665
 
4840
4666
        mutter('Uncommitting from {%s} to {%s}',
4841
4667
               last_rev_id, rev_id)
4842
4668
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4843
4669
                 revno=revno, local=local)
4844
 
        self.outf.write('You can restore the old tip by running:\n'
4845
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4670
        note('You can restore the old tip by running:\n'
 
4671
             '  bzr pull . -r revid:%s', last_rev_id)
4846
4672
 
4847
4673
 
4848
4674
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4675
    """Break a dead lock on a repository, branch or working directory.
4850
4676
 
4851
4677
    CAUTION: Locks should only be broken when you are sure that the process
4852
4678
    holding the lock has been stopped.
4853
4679
 
4854
 
    You can get information on what locks are open via the 'bzr info
4855
 
    [location]' command.
 
4680
    You can get information on what locks are open via the 'bzr info' command.
4856
4681
 
4857
4682
    :Examples:
4858
4683
        bzr break-lock
4859
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4860
4684
    """
4861
4685
    takes_args = ['location?']
4862
4686
 
4871
4695
 
4872
4696
 
4873
4697
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4698
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4699
 
4876
4700
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4701
    """
4885
4709
 
4886
4710
 
4887
4711
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4712
    """Run the bzr server."""
4889
4713
 
4890
4714
    aliases = ['server']
4891
4715
 
4892
4716
    takes_options = [
4893
4717
        Option('inet',
4894
4718
               help='Serve on stdin/out for use from inetd or sshd.'),
4895
 
        RegistryOption('protocol',
4896
 
               help="Protocol to serve.",
 
4719
        RegistryOption('protocol', 
 
4720
               help="Protocol to serve.", 
4897
4721
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4898
4722
               value_switches=True),
4899
4723
        Option('port',
4908
4732
        Option('allow-writes',
4909
4733
               help='By default the server is a readonly server.  Supplying '
4910
4734
                    '--allow-writes enables write access to the contents of '
4911
 
                    'the served directory and below.  Note that ``bzr serve`` '
4912
 
                    'does not perform authentication, so unless some form of '
4913
 
                    'external authentication is arranged supplying this '
4914
 
                    'option leads to global uncontrolled write access to your '
4915
 
                    'file system.'
 
4735
                    'the served directory and below.'
4916
4736
                ),
4917
4737
        ]
4918
4738
 
4951
4771
 
4952
4772
 
4953
4773
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
 
4774
    """Combine a tree into its containing tree.
4955
4775
 
4956
4776
    This command requires the target tree to be in a rich-root format.
4957
4777
 
4997
4817
 
4998
4818
 
4999
4819
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4820
    """Split a subdirectory of a tree into a separate tree.
5001
4821
 
5002
4822
    This command will produce a target tree in a format that supports
5003
4823
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5023
4843
 
5024
4844
 
5025
4845
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4846
    """Generate a merge directive for auto-merge tools.
5027
4847
 
5028
4848
    A directive requests a merge to be performed, and also provides all the
5029
4849
    information necessary to do so.  This means it must either include a
5122
4942
 
5123
4943
 
5124
4944
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4945
    """Mail or create a merge-directive for submitting changes.
5126
4946
 
5127
4947
    A merge directive provides many things needed for requesting merges:
5128
4948
 
5134
4954
      directly from the merge directive, without retrieving data from a
5135
4955
      branch.
5136
4956
 
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.
 
4957
    If --no-bundle is specified, then public_branch is needed (and must be
 
4958
    up-to-date), so that the receiver can perform the merge using the
 
4959
    public_branch.  The public_branch is always included if known, so that
 
4960
    people can check it later.
 
4961
 
 
4962
    The submit branch defaults to the parent, but can be overridden.  Both
 
4963
    submit branch and public branch will be remembered if supplied.
 
4964
 
 
4965
    If a public_branch is known for the submit_branch, that public submit
 
4966
    branch is used in the merge instructions.  This means that a local mirror
 
4967
    can be used as your actual submit branch, once you have set public_branch
 
4968
    for that mirror.
5163
4969
 
5164
4970
    Mail is sent using your preferred mail program.  This should be transparent
5165
4971
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5167
4973
 
5168
4974
    To use a specific mail program, set the mail_client configuration option.
5169
4975
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5170
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5171
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5172
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5173
 
    supported clients.
 
4976
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4977
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4978
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5174
4979
 
5175
4980
    If mail is being sent, a to address is required.  This can be supplied
5176
4981
    either on the commandline, by setting the submit_to configuration
5185
4990
 
5186
4991
    The merge directives created by bzr send may be applied using bzr merge or
5187
4992
    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.
5192
4993
    """
5193
4994
 
5194
4995
    encoding_type = 'exact'
5210
5011
               short_name='f',
5211
5012
               type=unicode),
5212
5013
        Option('output', short_name='o',
5213
 
               help='Write merge directive to this file or directory; '
 
5014
               help='Write merge directive to this file; '
5214
5015
                    'use - for stdout.',
5215
5016
               type=unicode),
5216
5017
        Option('strict',
5239
5040
 
5240
5041
 
5241
5042
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5043
    """Create a merge-directive for submitting changes.
5243
5044
 
5244
5045
    A merge directive provides many things needed for requesting merges:
5245
5046
 
5312
5113
 
5313
5114
 
5314
5115
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5116
    """Create, remove or modify a tag naming a revision.
5316
5117
 
5317
5118
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
5119
    (--revision) option can be given -rtag:X, where X is any previously
5326
5127
 
5327
5128
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5328
5129
    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.
5334
5130
    """
5335
5131
 
5336
5132
    _see_also = ['commit', 'tags']
5337
 
    takes_args = ['tag_name?']
 
5133
    takes_args = ['tag_name']
5338
5134
    takes_options = [
5339
5135
        Option('delete',
5340
5136
            help='Delete this tag rather than placing it.',
5350
5146
        'revision',
5351
5147
        ]
5352
5148
 
5353
 
    def run(self, tag_name=None,
 
5149
    def run(self, tag_name,
5354
5150
            delete=None,
5355
5151
            directory='.',
5356
5152
            force=None,
5358
5154
            ):
5359
5155
        branch, relpath = Branch.open_containing(directory)
5360
5156
        branch.lock_write()
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)
 
5157
        try:
 
5158
            if delete:
 
5159
                branch.tags.delete_tag(tag_name)
 
5160
                self.outf.write('Deleted tag %s.\n' % tag_name)
5374
5161
            else:
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)
 
5162
                if revision:
 
5163
                    if len(revision) != 1:
 
5164
                        raise errors.BzrCommandError(
 
5165
                            "Tags can only be placed on a single revision, "
 
5166
                            "not on a range")
 
5167
                    revision_id = revision[0].as_revision_id(branch)
 
5168
                else:
 
5169
                    revision_id = branch.last_revision()
 
5170
                if (not force) and branch.tags.has_tag(tag_name):
 
5171
                    raise errors.TagAlreadyExists(tag_name)
 
5172
                branch.tags.set_tag(tag_name, revision_id)
 
5173
                self.outf.write('Created tag %s.\n' % tag_name)
 
5174
        finally:
 
5175
            branch.unlock()
5385
5176
 
5386
5177
 
5387
5178
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
5179
    """List tags.
5389
5180
 
5390
5181
    This command shows a table of tag names and the revisions they reference.
5391
5182
    """
5420
5211
            return
5421
5212
 
5422
5213
        branch.lock_read()
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()
 
5214
        try:
 
5215
            if revision:
 
5216
                graph = branch.repository.get_graph()
 
5217
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5218
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5219
                # only show revisions between revid1 and revid2 (inclusive)
 
5220
                tags = [(tag, revid) for tag, revid in tags if
 
5221
                    graph.is_between(revid, revid1, revid2)]
 
5222
            if sort == 'alpha':
 
5223
                tags.sort()
 
5224
            elif sort == 'time':
 
5225
                timestamps = {}
 
5226
                for tag, revid in tags:
 
5227
                    try:
 
5228
                        revobj = branch.repository.get_revision(revid)
 
5229
                    except errors.NoSuchRevision:
 
5230
                        timestamp = sys.maxint # place them at the end
 
5231
                    else:
 
5232
                        timestamp = revobj.timestamp
 
5233
                    timestamps[revid] = timestamp
 
5234
                tags.sort(key=lambda x: timestamps[x[1]])
 
5235
            if not show_ids:
 
5236
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5237
                for index, (tag, revid) in enumerate(tags):
 
5238
                    try:
 
5239
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5240
                        if isinstance(revno, tuple):
 
5241
                            revno = '.'.join(map(str, revno))
 
5242
                    except errors.NoSuchRevision:
 
5243
                        # Bad tag data/merges can lead to tagged revisions
 
5244
                        # which are not in this branch. Fail gracefully ...
 
5245
                        revno = '?'
 
5246
                    tags[index] = (tag, revno)
 
5247
        finally:
 
5248
            branch.unlock()
5457
5249
        for tag, revspec in tags:
5458
5250
            self.outf.write('%-20s %s\n' % (tag, revspec))
5459
5251
 
5460
5252
 
5461
5253
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5254
    """Reconfigure the type of a bzr directory.
5463
5255
 
5464
5256
    A target configuration must be specified.
5465
5257
 
5550
5342
 
5551
5343
 
5552
5344
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
 
5345
    """Set the branch of a checkout and update.
5554
5346
 
5555
5347
    For lightweight checkouts, this changes the branch being referenced.
5556
5348
    For heavyweight checkouts, this checks that there are no local commits
5568
5360
    /path/to/newbranch.
5569
5361
 
5570
5362
    Bound branches use the nickname of its master branch unless it is set
5571
 
    locally, in which case switching will update the local nickname to be
 
5363
    locally, in which case switching will update the the local nickname to be
5572
5364
    that of the master.
5573
5365
    """
5574
5366
 
5575
 
    takes_args = ['to_location?']
 
5367
    takes_args = ['to_location']
5576
5368
    takes_options = [Option('force',
5577
5369
                        help='Switch even if local commits will be lost.'),
5578
 
                     'revision',
5579
5370
                     Option('create-branch', short_name='b',
5580
5371
                        help='Create the target branch from this one before'
5581
5372
                             ' switching to it.'),
5582
 
                    ]
 
5373
                     ]
5583
5374
 
5584
 
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5375
    def run(self, to_location, force=False, create_branch=False):
5586
5376
        from bzrlib import switch
5587
5377
        tree_location = '.'
5588
 
        revision = _get_one_revision('switch', revision)
5589
5378
        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 = '.'
5595
5379
        try:
5596
5380
            branch = control_dir.open_branch()
5597
5381
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5602
5386
            if branch is None:
5603
5387
                raise errors.BzrCommandError('cannot create branch without'
5604
5388
                                             ' source branch')
5605
 
            to_location = directory_service.directories.dereference(
5606
 
                              to_location)
5607
5389
            if '/' not in to_location and '\\' not in to_location:
5608
5390
                # This path is meant to be relative to the existing branch
5609
5391
                this_url = self._get_branch_location(control_dir)
5611
5393
            to_branch = branch.bzrdir.sprout(to_location,
5612
5394
                                 possible_transports=[branch.bzrdir.root_transport],
5613
5395
                                 source_branch=branch).open_branch()
 
5396
            # try:
 
5397
            #     from_branch = control_dir.open_branch()
 
5398
            # except errors.NotBranchError:
 
5399
            #     raise BzrCommandError('Cannot create a branch from this'
 
5400
            #         ' location when we cannot open this branch')
 
5401
            # from_branch.bzrdir.sprout(
 
5402
            pass
5614
5403
        else:
5615
5404
            try:
5616
5405
                to_branch = Branch.open(to_location)
5618
5407
                this_url = self._get_branch_location(control_dir)
5619
5408
                to_branch = Branch.open(
5620
5409
                    urlutils.join(this_url, '..', to_location))
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)
 
5410
        switch.switch(control_dir, to_branch, force)
5624
5411
        if had_explicit_nick:
5625
5412
            branch = control_dir.open_branch() #get the new branch!
5626
5413
            branch.nick = to_branch.nick
5646
5433
 
5647
5434
 
5648
5435
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5436
    """Manage filtered views.
5650
5437
 
5651
5438
    Views provide a mask over the tree so that users can focus on
5652
5439
    a subset of a tree when doing their work. After creating a view,
5800
5587
 
5801
5588
 
5802
5589
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5590
    """Show hooks."""
5804
5591
 
5805
5592
    hidden = True
5806
5593
 
5819
5606
                    self.outf.write("    <no hooks installed>\n")
5820
5607
 
5821
5608
 
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
 
 
5847
5609
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5610
    """Temporarily set aside some changes from the current tree.
5849
5611
 
5850
5612
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5613
    ie. out of the way, until a later time when you can bring them back from
5898
5660
            try:
5899
5661
                shelver.run()
5900
5662
            finally:
5901
 
                shelver.finalize()
 
5663
                shelver.work_tree.unlock()
5902
5664
        except errors.UserAbort:
5903
5665
            return 0
5904
5666
 
5905
5667
    def run_for_list(self):
5906
5668
        tree = WorkingTree.open_containing('.')[0]
5907
5669
        tree.lock_read()
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
 
5670
        try:
 
5671
            manager = tree.get_shelf_manager()
 
5672
            shelves = manager.active_shelves()
 
5673
            if len(shelves) == 0:
 
5674
                note('No shelved changes.')
 
5675
                return 0
 
5676
            for shelf_id in reversed(shelves):
 
5677
                message = manager.get_metadata(shelf_id).get('message')
 
5678
                if message is None:
 
5679
                    message = '<no message>'
 
5680
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5681
            return 1
 
5682
        finally:
 
5683
            tree.unlock()
5920
5684
 
5921
5685
 
5922
5686
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5687
    """Restore shelved changes.
5924
5688
 
5925
5689
    By default, the most recently shelved changes are restored. However if you
5926
5690
    specify a shelf by id those changes will be restored instead.  This works
5934
5698
            enum_switch=False, value_switches=True,
5935
5699
            apply="Apply changes and remove from the shelf.",
5936
5700
            dry_run="Show changes, but do not apply or remove them.",
5937
 
            preview="Instead of unshelving the changes, show the diff that "
5938
 
                    "would result from unshelving.",
5939
 
            delete_only="Delete changes without applying them.",
5940
 
            keep="Apply changes but don't delete them.",
 
5701
            delete_only="Delete changes without applying them."
5941
5702
        )
5942
5703
    ]
5943
5704
    _see_also = ['shelve']
5952
5713
 
5953
5714
 
5954
5715
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
 
5716
    """Remove unwanted files from working tree.
5956
5717
 
5957
5718
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
5719
    files are never deleted.
5986
5747
 
5987
5748
 
5988
5749
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5750
    """list, view and set branch locations for nested trees.
5990
5751
 
5991
5752
    If no arguments are provided, lists the branch locations for nested trees.
5992
5753
    If one argument is provided, display the branch location for that tree.
6032
5793
            self.outf.write('%s %s\n' % (path, location))
6033
5794
 
6034
5795
 
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)
 
5796
# these get imported and then picked up by the scan for cmd_*
 
5797
# TODO: Some more consistent way to split command definitions across files;
 
5798
# we do need to load at least some information about them to know of
 
5799
# aliases.  ideally we would avoid loading the implementation until the
 
5800
# details were needed.
 
5801
from bzrlib.cmd_version_info import cmd_version_info
 
5802
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5803
from bzrlib.bundle.commands import (
 
5804
    cmd_bundle_info,
 
5805
    )
 
5806
from bzrlib.foreign import cmd_dpush
 
5807
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5808
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5809
        cmd_weave_plan_merge, cmd_weave_merge_text