/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
 
34
    directory_service,
34
35
    delta,
35
36
    config,
36
37
    errors,
43
44
    reconfigure,
44
45
    rename_map,
45
46
    revision as _mod_revision,
 
47
    static_tuple,
46
48
    symbol_versioning,
 
49
    timestamp,
47
50
    transport,
48
51
    ui,
49
52
    urlutils,
51
54
    )
52
55
from bzrlib.branch import Branch
53
56
from bzrlib.conflicts import ConflictList
 
57
from bzrlib.transport import memory
54
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
55
59
from bzrlib.smtp_connection import SMTPConnection
56
60
from bzrlib.workingtree import WorkingTree
57
61
""")
58
62
 
59
 
from bzrlib.commands import Command, display_command
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
60
68
from bzrlib.option import (
61
69
    ListOption,
62
70
    Option,
231
239
# opens the branch?)
232
240
 
233
241
class cmd_status(Command):
234
 
    """Display status summary.
 
242
    __doc__ = """Display status summary.
235
243
 
236
244
    This reports on versioned and unknown files, reporting them
237
245
    grouped by state.  Possible states are:
257
265
    unknown
258
266
        Not versioned and not matching an ignore pattern.
259
267
 
 
268
    Additionally for directories, symlinks and files with an executable
 
269
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
270
    or '*' respectively.
 
271
 
260
272
    To see ignored files use 'bzr ignored'.  For details on the
261
273
    changes to file texts, use 'bzr diff'.
262
274
 
320
332
 
321
333
 
322
334
class cmd_cat_revision(Command):
323
 
    """Write out metadata for a revision.
 
335
    __doc__ = """Write out metadata for a revision.
324
336
 
325
337
    The revision to print can either be specified by a specific
326
338
    revision identifier, or you can use --revision.
332
344
    # cat-revision is more for frontends so should be exact
333
345
    encoding = 'strict'
334
346
 
 
347
    def print_revision(self, revisions, revid):
 
348
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
 
349
        record = stream.next()
 
350
        if record.storage_kind == 'absent':
 
351
            raise errors.NoSuchRevision(revisions, revid)
 
352
        revtext = record.get_bytes_as('fulltext')
 
353
        self.outf.write(revtext.decode('utf-8'))
 
354
 
335
355
    @display_command
336
356
    def run(self, revision_id=None, revision=None):
337
357
        if revision_id is not None and revision is not None:
342
362
                                         ' --revision or a revision_id')
343
363
        b = WorkingTree.open_containing(u'.')[0].branch
344
364
 
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'))
 
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')
361
369
 
 
370
        b.repository.lock_read()
 
371
        try:
 
372
            # TODO: jam 20060112 should cat-revision always output utf-8?
 
373
            if revision_id is not None:
 
374
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
375
                try:
 
376
                    self.print_revision(revisions, revision_id)
 
377
                except errors.NoSuchRevision:
 
378
                    msg = "The repository %s contains no revision %s." % (
 
379
                        b.repository.base, revision_id)
 
380
                    raise errors.BzrCommandError(msg)
 
381
            elif revision is not None:
 
382
                for rev in revision:
 
383
                    if rev is None:
 
384
                        raise errors.BzrCommandError(
 
385
                            'You cannot specify a NULL revision.')
 
386
                    rev_id = rev.as_revision_id(b)
 
387
                    self.print_revision(revisions, rev_id)
 
388
        finally:
 
389
            b.repository.unlock()
 
390
        
362
391
 
363
392
class cmd_dump_btree(Command):
364
 
    """Dump the contents of a btree index file to stdout.
 
393
    __doc__ = """Dump the contents of a btree index file to stdout.
365
394
 
366
395
    PATH is a btree index file, it can be any URL. This includes things like
367
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
431
460
        for node in bt.iter_all_entries():
432
461
            # Node is made up of:
433
462
            # (index, key, value, [references])
434
 
            self.outf.write('%s\n' % (node[1:],))
 
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,))
435
471
 
436
472
 
437
473
class cmd_remove_tree(Command):
438
 
    """Remove the working tree from a given branch/checkout.
 
474
    __doc__ = """Remove the working tree from a given branch/checkout.
439
475
 
440
476
    Since a lightweight checkout is little more than a working tree
441
477
    this will refuse to run against one.
443
479
    To re-create the working tree, use "bzr checkout".
444
480
    """
445
481
    _see_also = ['checkout', 'working-trees']
446
 
    takes_args = ['location?']
 
482
    takes_args = ['location*']
447
483
    takes_options = [
448
484
        Option('force',
449
485
               help='Remove the working tree even if it has '
450
486
                    'uncommitted changes.'),
451
487
        ]
452
488
 
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()
 
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()
475
512
 
476
513
 
477
514
class cmd_revno(Command):
478
 
    """Show current revision number.
 
515
    __doc__ = """Show current revision number.
479
516
 
480
517
    This is equal to the number of revisions on this branch.
481
518
    """
494
531
                wt.lock_read()
495
532
            except (errors.NoWorkingTree, errors.NotLocalUrl):
496
533
                raise errors.NoWorkingTree(location)
 
534
            self.add_cleanup(wt.unlock)
 
535
            revid = wt.last_revision()
497
536
            try:
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()
 
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)
506
541
        else:
507
542
            b = Branch.open_containing(location)[0]
508
543
            b.lock_read()
509
 
            try:
510
 
                revno = b.revno()
511
 
            finally:
512
 
                b.unlock()
513
 
 
 
544
            self.add_cleanup(b.unlock)
 
545
            revno = b.revno()
 
546
        self.cleanup_now()
514
547
        self.outf.write(str(revno) + '\n')
515
548
 
516
549
 
517
550
class cmd_revision_info(Command):
518
 
    """Show revision number and revision id for a given revision identifier.
 
551
    __doc__ = """Show revision number and revision id for a given revision identifier.
519
552
    """
520
553
    hidden = True
521
554
    takes_args = ['revision_info*']
538
571
            wt = WorkingTree.open_containing(directory)[0]
539
572
            b = wt.branch
540
573
            wt.lock_read()
 
574
            self.add_cleanup(wt.unlock)
541
575
        except (errors.NoWorkingTree, errors.NotLocalUrl):
542
576
            wt = None
543
577
            b = Branch.open_containing(directory)[0]
544
578
            b.lock_read()
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()
 
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())
575
593
            else:
576
 
                wt.unlock()
577
 
 
 
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()
578
608
        for ri in revinfos:
579
609
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
580
610
 
581
611
 
582
612
class cmd_add(Command):
583
 
    """Add specified files or directories.
 
613
    __doc__ = """Add specified files or directories.
584
614
 
585
615
    In non-recursive mode, all the named items are added, regardless
586
616
    of whether they were previously ignored.  A warning is given if
652
682
 
653
683
        if base_tree:
654
684
            base_tree.lock_read()
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()
 
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()
663
690
        if len(ignored) > 0:
664
691
            if verbose:
665
692
                for glob in sorted(ignored.keys()):
669
696
 
670
697
 
671
698
class cmd_mkdir(Command):
672
 
    """Create a new versioned directory.
 
699
    __doc__ = """Create a new versioned directory.
673
700
 
674
701
    This is equivalent to creating the directory and then adding it.
675
702
    """
679
706
 
680
707
    def run(self, dir_list):
681
708
        for d in dir_list:
682
 
            os.mkdir(d)
683
709
            wt, dd = WorkingTree.open_containing(d)
684
 
            wt.add([dd])
685
 
            self.outf.write('added %s\n' % d)
 
710
            base = os.path.dirname(dd)
 
711
            id = wt.path2id(base)
 
712
            if id != None:
 
713
                os.mkdir(d)
 
714
                wt.add([dd])
 
715
                self.outf.write('added %s\n' % d)
 
716
            else:
 
717
                raise errors.NotVersionedError(path=base)
686
718
 
687
719
 
688
720
class cmd_relpath(Command):
689
 
    """Show path of a file relative to root"""
 
721
    __doc__ = """Show path of a file relative to root"""
690
722
 
691
723
    takes_args = ['filename']
692
724
    hidden = True
701
733
 
702
734
 
703
735
class cmd_inventory(Command):
704
 
    """Show inventory of the current working copy or a revision.
 
736
    __doc__ = """Show inventory of the current working copy or a revision.
705
737
 
706
738
    It is possible to limit the output to a particular entry
707
739
    type using the --kind option.  For example: --kind file.
729
761
        revision = _get_one_revision('inventory', revision)
730
762
        work_tree, file_list = tree_files(file_list)
731
763
        work_tree.lock_read()
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
 
 
 
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()
756
786
        for path, entry in entries:
757
787
            if kind and kind != entry.kind:
758
788
                continue
764
794
 
765
795
 
766
796
class cmd_mv(Command):
767
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
768
798
 
769
799
    :Usage:
770
800
        bzr mv OLDNAME NEWNAME
804
834
            raise errors.BzrCommandError("missing file argument")
805
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
806
836
        tree.lock_tree_write()
807
 
        try:
808
 
            self._run(tree, names_list, rel_names, after)
809
 
        finally:
810
 
            tree.unlock()
 
837
        self.add_cleanup(tree.unlock)
 
838
        self._run(tree, names_list, rel_names, after)
811
839
 
812
840
    def run_auto(self, names_list, after, dry_run):
813
841
        if names_list is not None and len(names_list) > 1:
818
846
                                         ' --auto.')
819
847
        work_tree, file_list = tree_files(names_list, default_branch='.')
820
848
        work_tree.lock_tree_write()
821
 
        try:
822
 
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
823
 
        finally:
824
 
            work_tree.unlock()
 
849
        self.add_cleanup(work_tree.unlock)
 
850
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
825
851
 
826
852
    def _run(self, tree, names_list, rel_names, after):
827
853
        into_existing = osutils.isdir(names_list[-1])
848
874
            # All entries reference existing inventory items, so fix them up
849
875
            # for cicp file-systems.
850
876
            rel_names = tree.get_canonical_inventory_paths(rel_names)
851
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
852
 
                self.outf.write("%s => %s\n" % pair)
 
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))
853
880
        else:
854
881
            if len(names_list) != 2:
855
882
                raise errors.BzrCommandError('to mv multiple files the'
899
926
            dest = osutils.pathjoin(dest_parent, dest_tail)
900
927
            mutter("attempting to move %s => %s", src, dest)
901
928
            tree.rename_one(src, dest, after=after)
902
 
            self.outf.write("%s => %s\n" % (src, dest))
 
929
            if not is_quiet():
 
930
                self.outf.write("%s => %s\n" % (src, dest))
903
931
 
904
932
 
905
933
class cmd_pull(Command):
906
 
    """Turn this branch into a mirror of another branch.
 
934
    __doc__ = """Turn this branch into a mirror of another branch.
907
935
 
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.
 
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.
911
940
 
912
941
    If branches have diverged, you can use 'bzr merge' to integrate the changes
913
942
    from one into the other.  Once one branch has merged, the other should
914
943
    be able to pull it again.
915
944
 
916
 
    If you want to forget your local changes and just update your branch to
917
 
    match the remote one, use pull --overwrite.
 
945
    If you want to replace your local changes and just want your branch to
 
946
    match the remote one, use pull --overwrite. This will work even if the two
 
947
    branches have diverged.
918
948
 
919
949
    If there is no default location set, the first pull will set it.  After
920
950
    that, you can omit the location to use the default.  To change the
956
986
        try:
957
987
            tree_to = WorkingTree.open_containing(directory)[0]
958
988
            branch_to = tree_to.branch
 
989
            tree_to.lock_write()
 
990
            self.add_cleanup(tree_to.unlock)
959
991
        except errors.NoWorkingTree:
960
992
            tree_to = None
961
993
            branch_to = Branch.open_containing(directory)[0]
962
 
        
 
994
            branch_to.lock_write()
 
995
            self.add_cleanup(branch_to.unlock)
 
996
 
963
997
        if local and not branch_to.get_bound_location():
964
998
            raise errors.LocalRequiresBoundBranch()
965
999
 
995
1029
        else:
996
1030
            branch_from = Branch.open(location,
997
1031
                possible_transports=possible_transports)
 
1032
            branch_from.lock_read()
 
1033
            self.add_cleanup(branch_from.unlock)
998
1034
 
999
1035
            if branch_to.get_parent() is None or remember:
1000
1036
                branch_to.set_parent(branch_from.base)
1001
1037
 
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()
 
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)
1032
1058
 
1033
1059
 
1034
1060
class cmd_push(Command):
1035
 
    """Update a mirror of this branch.
 
1061
    __doc__ = """Update a mirror of this branch.
1036
1062
 
1037
1063
    The target branch will not have its working tree populated because this
1038
1064
    is both expensive, and is not supported on remote file systems.
1099
1125
        # Get the source branch
1100
1126
        (tree, br_from,
1101
1127
         _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
1105
1128
        # Get the tip's revision_id
1106
1129
        revision = _get_one_revision('push', revision)
1107
1130
        if revision is not None:
1108
1131
            revision_id = revision.in_history(br_from).rev_id
1109
1132
        else:
1110
1133
            revision_id = None
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
 
 
 
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.')
1123
1139
        # Get the stacked_on branch, if any
1124
1140
        if stacked_on is not None:
1125
1141
            stacked_on = urlutils.normalize_url(stacked_on)
1157
1173
 
1158
1174
 
1159
1175
class cmd_branch(Command):
1160
 
    """Create a new branch that is a copy of an existing branch.
 
1176
    __doc__ = """Create a new branch that is a copy of an existing branch.
1161
1177
 
1162
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1163
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1190
1206
                    ' directory exists, but does not already'
1191
1207
                    ' have a control directory.  This flag will'
1192
1208
                    ' allow branch to proceed.'),
 
1209
        Option('bind',
 
1210
            help="Bind new branch to from location."),
1193
1211
        ]
1194
1212
    aliases = ['get', 'clone']
1195
1213
 
1196
1214
    def run(self, from_location, to_location=None, revision=None,
1197
1215
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1198
 
            use_existing_dir=False, switch=False):
 
1216
            use_existing_dir=False, switch=False, bind=False):
1199
1217
        from bzrlib import switch as _mod_switch
1200
1218
        from bzrlib.tag import _merge_tags_if_possible
1201
1219
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1202
1220
            from_location)
1203
 
        if (accelerator_tree is not None and
1204
 
            accelerator_tree.supports_content_filtering()):
1205
 
            accelerator_tree = None
1206
1221
        revision = _get_one_revision('branch', revision)
1207
1222
        br_from.lock_read()
 
1223
        self.add_cleanup(br_from.unlock)
 
1224
        if revision is not None:
 
1225
            revision_id = revision.as_revision_id(br_from)
 
1226
        else:
 
1227
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1228
            # None or perhaps NULL_REVISION to mean copy nothing
 
1229
            # RBC 20060209
 
1230
            revision_id = br_from.last_revision()
 
1231
        if to_location is None:
 
1232
            to_location = urlutils.derive_to_location(from_location)
 
1233
        to_transport = transport.get_transport(to_location)
1208
1234
        try:
1209
 
            if revision is not None:
1210
 
                revision_id = revision.as_revision_id(br_from)
 
1235
            to_transport.mkdir('.')
 
1236
        except errors.FileExists:
 
1237
            if not use_existing_dir:
 
1238
                raise errors.BzrCommandError('Target directory "%s" '
 
1239
                    'already exists.' % to_location)
1211
1240
            else:
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)
 
1241
                try:
 
1242
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1243
                except errors.NotBranchError:
 
1244
                    pass
1225
1245
                else:
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()
 
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'))
1268
1286
 
1269
1287
 
1270
1288
class cmd_checkout(Command):
1271
 
    """Create a new checkout of an existing branch.
 
1289
    __doc__ = """Create a new checkout of an existing branch.
1272
1290
 
1273
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1274
1292
    the branch found in '.'. This is useful if you have removed the working tree
1337
1355
 
1338
1356
 
1339
1357
class cmd_renames(Command):
1340
 
    """Show list of renamed files.
 
1358
    __doc__ = """Show list of renamed files.
1341
1359
    """
1342
1360
    # TODO: Option to show renames between two historical versions.
1343
1361
 
1349
1367
    def run(self, dir=u'.'):
1350
1368
        tree = WorkingTree.open_containing(dir)[0]
1351
1369
        tree.lock_read()
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()
 
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))
1373
1387
 
1374
1388
 
1375
1389
class cmd_update(Command):
1376
 
    """Update a tree to have the latest code committed to its branch.
 
1390
    __doc__ = """Update a tree to have the latest code committed to its branch.
1377
1391
 
1378
1392
    This will perform a merge into the working tree, and may generate
1379
1393
    conflicts. If you have any local changes, you will still
1381
1395
 
1382
1396
    If you want to discard your local changes, you can just do a
1383
1397
    'bzr revert' instead of 'bzr commit' after the update.
 
1398
 
 
1399
    If the tree's branch is bound to a master branch, it will also update
 
1400
    the branch from the master.
1384
1401
    """
1385
1402
 
1386
1403
    _see_also = ['pull', 'working-trees', 'status-flags']
1387
1404
    takes_args = ['dir?']
 
1405
    takes_options = ['revision']
1388
1406
    aliases = ['up']
1389
1407
 
1390
 
    def run(self, dir='.'):
 
1408
    def run(self, dir='.', revision=None):
 
1409
        if revision is not None and len(revision) != 1:
 
1410
            raise errors.BzrCommandError(
 
1411
                        "bzr update --revision takes exactly one revision")
1391
1412
        tree = WorkingTree.open_containing(dir)[0]
 
1413
        branch = tree.branch
1392
1414
        possible_transports = []
1393
 
        master = tree.branch.get_master_branch(
 
1415
        master = branch.get_master_branch(
1394
1416
            possible_transports=possible_transports)
1395
1417
        if master is not None:
1396
1418
            tree.lock_write()
 
1419
            branch_location = master.base
1397
1420
        else:
1398
1421
            tree.lock_tree_write()
 
1422
            branch_location = tree.branch.base
 
1423
        self.add_cleanup(tree.unlock)
 
1424
        # get rid of the final '/' and be ready for display
 
1425
        branch_location = urlutils.unescape_for_display(
 
1426
            branch_location.rstrip('/'),
 
1427
            self.outf.encoding)
 
1428
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1429
        if master is None:
 
1430
            old_tip = None
 
1431
        else:
 
1432
            # may need to fetch data into a heavyweight checkout
 
1433
            # XXX: this may take some time, maybe we should display a
 
1434
            # message
 
1435
            old_tip = branch.update(possible_transports)
 
1436
        if revision is not None:
 
1437
            revision_id = revision[0].as_revision_id(branch)
 
1438
        else:
 
1439
            revision_id = branch.last_revision()
 
1440
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1441
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1442
            note("Tree is up to date at revision %s of branch %s" %
 
1443
                ('.'.join(map(str, revno)), branch_location))
 
1444
            return 0
 
1445
        view_info = _get_view_info_for_change_reporter(tree)
 
1446
        change_reporter = delta._ChangeReporter(
 
1447
            unversioned_filter=tree.is_ignored,
 
1448
            view_info=view_info)
1399
1449
        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)
1411
1450
            conflicts = tree.update(
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()
 
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
1426
1473
 
1427
1474
 
1428
1475
class cmd_info(Command):
1429
 
    """Show information about a working tree, branch or repository.
 
1476
    __doc__ = """Show information about a working tree, branch or repository.
1430
1477
 
1431
1478
    This command will show all known locations and formats associated to the
1432
1479
    tree, branch or repository.
1470
1517
 
1471
1518
 
1472
1519
class cmd_remove(Command):
1473
 
    """Remove files or directories.
 
1520
    __doc__ = """Remove files or directories.
1474
1521
 
1475
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1476
1523
    them if they can easily be recovered using revert. If no options or
1499
1546
            file_list = [f for f in file_list]
1500
1547
 
1501
1548
        tree.lock_write()
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()
 
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')
1526
1571
 
1527
1572
 
1528
1573
class cmd_file_id(Command):
1529
 
    """Print file_id of a particular file or directory.
 
1574
    __doc__ = """Print file_id of a particular file or directory.
1530
1575
 
1531
1576
    The file_id is assigned when the file is first added and remains the
1532
1577
    same through all revisions where the file exists, even when it is
1548
1593
 
1549
1594
 
1550
1595
class cmd_file_path(Command):
1551
 
    """Print path of file_ids to a file or directory.
 
1596
    __doc__ = """Print path of file_ids to a file or directory.
1552
1597
 
1553
1598
    This prints one line for each directory down to the target,
1554
1599
    starting at the branch root.
1570
1615
 
1571
1616
 
1572
1617
class cmd_reconcile(Command):
1573
 
    """Reconcile bzr metadata in a branch.
 
1618
    __doc__ = """Reconcile bzr metadata in a branch.
1574
1619
 
1575
1620
    This can correct data mismatches that may have been caused by
1576
1621
    previous ghost operations or bzr upgrades. You should only
1598
1643
 
1599
1644
 
1600
1645
class cmd_revision_history(Command):
1601
 
    """Display the list of revision ids on a branch."""
 
1646
    __doc__ = """Display the list of revision ids on a branch."""
1602
1647
 
1603
1648
    _see_also = ['log']
1604
1649
    takes_args = ['location?']
1614
1659
 
1615
1660
 
1616
1661
class cmd_ancestry(Command):
1617
 
    """List all revisions merged into this branch."""
 
1662
    __doc__ = """List all revisions merged into this branch."""
1618
1663
 
1619
1664
    _see_also = ['log', 'revision-history']
1620
1665
    takes_args = ['location?']
1639
1684
 
1640
1685
 
1641
1686
class cmd_init(Command):
1642
 
    """Make a directory into a versioned branch.
 
1687
    __doc__ = """Make a directory into a versioned branch.
1643
1688
 
1644
1689
    Use this to create an empty branch, or before importing an
1645
1690
    existing project.
1673
1718
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1674
1719
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1675
1720
                value_switches=True,
1676
 
                title="Branch Format",
 
1721
                title="Branch format",
1677
1722
                ),
1678
1723
         Option('append-revisions-only',
1679
1724
                help='Never change revnos or the existing log.'
1748
1793
 
1749
1794
 
1750
1795
class cmd_init_repository(Command):
1751
 
    """Create a shared repository to hold branches.
 
1796
    __doc__ = """Create a shared repository for branches to share storage space.
1752
1797
 
1753
1798
    New branches created under the repository directory will store their
1754
 
    revisions in the repository, not in the branch directory.
 
1799
    revisions in the repository, not in the branch directory.  For branches
 
1800
    with shared history, this reduces the amount of storage needed and 
 
1801
    speeds up the creation of new branches.
1755
1802
 
1756
 
    If the --no-trees option is used then the branches in the repository
1757
 
    will not have working trees by default.
 
1803
    If the --no-trees option is given then the branches in the repository
 
1804
    will not have working trees by default.  They will still exist as 
 
1805
    directories on disk, but they will not have separate copies of the 
 
1806
    files at a certain revision.  This can be useful for repositories that
 
1807
    store branches which are interacted with through checkouts or remote
 
1808
    branches, such as on a server.
1758
1809
 
1759
1810
    :Examples:
1760
 
        Create a shared repositories holding just branches::
 
1811
        Create a shared repository holding just branches::
1761
1812
 
1762
1813
            bzr init-repo --no-trees repo
1763
1814
            bzr init repo/trunk
1802
1853
 
1803
1854
 
1804
1855
class cmd_diff(Command):
1805
 
    """Show differences in the working tree, between revisions or branches.
 
1856
    __doc__ = """Show differences in the working tree, between revisions or branches.
1806
1857
 
1807
1858
    If no arguments are given, all changes for the current tree are listed.
1808
1859
    If files are given, only the changes in those files are listed.
1829
1880
 
1830
1881
            bzr diff -r1
1831
1882
 
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
 
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
1839
1904
 
1840
1905
        Show just the differences for file NEWS::
1841
1906
 
1880
1945
            help='Use this command to compare files.',
1881
1946
            type=unicode,
1882
1947
            ),
 
1948
        RegistryOption('format',
 
1949
            help='Diff format to use.',
 
1950
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1951
            value_switches=False, title='Diff format'),
1883
1952
        ]
1884
1953
    aliases = ['di', 'dif']
1885
1954
    encoding_type = 'exact'
1886
1955
 
1887
1956
    @display_command
1888
1957
    def run(self, revision=None, file_list=None, diff_options=None,
1889
 
            prefix=None, old=None, new=None, using=None):
1890
 
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1958
            prefix=None, old=None, new=None, using=None, format=None):
 
1959
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1960
            show_diff_trees)
1891
1961
 
1892
1962
        if (prefix is None) or (prefix == '0'):
1893
1963
            # diff -p0 format
1907
1977
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1908
1978
                                         ' one or two revision specifiers')
1909
1979
 
1910
 
        old_tree, new_tree, specific_files, extra_trees = \
1911
 
                _get_trees_to_diff(file_list, revision, old, new,
1912
 
                apply_view=True)
 
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)
1913
1988
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1914
1989
                               specific_files=specific_files,
1915
1990
                               external_diff_options=diff_options,
1916
1991
                               old_label=old_label, new_label=new_label,
1917
 
                               extra_trees=extra_trees, using=using)
 
1992
                               extra_trees=extra_trees, using=using,
 
1993
                               format_cls=format)
1918
1994
 
1919
1995
 
1920
1996
class cmd_deleted(Command):
1921
 
    """List files deleted in the working tree.
 
1997
    __doc__ = """List files deleted in the working tree.
1922
1998
    """
1923
1999
    # TODO: Show files deleted since a previous revision, or
1924
2000
    # between two revisions.
1933
2009
    def run(self, show_ids=False):
1934
2010
        tree = WorkingTree.open_containing(u'.')[0]
1935
2011
        tree.lock_read()
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()
 
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')
1951
2023
 
1952
2024
 
1953
2025
class cmd_modified(Command):
1954
 
    """List files modified in working tree.
 
2026
    __doc__ = """List files modified in working tree.
1955
2027
    """
1956
2028
 
1957
2029
    hidden = True
1974
2046
 
1975
2047
 
1976
2048
class cmd_added(Command):
1977
 
    """List files added in working tree.
 
2049
    __doc__ = """List files added in working tree.
1978
2050
    """
1979
2051
 
1980
2052
    hidden = True
1989
2061
    def run(self, null=False):
1990
2062
        wt = WorkingTree.open_containing(u'.')[0]
1991
2063
        wt.lock_read()
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()
 
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')
2014
2082
 
2015
2083
 
2016
2084
class cmd_root(Command):
2017
 
    """Show the tree root directory.
 
2085
    __doc__ = """Show the tree root directory.
2018
2086
 
2019
2087
    The root is the nearest enclosing directory with a .bzr control
2020
2088
    directory."""
2044
2112
 
2045
2113
 
2046
2114
class cmd_log(Command):
2047
 
    """Show historical log for a branch or subset of a branch.
 
2115
    __doc__ = """Show historical log for a branch or subset of a branch.
2048
2116
 
2049
2117
    log is bzr's default tool for exploring the history of a branch.
2050
2118
    The branch to use is taken from the first parameter. If no parameters
2161
2229
    :Tips & tricks:
2162
2230
 
2163
2231
      GUI tools and IDEs are often better at exploring history than command
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.
 
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>.  
2171
2236
 
2172
2237
      You may find it useful to add the aliases below to ``bazaar.conf``::
2173
2238
 
2234
2299
                   help='Show changes made in each revision as a patch.'),
2235
2300
            Option('include-merges',
2236
2301
                   help='Show merged revisions like --levels 0 does.'),
 
2302
            Option('exclude-common-ancestry',
 
2303
                   help='Display only the revisions that are not part'
 
2304
                   ' of both ancestries (require -rX..Y)'
 
2305
                   )
2237
2306
            ]
2238
2307
    encoding_type = 'replace'
2239
2308
 
2249
2318
            message=None,
2250
2319
            limit=None,
2251
2320
            show_diff=False,
2252
 
            include_merges=False):
 
2321
            include_merges=False,
 
2322
            exclude_common_ancestry=False,
 
2323
            ):
2253
2324
        from bzrlib.log import (
2254
2325
            Logger,
2255
2326
            make_log_request_dict,
2256
2327
            _get_info_for_log_files,
2257
2328
            )
2258
2329
        direction = (forward and 'forward') or 'reverse'
 
2330
        if (exclude_common_ancestry
 
2331
            and (revision is None or len(revision) != 2)):
 
2332
            raise errors.BzrCommandError(
 
2333
                '--exclude-common-ancestry requires -r with two revisions')
2259
2334
        if include_merges:
2260
2335
            if levels is None:
2261
2336
                levels = 0
2276
2351
        filter_by_dir = False
2277
2352
        if file_list:
2278
2353
            # find the file ids to log and check for directory filtering
2279
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2280
 
                file_list)
 
2354
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2355
                revision, file_list)
 
2356
            self.add_cleanup(b.unlock)
2281
2357
            for relpath, file_id, kind in file_info_list:
2282
2358
                if file_id is None:
2283
2359
                    raise errors.BzrCommandError(
2301
2377
                location = '.'
2302
2378
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2303
2379
            b = dir.open_branch()
 
2380
            b.lock_read()
 
2381
            self.add_cleanup(b.unlock)
2304
2382
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2305
2383
 
2306
2384
        # Decide on the type of delta & diff filtering to use
2316
2394
        else:
2317
2395
            diff_type = 'full'
2318
2396
 
2319
 
        b.lock_read()
2320
 
        try:
2321
 
            # Build the log formatter
2322
 
            if log_format is None:
2323
 
                log_format = log.log_formatter_registry.get_default(b)
2324
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2325
 
                            show_timezone=timezone,
2326
 
                            delta_format=get_verbosity_level(),
2327
 
                            levels=levels,
2328
 
                            show_advice=levels is None)
2329
 
 
2330
 
            # Choose the algorithm for doing the logging. It's annoying
2331
 
            # having multiple code paths like this but necessary until
2332
 
            # the underlying repository format is faster at generating
2333
 
            # deltas or can provide everything we need from the indices.
2334
 
            # The default algorithm - match-using-deltas - works for
2335
 
            # multiple files and directories and is faster for small
2336
 
            # amounts of history (200 revisions say). However, it's too
2337
 
            # slow for logging a single file in a repository with deep
2338
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2339
 
            # evil when adding features", we continue to use the
2340
 
            # original algorithm - per-file-graph - for the "single
2341
 
            # file that isn't a directory without showing a delta" case.
2342
 
            partial_history = revision and b.repository._format.supports_chks
2343
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2344
 
                or delta_type or partial_history)
2345
 
 
2346
 
            # Build the LogRequest and execute it
2347
 
            if len(file_ids) == 0:
2348
 
                file_ids = None
2349
 
            rqst = make_log_request_dict(
2350
 
                direction=direction, specific_fileids=file_ids,
2351
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2352
 
                message_search=message, delta_type=delta_type,
2353
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2354
 
            Logger(b, rqst).show(lf)
2355
 
        finally:
2356
 
            b.unlock()
 
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)
2357
2436
 
2358
2437
 
2359
2438
def _get_revision_range(revisionspec_list, branch, command_name):
2377
2456
            raise errors.BzrCommandError(
2378
2457
                "bzr %s doesn't accept two revisions in different"
2379
2458
                " branches." % command_name)
2380
 
        rev1 = start_spec.in_history(branch)
 
2459
        if start_spec.spec is None:
 
2460
            # Avoid loading all the history.
 
2461
            rev1 = RevisionInfo(branch, None, None)
 
2462
        else:
 
2463
            rev1 = start_spec.in_history(branch)
2381
2464
        # Avoid loading all of history when we know a missing
2382
2465
        # end of range means the last revision ...
2383
2466
        if end_spec.spec is None:
2412
2495
 
2413
2496
 
2414
2497
class cmd_touching_revisions(Command):
2415
 
    """Return revision-ids which affected a particular file.
 
2498
    __doc__ = """Return revision-ids which affected a particular file.
2416
2499
 
2417
2500
    A more user-friendly interface is "bzr log FILE".
2418
2501
    """
2423
2506
    @display_command
2424
2507
    def run(self, filename):
2425
2508
        tree, relpath = WorkingTree.open_containing(filename)
 
2509
        file_id = tree.path2id(relpath)
2426
2510
        b = tree.branch
2427
 
        file_id = tree.path2id(relpath)
2428
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2511
        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:
2429
2515
            self.outf.write("%6d %s\n" % (revno, what))
2430
2516
 
2431
2517
 
2432
2518
class cmd_ls(Command):
2433
 
    """List files in a tree.
 
2519
    __doc__ = """List files in a tree.
2434
2520
    """
2435
2521
 
2436
2522
    _see_also = ['status', 'cat']
2484
2570
        if from_root:
2485
2571
            if relpath:
2486
2572
                prefix = relpath + '/'
2487
 
        elif fs_path != '.':
 
2573
        elif fs_path != '.' and not fs_path.endswith('/'):
2488
2574
            prefix = fs_path + '/'
2489
2575
 
2490
2576
        if revision is not None or tree is None:
2499
2585
                note("Ignoring files outside view. View is %s" % view_str)
2500
2586
 
2501
2587
        tree.lock_read()
2502
 
        try:
2503
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2504
 
                from_dir=relpath, recursive=recursive):
2505
 
                # Apply additional masking
2506
 
                if not all and not selection[fc]:
2507
 
                    continue
2508
 
                if kind is not None and fkind != kind:
2509
 
                    continue
2510
 
                if apply_view:
2511
 
                    try:
2512
 
                        if relpath:
2513
 
                            fullpath = osutils.pathjoin(relpath, fp)
2514
 
                        else:
2515
 
                            fullpath = fp
2516
 
                        views.check_path_in_view(tree, fullpath)
2517
 
                    except errors.FileOutsideView:
2518
 
                        continue
 
2588
        self.add_cleanup(tree.unlock)
 
2589
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2590
            from_dir=relpath, recursive=recursive):
 
2591
            # Apply additional masking
 
2592
            if not all and not selection[fc]:
 
2593
                continue
 
2594
            if kind is not None and fkind != kind:
 
2595
                continue
 
2596
            if apply_view:
 
2597
                try:
 
2598
                    if relpath:
 
2599
                        fullpath = osutils.pathjoin(relpath, fp)
 
2600
                    else:
 
2601
                        fullpath = fp
 
2602
                    views.check_path_in_view(tree, fullpath)
 
2603
                except errors.FileOutsideView:
 
2604
                    continue
2519
2605
 
2520
 
                # Output the entry
2521
 
                if prefix:
2522
 
                    fp = osutils.pathjoin(prefix, fp)
2523
 
                kindch = entry.kind_character()
2524
 
                outstring = fp + kindch
2525
 
                ui.ui_factory.clear_term()
2526
 
                if verbose:
2527
 
                    outstring = '%-8s %s' % (fc, outstring)
2528
 
                    if show_ids and fid is not None:
2529
 
                        outstring = "%-50s %s" % (outstring, fid)
 
2606
            # Output the entry
 
2607
            if prefix:
 
2608
                fp = osutils.pathjoin(prefix, fp)
 
2609
            kindch = entry.kind_character()
 
2610
            outstring = fp + kindch
 
2611
            ui.ui_factory.clear_term()
 
2612
            if verbose:
 
2613
                outstring = '%-8s %s' % (fc, outstring)
 
2614
                if show_ids and fid is not None:
 
2615
                    outstring = "%-50s %s" % (outstring, fid)
 
2616
                self.outf.write(outstring + '\n')
 
2617
            elif null:
 
2618
                self.outf.write(fp + '\0')
 
2619
                if show_ids:
 
2620
                    if fid is not None:
 
2621
                        self.outf.write(fid)
 
2622
                    self.outf.write('\0')
 
2623
                self.outf.flush()
 
2624
            else:
 
2625
                if show_ids:
 
2626
                    if fid is not None:
 
2627
                        my_id = fid
 
2628
                    else:
 
2629
                        my_id = ''
 
2630
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2631
                else:
2530
2632
                    self.outf.write(outstring + '\n')
2531
 
                elif null:
2532
 
                    self.outf.write(fp + '\0')
2533
 
                    if show_ids:
2534
 
                        if fid is not None:
2535
 
                            self.outf.write(fid)
2536
 
                        self.outf.write('\0')
2537
 
                    self.outf.flush()
2538
 
                else:
2539
 
                    if show_ids:
2540
 
                        if fid is not None:
2541
 
                            my_id = fid
2542
 
                        else:
2543
 
                            my_id = ''
2544
 
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
2545
 
                    else:
2546
 
                        self.outf.write(outstring + '\n')
2547
 
        finally:
2548
 
            tree.unlock()
2549
2633
 
2550
2634
 
2551
2635
class cmd_unknowns(Command):
2552
 
    """List unknown files.
 
2636
    __doc__ = """List unknown files.
2553
2637
    """
2554
2638
 
2555
2639
    hidden = True
2562
2646
 
2563
2647
 
2564
2648
class cmd_ignore(Command):
2565
 
    """Ignore specified files or patterns.
 
2649
    __doc__ = """Ignore specified files or patterns.
2566
2650
 
2567
2651
    See ``bzr help patterns`` for details on the syntax of patterns.
2568
2652
 
 
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
 
2569
2659
    To remove patterns from the ignore list, edit the .bzrignore file.
2570
2660
    After adding, editing or deleting that file either indirectly by
2571
2661
    using this command or directly by using an editor, be sure to commit
2572
2662
    it.
 
2663
    
 
2664
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2665
    the global ignore file can be found in the application data directory as
 
2666
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2667
    Global ignores are not touched by this command. The global ignore file
 
2668
    can be edited directly using an editor.
 
2669
 
 
2670
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
2671
    precedence over regular ignores.  Such exceptions are used to specify
 
2672
    files that should be versioned which would otherwise be ignored.
 
2673
    
 
2674
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
2675
    precedence over the '!' exception patterns.
2573
2676
 
2574
2677
    Note: ignore patterns containing shell wildcards must be quoted from
2575
2678
    the shell on Unix.
2579
2682
 
2580
2683
            bzr ignore ./Makefile
2581
2684
 
2582
 
        Ignore class files in all directories::
 
2685
        Ignore .class files in all directories...::
2583
2686
 
2584
2687
            bzr ignore "*.class"
2585
2688
 
 
2689
        ...but do not ignore "special.class"::
 
2690
 
 
2691
            bzr ignore "!special.class"
 
2692
 
2586
2693
        Ignore .o files under the lib directory::
2587
2694
 
2588
2695
            bzr ignore "lib/**/*.o"
2594
2701
        Ignore everything but the "debian" toplevel directory::
2595
2702
 
2596
2703
            bzr ignore "RE:(?!debian/).*"
 
2704
        
 
2705
        Ignore everything except the "local" toplevel directory,
 
2706
        but always ignore "*~" autosave files, even under local/::
 
2707
        
 
2708
            bzr ignore "*"
 
2709
            bzr ignore "!./local"
 
2710
            bzr ignore "!!*~"
2597
2711
    """
2598
2712
 
2599
2713
    _see_also = ['status', 'ignored', 'patterns']
2600
2714
    takes_args = ['name_pattern*']
2601
2715
    takes_options = [
2602
 
        Option('old-default-rules',
2603
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2716
        Option('default-rules',
 
2717
               help='Display the default ignore rules that bzr uses.')
2604
2718
        ]
2605
2719
 
2606
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2720
    def run(self, name_pattern_list=None, default_rules=None):
2607
2721
        from bzrlib import ignores
2608
 
        if old_default_rules is not None:
2609
 
            # dump the rules and exit
2610
 
            for pattern in ignores.OLD_DEFAULTS:
2611
 
                print pattern
 
2722
        if default_rules is not None:
 
2723
            # dump the default rules and exit
 
2724
            for pattern in ignores.USER_DEFAULTS:
 
2725
                self.outf.write("%s\n" % pattern)
2612
2726
            return
2613
2727
        if not name_pattern_list:
2614
2728
            raise errors.BzrCommandError("ignore requires at least one "
2615
 
                                  "NAME_PATTERN or --old-default-rules")
 
2729
                "NAME_PATTERN or --default-rules.")
2616
2730
        name_pattern_list = [globbing.normalize_pattern(p)
2617
2731
                             for p in name_pattern_list]
2618
2732
        for name_pattern in name_pattern_list:
2630
2744
            if id is not None:
2631
2745
                filename = entry[0]
2632
2746
                if ignored.match(filename):
2633
 
                    matches.append(filename.encode('utf-8'))
 
2747
                    matches.append(filename)
2634
2748
        tree.unlock()
2635
2749
        if len(matches) > 0:
2636
 
            print "Warning: the following files are version controlled and" \
2637
 
                  " match your ignore pattern:\n%s" \
2638
 
                  "\nThese files will continue to be version controlled" \
2639
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2750
            self.outf.write("Warning: the following files are version controlled and"
 
2751
                  " match your ignore pattern:\n%s"
 
2752
                  "\nThese files will continue to be version controlled"
 
2753
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2640
2754
 
2641
2755
 
2642
2756
class cmd_ignored(Command):
2643
 
    """List ignored files and the patterns that matched them.
 
2757
    __doc__ = """List ignored files and the patterns that matched them.
2644
2758
 
2645
2759
    List all the ignored files and the ignore pattern that caused the file to
2646
2760
    be ignored.
2657
2771
    def run(self):
2658
2772
        tree = WorkingTree.open_containing(u'.')[0]
2659
2773
        tree.lock_read()
2660
 
        try:
2661
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2662
 
                if file_class != 'I':
2663
 
                    continue
2664
 
                ## XXX: Slightly inefficient since this was already calculated
2665
 
                pat = tree.is_ignored(path)
2666
 
                self.outf.write('%-50s %s\n' % (path, pat))
2667
 
        finally:
2668
 
            tree.unlock()
 
2774
        self.add_cleanup(tree.unlock)
 
2775
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2776
            if file_class != 'I':
 
2777
                continue
 
2778
            ## XXX: Slightly inefficient since this was already calculated
 
2779
            pat = tree.is_ignored(path)
 
2780
            self.outf.write('%-50s %s\n' % (path, pat))
2669
2781
 
2670
2782
 
2671
2783
class cmd_lookup_revision(Command):
2672
 
    """Lookup the revision-id from a revision-number
 
2784
    __doc__ = """Lookup the revision-id from a revision-number
2673
2785
 
2674
2786
    :Examples:
2675
2787
        bzr lookup-revision 33
2682
2794
        try:
2683
2795
            revno = int(revno)
2684
2796
        except ValueError:
2685
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2686
 
 
2687
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2797
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2798
                                         % revno)
 
2799
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2800
        self.outf.write("%s\n" % revid)
2688
2801
 
2689
2802
 
2690
2803
class cmd_export(Command):
2691
 
    """Export current or past revision to a destination directory or archive.
 
2804
    __doc__ = """Export current or past revision to a destination directory or archive.
2692
2805
 
2693
2806
    If no revision is specified this exports the last committed revision.
2694
2807
 
2726
2839
        Option('root',
2727
2840
               type=str,
2728
2841
               help="Name of the root directory inside the exported file."),
 
2842
        Option('per-file-timestamps',
 
2843
               help='Set modification time of files to that of the last '
 
2844
                    'revision in which it was changed.'),
2729
2845
        ]
2730
2846
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2731
 
        root=None, filters=False):
 
2847
        root=None, filters=False, per_file_timestamps=False):
2732
2848
        from bzrlib.export import export
2733
2849
 
2734
2850
        if branch_or_subdir is None:
2741
2857
 
2742
2858
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2743
2859
        try:
2744
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2860
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2861
                   per_file_timestamps=per_file_timestamps)
2745
2862
        except errors.NoSuchExportFormat, e:
2746
2863
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2747
2864
 
2748
2865
 
2749
2866
class cmd_cat(Command):
2750
 
    """Write the contents of a file as of a given revision to standard output.
 
2867
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2751
2868
 
2752
2869
    If no revision is nominated, the last revision is used.
2753
2870
 
2774
2891
        tree, branch, relpath = \
2775
2892
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2776
2893
        branch.lock_read()
2777
 
        try:
2778
 
            return self._run(tree, branch, relpath, filename, revision,
2779
 
                             name_from_revision, filters)
2780
 
        finally:
2781
 
            branch.unlock()
 
2894
        self.add_cleanup(branch.unlock)
 
2895
        return self._run(tree, branch, relpath, filename, revision,
 
2896
                         name_from_revision, filters)
2782
2897
 
2783
2898
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2784
2899
        filtered):
2785
2900
        if tree is None:
2786
2901
            tree = b.basis_tree()
2787
2902
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2903
        rev_tree.lock_read()
 
2904
        self.add_cleanup(rev_tree.unlock)
2788
2905
 
2789
2906
        old_file_id = rev_tree.path2id(relpath)
2790
2907
 
2825
2942
            chunks = content.splitlines(True)
2826
2943
            content = filtered_output_bytes(chunks, filters,
2827
2944
                ContentFilterContext(relpath, rev_tree))
 
2945
            self.cleanup_now()
2828
2946
            self.outf.writelines(content)
2829
2947
        else:
 
2948
            self.cleanup_now()
2830
2949
            self.outf.write(content)
2831
2950
 
2832
2951
 
2833
2952
class cmd_local_time_offset(Command):
2834
 
    """Show the offset in seconds from GMT to local time."""
 
2953
    __doc__ = """Show the offset in seconds from GMT to local time."""
2835
2954
    hidden = True
2836
2955
    @display_command
2837
2956
    def run(self):
2838
 
        print osutils.local_time_offset()
 
2957
        self.outf.write("%s\n" % osutils.local_time_offset())
2839
2958
 
2840
2959
 
2841
2960
 
2842
2961
class cmd_commit(Command):
2843
 
    """Commit changes into a new revision.
 
2962
    __doc__ = """Commit changes into a new revision.
2844
2963
 
2845
2964
    An explanatory message needs to be given for each commit. This is
2846
2965
    often done by using the --message option (getting the message from the
2939
3058
             Option('strict',
2940
3059
                    help="Refuse to commit if there are unknown "
2941
3060
                    "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'."),
2942
3064
             ListOption('fixes', type=str,
2943
3065
                    help="Mark a bug as being fixed by this revision "
2944
3066
                         "(see \"bzr help bugs\")."),
2951
3073
                         "the master branch until a normal commit "
2952
3074
                         "is performed."
2953
3075
                    ),
2954
 
              Option('show-diff',
2955
 
                     help='When no message is supplied, show the diff along'
2956
 
                     ' with the status summary in the message editor.'),
 
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.'),
2957
3079
             ]
2958
3080
    aliases = ['ci', 'checkin']
2959
3081
 
2978
3100
 
2979
3101
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2980
3102
            unchanged=False, strict=False, local=False, fixes=None,
2981
 
            author=None, show_diff=False, exclude=None):
 
3103
            author=None, show_diff=False, exclude=None, commit_time=None):
2982
3104
        from bzrlib.errors import (
2983
3105
            PointlessCommit,
2984
3106
            ConflictsInTree,
2990
3112
            make_commit_message_template_encoded
2991
3113
        )
2992
3114
 
 
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
 
2993
3123
        # TODO: Need a blackbox test for invoking the external editor; may be
2994
3124
        # slightly problematic to run this cross-platform.
2995
3125
 
3015
3145
        if local and not tree.branch.get_bound_location():
3016
3146
            raise errors.LocalRequiresBoundBranch()
3017
3147
 
 
3148
        if message is not None:
 
3149
            try:
 
3150
                file_exists = osutils.lexists(message)
 
3151
            except UnicodeError:
 
3152
                # The commit message contains unicode characters that can't be
 
3153
                # represented in the filesystem encoding, so that can't be a
 
3154
                # file.
 
3155
                file_exists = False
 
3156
            if file_exists:
 
3157
                warning_msg = (
 
3158
                    'The commit message is a file name: "%(f)s".\n'
 
3159
                    '(use --file "%(f)s" to take commit message from that file)'
 
3160
                    % { 'f': message })
 
3161
                ui.ui_factory.show_warning(warning_msg)
 
3162
            if '\r' in message:
 
3163
                message = message.replace('\r\n', '\n')
 
3164
                message = message.replace('\r', '\n')
 
3165
            if file:
 
3166
                raise errors.BzrCommandError(
 
3167
                    "please specify either --message or --file")
 
3168
 
3018
3169
        def get_message(commit_obj):
3019
3170
            """Callback to get commit message"""
3020
 
            my_message = message
3021
 
            if my_message is None and not file:
3022
 
                t = make_commit_message_template_encoded(tree,
 
3171
            if file:
 
3172
                my_message = codecs.open(
 
3173
                    file, 'rt', osutils.get_user_encoding()).read()
 
3174
            elif message is not None:
 
3175
                my_message = message
 
3176
            else:
 
3177
                # No message supplied: make one up.
 
3178
                # text is the status of the tree
 
3179
                text = make_commit_message_template_encoded(tree,
3023
3180
                        selected_list, diff=show_diff,
3024
3181
                        output_encoding=osutils.get_user_encoding())
 
3182
                # start_message is the template generated from hooks
 
3183
                # XXX: Warning - looks like hooks return unicode,
 
3184
                # make_commit_message_template_encoded returns user encoding.
 
3185
                # We probably want to be using edit_commit_message instead to
 
3186
                # avoid this.
3025
3187
                start_message = generate_commit_message_template(commit_obj)
3026
 
                my_message = edit_commit_message_encoded(t,
 
3188
                my_message = edit_commit_message_encoded(text,
3027
3189
                    start_message=start_message)
3028
3190
                if my_message is None:
3029
3191
                    raise errors.BzrCommandError("please specify a commit"
3030
3192
                        " message with either --message or --file")
3031
 
            elif my_message and file:
3032
 
                raise errors.BzrCommandError(
3033
 
                    "please specify either --message or --file")
3034
 
            if file:
3035
 
                my_message = codecs.open(file, 'rt',
3036
 
                                         osutils.get_user_encoding()).read()
3037
3193
            if my_message == "":
3038
3194
                raise errors.BzrCommandError("empty commit message specified")
3039
3195
            return my_message
3047
3203
                        specific_files=selected_list,
3048
3204
                        allow_pointless=unchanged, strict=strict, local=local,
3049
3205
                        reporter=None, verbose=verbose, revprops=properties,
3050
 
                        authors=author,
 
3206
                        authors=author, timestamp=commit_stamp,
 
3207
                        timezone=offset,
3051
3208
                        exclude=safe_relpath_files(tree, exclude))
3052
3209
        except PointlessCommit:
3053
 
            # FIXME: This should really happen before the file is read in;
3054
 
            # perhaps prepare the commit; get the message; then actually commit
3055
3210
            raise errors.BzrCommandError("No changes to commit."
3056
3211
                              " Use --unchanged to commit anyhow.")
3057
3212
        except ConflictsInTree:
3062
3217
            raise errors.BzrCommandError("Commit refused because there are"
3063
3218
                              " unknown files in the working tree.")
3064
3219
        except errors.BoundBranchOutOfDate, e:
3065
 
            raise errors.BzrCommandError(str(e) + "\n"
3066
 
            'To commit to master branch, run update and then commit.\n'
3067
 
            'You can also pass --local to commit to continue working '
3068
 
            'disconnected.')
 
3220
            e.extra_help = ("\n"
 
3221
                'To commit to master branch, run update and then commit.\n'
 
3222
                'You can also pass --local to commit to continue working '
 
3223
                'disconnected.')
 
3224
            raise
3069
3225
 
3070
3226
 
3071
3227
class cmd_check(Command):
3072
 
    """Validate working tree structure, branch consistency and repository history.
 
3228
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3073
3229
 
3074
3230
    This command checks various invariants about branch and repository storage
3075
3231
    to detect data corruption or bzr bugs.
3139
3295
 
3140
3296
 
3141
3297
class cmd_upgrade(Command):
3142
 
    """Upgrade branch storage to current format.
 
3298
    __doc__ = """Upgrade branch storage to current format.
3143
3299
 
3144
3300
    The check command or bzr developers may sometimes advise you to run
3145
3301
    this command. When the default format has changed you may also be warned
3163
3319
 
3164
3320
 
3165
3321
class cmd_whoami(Command):
3166
 
    """Show or set bzr user id.
 
3322
    __doc__ = """Show or set bzr user id.
3167
3323
 
3168
3324
    :Examples:
3169
3325
        Show the email of the current user::
3213
3369
 
3214
3370
 
3215
3371
class cmd_nick(Command):
3216
 
    """Print or set the branch nickname.
 
3372
    __doc__ = """Print or set the branch nickname.
3217
3373
 
3218
3374
    If unset, the tree root directory name is used as the nickname.
3219
3375
    To print the current nickname, execute with no argument.
3233
3389
 
3234
3390
    @display_command
3235
3391
    def printme(self, branch):
3236
 
        print branch.nick
 
3392
        self.outf.write('%s\n' % branch.nick)
3237
3393
 
3238
3394
 
3239
3395
class cmd_alias(Command):
3240
 
    """Set/unset and display aliases.
 
3396
    __doc__ = """Set/unset and display aliases.
3241
3397
 
3242
3398
    :Examples:
3243
3399
        Show the current aliases::
3307
3463
 
3308
3464
 
3309
3465
class cmd_selftest(Command):
3310
 
    """Run internal test suite.
 
3466
    __doc__ = """Run internal test suite.
3311
3467
 
3312
3468
    If arguments are given, they are regular expressions that say which tests
3313
3469
    should run.  Tests matching any expression are run, and other tests are
3340
3496
    Tests that need working space on disk use a common temporary directory,
3341
3497
    typically inside $TMPDIR or /tmp.
3342
3498
 
 
3499
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3500
    into a pdb postmortem session.
 
3501
 
3343
3502
    :Examples:
3344
3503
        Run only tests relating to 'ignore'::
3345
3504
 
3354
3513
    def get_transport_type(typestring):
3355
3514
        """Parse and return a transport specifier."""
3356
3515
        if typestring == "sftp":
3357
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3358
 
            return SFTPAbsoluteServer
 
3516
            from bzrlib.tests import stub_sftp
 
3517
            return stub_sftp.SFTPAbsoluteServer
3359
3518
        if typestring == "memory":
3360
 
            from bzrlib.transport.memory import MemoryServer
3361
 
            return MemoryServer
 
3519
            from bzrlib.tests import test_server
 
3520
            return memory.MemoryServer
3362
3521
        if typestring == "fakenfs":
3363
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3364
 
            return FakeNFSServer
 
3522
            from bzrlib.tests import test_server
 
3523
            return test_server.FakeNFSServer
3365
3524
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3366
3525
            (typestring)
3367
3526
        raise errors.BzrCommandError(msg)
3451
3610
                raise errors.BzrCommandError("subunit not available. subunit "
3452
3611
                    "needs to be installed to use --subunit.")
3453
3612
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3613
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3614
            # stdout, which would corrupt the subunit stream. 
 
3615
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3616
                import msvcrt
 
3617
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3454
3618
        if parallel:
3455
3619
            self.additional_selftest_args.setdefault(
3456
3620
                'suite_decorators', []).append(parallel)
3460
3624
            verbose = not is_quiet()
3461
3625
            # TODO: should possibly lock the history file...
3462
3626
            benchfile = open(".perf_history", "at", buffering=1)
 
3627
            self.add_cleanup(benchfile.close)
3463
3628
        else:
3464
3629
            test_suite_factory = None
3465
3630
            benchfile = None
3466
 
        try:
3467
 
            selftest_kwargs = {"verbose": verbose,
3468
 
                              "pattern": pattern,
3469
 
                              "stop_on_failure": one,
3470
 
                              "transport": transport,
3471
 
                              "test_suite_factory": test_suite_factory,
3472
 
                              "lsprof_timed": lsprof_timed,
3473
 
                              "lsprof_tests": lsprof_tests,
3474
 
                              "bench_history": benchfile,
3475
 
                              "matching_tests_first": first,
3476
 
                              "list_only": list_only,
3477
 
                              "random_seed": randomize,
3478
 
                              "exclude_pattern": exclude,
3479
 
                              "strict": strict,
3480
 
                              "load_list": load_list,
3481
 
                              "debug_flags": debugflag,
3482
 
                              "starting_with": starting_with
3483
 
                              }
3484
 
            selftest_kwargs.update(self.additional_selftest_args)
3485
 
            result = selftest(**selftest_kwargs)
3486
 
        finally:
3487
 
            if benchfile is not None:
3488
 
                benchfile.close()
 
3631
        selftest_kwargs = {"verbose": verbose,
 
3632
                          "pattern": pattern,
 
3633
                          "stop_on_failure": one,
 
3634
                          "transport": transport,
 
3635
                          "test_suite_factory": test_suite_factory,
 
3636
                          "lsprof_timed": lsprof_timed,
 
3637
                          "lsprof_tests": lsprof_tests,
 
3638
                          "bench_history": benchfile,
 
3639
                          "matching_tests_first": first,
 
3640
                          "list_only": list_only,
 
3641
                          "random_seed": randomize,
 
3642
                          "exclude_pattern": exclude,
 
3643
                          "strict": strict,
 
3644
                          "load_list": load_list,
 
3645
                          "debug_flags": debugflag,
 
3646
                          "starting_with": starting_with
 
3647
                          }
 
3648
        selftest_kwargs.update(self.additional_selftest_args)
 
3649
        result = selftest(**selftest_kwargs)
3489
3650
        return int(not result)
3490
3651
 
3491
3652
 
3492
3653
class cmd_version(Command):
3493
 
    """Show version of bzr."""
 
3654
    __doc__ = """Show version of bzr."""
3494
3655
 
3495
3656
    encoding_type = 'replace'
3496
3657
    takes_options = [
3507
3668
 
3508
3669
 
3509
3670
class cmd_rocks(Command):
3510
 
    """Statement of optimism."""
 
3671
    __doc__ = """Statement of optimism."""
3511
3672
 
3512
3673
    hidden = True
3513
3674
 
3514
3675
    @display_command
3515
3676
    def run(self):
3516
 
        print "It sure does!"
 
3677
        self.outf.write("It sure does!\n")
3517
3678
 
3518
3679
 
3519
3680
class cmd_find_merge_base(Command):
3520
 
    """Find and print a base revision for merging two branches."""
 
3681
    __doc__ = """Find and print a base revision for merging two branches."""
3521
3682
    # TODO: Options to specify revisions on either side, as if
3522
3683
    #       merging only part of the history.
3523
3684
    takes_args = ['branch', 'other']
3530
3691
        branch1 = Branch.open_containing(branch)[0]
3531
3692
        branch2 = Branch.open_containing(other)[0]
3532
3693
        branch1.lock_read()
3533
 
        try:
3534
 
            branch2.lock_read()
3535
 
            try:
3536
 
                last1 = ensure_null(branch1.last_revision())
3537
 
                last2 = ensure_null(branch2.last_revision())
3538
 
 
3539
 
                graph = branch1.repository.get_graph(branch2.repository)
3540
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3541
 
 
3542
 
                print 'merge base is revision %s' % base_rev_id
3543
 
            finally:
3544
 
                branch2.unlock()
3545
 
        finally:
3546
 
            branch1.unlock()
 
3694
        self.add_cleanup(branch1.unlock)
 
3695
        branch2.lock_read()
 
3696
        self.add_cleanup(branch2.unlock)
 
3697
        last1 = ensure_null(branch1.last_revision())
 
3698
        last2 = ensure_null(branch2.last_revision())
 
3699
 
 
3700
        graph = branch1.repository.get_graph(branch2.repository)
 
3701
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3702
 
 
3703
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3547
3704
 
3548
3705
 
3549
3706
class cmd_merge(Command):
3550
 
    """Perform a three-way merge.
 
3707
    __doc__ = """Perform a three-way merge.
3551
3708
 
3552
3709
    The source of the merge can be specified either in the form of a branch,
3553
3710
    or in the form of a path to a file containing a merge directive generated
3582
3739
    committed to record the result of the merge.
3583
3740
 
3584
3741
    merge refuses to run if there are any uncommitted changes, unless
3585
 
    --force is given.
 
3742
    --force is given. The --force option can also be used to create a
 
3743
    merge revision which has more than two parents.
 
3744
 
 
3745
    If one would like to merge changes from the working tree of the other
 
3746
    branch without merging any committed revisions, the --uncommitted option
 
3747
    can be given.
3586
3748
 
3587
3749
    To select only some changes to merge, use "merge -i", which will prompt
3588
3750
    you to apply each diff hunk and file change, similar to "shelve".
3600
3762
 
3601
3763
            bzr merge -r 81..82 ../bzr.dev
3602
3764
 
3603
 
        To apply a merge directive contained in /tmp/merge:
 
3765
        To apply a merge directive contained in /tmp/merge::
3604
3766
 
3605
3767
            bzr merge /tmp/merge
 
3768
 
 
3769
        To create a merge revision with three parents from two branches
 
3770
        feature1a and feature1b:
 
3771
 
 
3772
            bzr merge ../feature1a
 
3773
            bzr merge ../feature1b --force
 
3774
            bzr commit -m 'revision with three parents'
3606
3775
    """
3607
3776
 
3608
3777
    encoding_type = 'exact'
3653
3822
        verified = 'inapplicable'
3654
3823
        tree = WorkingTree.open_containing(directory)[0]
3655
3824
 
3656
 
        # die as quickly as possible if there are uncommitted changes
3657
3825
        try:
3658
3826
            basis_tree = tree.revision_tree(tree.last_revision())
3659
3827
        except errors.NoSuchRevision:
3660
3828
            basis_tree = tree.basis_tree()
 
3829
 
 
3830
        # die as quickly as possible if there are uncommitted changes
3661
3831
        if not force:
3662
 
            if tree.has_changes(basis_tree):
 
3832
            if tree.has_changes():
3663
3833
                raise errors.UncommittedChanges(tree)
3664
3834
 
3665
3835
        view_info = _get_view_info_for_change_reporter(tree)
3666
3836
        change_reporter = delta._ChangeReporter(
3667
3837
            unversioned_filter=tree.is_ignored, view_info=view_info)
3668
 
        cleanups = []
3669
 
        try:
3670
 
            pb = ui.ui_factory.nested_progress_bar()
3671
 
            cleanups.append(pb.finished)
3672
 
            tree.lock_write()
3673
 
            cleanups.append(tree.unlock)
3674
 
            if location is not None:
3675
 
                try:
3676
 
                    mergeable = bundle.read_mergeable_from_url(location,
3677
 
                        possible_transports=possible_transports)
3678
 
                except errors.NotABundle:
3679
 
                    mergeable = None
3680
 
                else:
3681
 
                    if uncommitted:
3682
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3683
 
                            ' with bundles or merge directives.')
3684
 
 
3685
 
                    if revision is not None:
3686
 
                        raise errors.BzrCommandError(
3687
 
                            'Cannot use -r with merge directives or bundles')
3688
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3689
 
                       mergeable, pb)
3690
 
 
3691
 
            if merger is None and uncommitted:
3692
 
                if revision is not None and len(revision) > 0:
3693
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3694
 
                        ' --revision at the same time.')
3695
 
                merger = self.get_merger_from_uncommitted(tree, location, pb,
3696
 
                                                          cleanups)
3697
 
                allow_pending = False
3698
 
 
3699
 
            if merger is None:
3700
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3701
 
                    location, revision, remember, possible_transports, pb)
3702
 
 
3703
 
            merger.merge_type = merge_type
3704
 
            merger.reprocess = reprocess
3705
 
            merger.show_base = show_base
3706
 
            self.sanity_check_merger(merger)
3707
 
            if (merger.base_rev_id == merger.other_rev_id and
3708
 
                merger.other_rev_id is not None):
3709
 
                note('Nothing to do.')
 
3838
        pb = ui.ui_factory.nested_progress_bar()
 
3839
        self.add_cleanup(pb.finished)
 
3840
        tree.lock_write()
 
3841
        self.add_cleanup(tree.unlock)
 
3842
        if location is not None:
 
3843
            try:
 
3844
                mergeable = bundle.read_mergeable_from_url(location,
 
3845
                    possible_transports=possible_transports)
 
3846
            except errors.NotABundle:
 
3847
                mergeable = None
 
3848
            else:
 
3849
                if uncommitted:
 
3850
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3851
                        ' with bundles or merge directives.')
 
3852
 
 
3853
                if revision is not None:
 
3854
                    raise errors.BzrCommandError(
 
3855
                        'Cannot use -r with merge directives or bundles')
 
3856
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3857
                   mergeable, None)
 
3858
 
 
3859
        if merger is None and uncommitted:
 
3860
            if revision is not None and len(revision) > 0:
 
3861
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3862
                    ' --revision at the same time.')
 
3863
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3864
            allow_pending = False
 
3865
 
 
3866
        if merger is None:
 
3867
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3868
                location, revision, remember, possible_transports, None)
 
3869
 
 
3870
        merger.merge_type = merge_type
 
3871
        merger.reprocess = reprocess
 
3872
        merger.show_base = show_base
 
3873
        self.sanity_check_merger(merger)
 
3874
        if (merger.base_rev_id == merger.other_rev_id and
 
3875
            merger.other_rev_id is not None):
 
3876
            note('Nothing to do.')
 
3877
            return 0
 
3878
        if pull:
 
3879
            if merger.interesting_files is not None:
 
3880
                raise errors.BzrCommandError('Cannot pull individual files')
 
3881
            if (merger.base_rev_id == tree.last_revision()):
 
3882
                result = tree.pull(merger.other_branch, False,
 
3883
                                   merger.other_rev_id)
 
3884
                result.report(self.outf)
3710
3885
                return 0
3711
 
            if pull:
3712
 
                if merger.interesting_files is not None:
3713
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3714
 
                if (merger.base_rev_id == tree.last_revision()):
3715
 
                    result = tree.pull(merger.other_branch, False,
3716
 
                                       merger.other_rev_id)
3717
 
                    result.report(self.outf)
3718
 
                    return 0
3719
 
            merger.check_basis(False)
3720
 
            if preview:
3721
 
                return self._do_preview(merger, cleanups)
3722
 
            elif interactive:
3723
 
                return self._do_interactive(merger, cleanups)
3724
 
            else:
3725
 
                return self._do_merge(merger, change_reporter, allow_pending,
3726
 
                                      verified)
3727
 
        finally:
3728
 
            for cleanup in reversed(cleanups):
3729
 
                cleanup()
 
3886
        if merger.this_basis is None:
 
3887
            raise errors.BzrCommandError(
 
3888
                "This branch has no commits."
 
3889
                " (perhaps you would prefer 'bzr pull')")
 
3890
        if preview:
 
3891
            return self._do_preview(merger)
 
3892
        elif interactive:
 
3893
            return self._do_interactive(merger)
 
3894
        else:
 
3895
            return self._do_merge(merger, change_reporter, allow_pending,
 
3896
                                  verified)
3730
3897
 
3731
 
    def _get_preview(self, merger, cleanups):
 
3898
    def _get_preview(self, merger):
3732
3899
        tree_merger = merger.make_merger()
3733
3900
        tt = tree_merger.make_preview_transform()
3734
 
        cleanups.append(tt.finalize)
 
3901
        self.add_cleanup(tt.finalize)
3735
3902
        result_tree = tt.get_preview_tree()
3736
3903
        return result_tree
3737
3904
 
3738
 
    def _do_preview(self, merger, cleanups):
 
3905
    def _do_preview(self, merger):
3739
3906
        from bzrlib.diff import show_diff_trees
3740
 
        result_tree = self._get_preview(merger, cleanups)
 
3907
        result_tree = self._get_preview(merger)
3741
3908
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3742
3909
                        old_label='', new_label='')
3743
3910
 
3753
3920
        else:
3754
3921
            return 0
3755
3922
 
3756
 
    def _do_interactive(self, merger, cleanups):
 
3923
    def _do_interactive(self, merger):
3757
3924
        """Perform an interactive merge.
3758
3925
 
3759
3926
        This works by generating a preview tree of the merge, then using
3761
3928
        and the preview tree.
3762
3929
        """
3763
3930
        from bzrlib import shelf_ui
3764
 
        result_tree = self._get_preview(merger, cleanups)
 
3931
        result_tree = self._get_preview(merger)
3765
3932
        writer = bzrlib.option.diff_writer_registry.get()
3766
3933
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3767
3934
                                   reporter=shelf_ui.ApplyReporter(),
3768
3935
                                   diff_writer=writer(sys.stdout))
3769
 
        shelver.run()
 
3936
        try:
 
3937
            shelver.run()
 
3938
        finally:
 
3939
            shelver.finalize()
3770
3940
 
3771
3941
    def sanity_check_merger(self, merger):
3772
3942
        if (merger.show_base and
3832
4002
            allow_pending = True
3833
4003
        return merger, allow_pending
3834
4004
 
3835
 
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
4005
    def get_merger_from_uncommitted(self, tree, location, pb):
3836
4006
        """Get a merger for uncommitted changes.
3837
4007
 
3838
4008
        :param tree: The tree the merger should apply to.
3839
4009
        :param location: The location containing uncommitted changes.
3840
4010
        :param pb: The progress bar to use for showing progress.
3841
 
        :param cleanups: A list of operations to perform to clean up the
3842
 
            temporary directories, unfinalized objects, etc.
3843
4011
        """
3844
4012
        location = self._select_branch_location(tree, location)[0]
3845
4013
        other_tree, other_path = WorkingTree.open_containing(location)
3897
4065
 
3898
4066
 
3899
4067
class cmd_remerge(Command):
3900
 
    """Redo a merge.
 
4068
    __doc__ = """Redo a merge.
3901
4069
 
3902
4070
    Use this if you want to try a different merge technique while resolving
3903
4071
    conflicts.  Some merge techniques are better than others, and remerge
3928
4096
 
3929
4097
    def run(self, file_list=None, merge_type=None, show_base=False,
3930
4098
            reprocess=False):
 
4099
        from bzrlib.conflicts import restore
3931
4100
        if merge_type is None:
3932
4101
            merge_type = _mod_merge.Merge3Merger
3933
4102
        tree, file_list = tree_files(file_list)
3934
4103
        tree.lock_write()
3935
 
        try:
3936
 
            parents = tree.get_parent_ids()
3937
 
            if len(parents) != 2:
3938
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3939
 
                                             " merges.  Not cherrypicking or"
3940
 
                                             " multi-merges.")
3941
 
            repository = tree.branch.repository
3942
 
            interesting_ids = None
3943
 
            new_conflicts = []
3944
 
            conflicts = tree.conflicts()
3945
 
            if file_list is not None:
3946
 
                interesting_ids = set()
3947
 
                for filename in file_list:
3948
 
                    file_id = tree.path2id(filename)
3949
 
                    if file_id is None:
3950
 
                        raise errors.NotVersionedError(filename)
3951
 
                    interesting_ids.add(file_id)
3952
 
                    if tree.kind(file_id) != "directory":
3953
 
                        continue
 
4104
        self.add_cleanup(tree.unlock)
 
4105
        parents = tree.get_parent_ids()
 
4106
        if len(parents) != 2:
 
4107
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4108
                                         " merges.  Not cherrypicking or"
 
4109
                                         " multi-merges.")
 
4110
        repository = tree.branch.repository
 
4111
        interesting_ids = None
 
4112
        new_conflicts = []
 
4113
        conflicts = tree.conflicts()
 
4114
        if file_list is not None:
 
4115
            interesting_ids = set()
 
4116
            for filename in file_list:
 
4117
                file_id = tree.path2id(filename)
 
4118
                if file_id is None:
 
4119
                    raise errors.NotVersionedError(filename)
 
4120
                interesting_ids.add(file_id)
 
4121
                if tree.kind(file_id) != "directory":
 
4122
                    continue
3954
4123
 
3955
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3956
 
                        interesting_ids.add(ie.file_id)
3957
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3958
 
            else:
3959
 
                # Remerge only supports resolving contents conflicts
3960
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3961
 
                restore_files = [c.path for c in conflicts
3962
 
                                 if c.typestring in allowed_conflicts]
3963
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3964
 
            tree.set_conflicts(ConflictList(new_conflicts))
3965
 
            if file_list is not None:
3966
 
                restore_files = file_list
3967
 
            for filename in restore_files:
3968
 
                try:
3969
 
                    restore(tree.abspath(filename))
3970
 
                except errors.NotConflicted:
3971
 
                    pass
3972
 
            # Disable pending merges, because the file texts we are remerging
3973
 
            # have not had those merges performed.  If we use the wrong parents
3974
 
            # list, we imply that the working tree text has seen and rejected
3975
 
            # all the changes from the other tree, when in fact those changes
3976
 
            # have not yet been seen.
3977
 
            pb = ui.ui_factory.nested_progress_bar()
3978
 
            tree.set_parent_ids(parents[:1])
 
4124
                for name, ie in tree.inventory.iter_entries(file_id):
 
4125
                    interesting_ids.add(ie.file_id)
 
4126
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4127
        else:
 
4128
            # Remerge only supports resolving contents conflicts
 
4129
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4130
            restore_files = [c.path for c in conflicts
 
4131
                             if c.typestring in allowed_conflicts]
 
4132
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4133
        tree.set_conflicts(ConflictList(new_conflicts))
 
4134
        if file_list is not None:
 
4135
            restore_files = file_list
 
4136
        for filename in restore_files:
3979
4137
            try:
3980
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3981
 
                                                             tree, parents[1])
3982
 
                merger.interesting_ids = interesting_ids
3983
 
                merger.merge_type = merge_type
3984
 
                merger.show_base = show_base
3985
 
                merger.reprocess = reprocess
3986
 
                conflicts = merger.do_merge()
3987
 
            finally:
3988
 
                tree.set_parent_ids(parents)
3989
 
                pb.finished()
 
4138
                restore(tree.abspath(filename))
 
4139
            except errors.NotConflicted:
 
4140
                pass
 
4141
        # Disable pending merges, because the file texts we are remerging
 
4142
        # have not had those merges performed.  If we use the wrong parents
 
4143
        # list, we imply that the working tree text has seen and rejected
 
4144
        # all the changes from the other tree, when in fact those changes
 
4145
        # have not yet been seen.
 
4146
        tree.set_parent_ids(parents[:1])
 
4147
        try:
 
4148
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4149
            merger.interesting_ids = interesting_ids
 
4150
            merger.merge_type = merge_type
 
4151
            merger.show_base = show_base
 
4152
            merger.reprocess = reprocess
 
4153
            conflicts = merger.do_merge()
3990
4154
        finally:
3991
 
            tree.unlock()
 
4155
            tree.set_parent_ids(parents)
3992
4156
        if conflicts > 0:
3993
4157
            return 1
3994
4158
        else:
3996
4160
 
3997
4161
 
3998
4162
class cmd_revert(Command):
3999
 
    """Revert files to a previous revision.
 
4163
    __doc__ = """Revert files to a previous revision.
4000
4164
 
4001
4165
    Giving a list of files will revert only those files.  Otherwise, all files
4002
4166
    will be reverted.  If the revision is not specified with '--revision', the
4016
4180
    name.  If you name a directory, all the contents of that directory will be
4017
4181
    reverted.
4018
4182
 
4019
 
    Any files that have been newly added since that revision will be deleted,
4020
 
    with a backup kept if appropriate.  Directories containing unknown files
4021
 
    will not be deleted.
 
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.
4022
4187
 
4023
 
    The working tree contains a list of pending merged revisions, which will
4024
 
    be included as parents in the next commit.  Normally, revert clears that
4025
 
    list as well as reverting the files.  If any files are specified, revert
4026
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
4027
 
    revert ." in the tree root to revert all files but keep the merge record,
4028
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4188
    The working tree contains a list of revisions that have been merged but
 
4189
    not yet committed. These revisions will be included as additional parents
 
4190
    of the next commit.  Normally, using revert clears that list as well as
 
4191
    reverting the files.  If any files are specified, revert leaves the list
 
4192
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4193
    .`` in the tree root to revert all files but keep the recorded merges,
 
4194
    and ``bzr revert --forget-merges`` to clear the pending merge list without
4029
4195
    reverting any files.
 
4196
 
 
4197
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4198
    changes from a branch in a single revision.  To do this, perform the merge
 
4199
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4200
    the content of the tree as it was, but it will clear the list of pending
 
4201
    merges.  The next commit will then contain all of the changes that are
 
4202
    present in the other branch, but without any other parent revisions.
 
4203
    Because this technique forgets where these changes originated, it may
 
4204
    cause additional conflicts on later merges involving the same source and
 
4205
    target branches.
4030
4206
    """
4031
4207
 
4032
4208
    _see_also = ['cat', 'export']
4041
4217
    def run(self, revision=None, no_backup=False, file_list=None,
4042
4218
            forget_merges=None):
4043
4219
        tree, file_list = tree_files(file_list)
4044
 
        tree.lock_write()
4045
 
        try:
4046
 
            if forget_merges:
4047
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
4048
 
            else:
4049
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4050
 
        finally:
4051
 
            tree.unlock()
 
4220
        tree.lock_tree_write()
 
4221
        self.add_cleanup(tree.unlock)
 
4222
        if forget_merges:
 
4223
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4224
        else:
 
4225
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4052
4226
 
4053
4227
    @staticmethod
4054
4228
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4055
4229
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4056
 
        pb = ui.ui_factory.nested_progress_bar()
4057
 
        try:
4058
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
4059
 
                report_changes=True)
4060
 
        finally:
4061
 
            pb.finished()
 
4230
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4231
            report_changes=True)
4062
4232
 
4063
4233
 
4064
4234
class cmd_assert_fail(Command):
4065
 
    """Test reporting of assertion failures"""
 
4235
    __doc__ = """Test reporting of assertion failures"""
4066
4236
    # intended just for use in testing
4067
4237
 
4068
4238
    hidden = True
4072
4242
 
4073
4243
 
4074
4244
class cmd_help(Command):
4075
 
    """Show help on a command or other topic.
 
4245
    __doc__ = """Show help on a command or other topic.
4076
4246
    """
4077
4247
 
4078
4248
    _see_also = ['topics']
4091
4261
 
4092
4262
 
4093
4263
class cmd_shell_complete(Command):
4094
 
    """Show appropriate completions for context.
 
4264
    __doc__ = """Show appropriate completions for context.
4095
4265
 
4096
4266
    For a list of all available commands, say 'bzr shell-complete'.
4097
4267
    """
4106
4276
 
4107
4277
 
4108
4278
class cmd_missing(Command):
4109
 
    """Show unmerged/unpulled revisions between two branches.
 
4279
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4110
4280
 
4111
4281
    OTHER_BRANCH may be local or remote.
4112
4282
 
4113
4283
    To filter on a range of revisions, you can use the command -r begin..end
4114
4284
    -r revision requests a specific revision, -r ..end or -r begin.. are
4115
4285
    also valid.
 
4286
            
 
4287
    :Exit values:
 
4288
        1 - some missing revisions
 
4289
        0 - no missing revisions
4116
4290
 
4117
4291
    :Examples:
4118
4292
 
4186
4360
            restrict = 'remote'
4187
4361
 
4188
4362
        local_branch = Branch.open_containing(u".")[0]
 
4363
        local_branch.lock_read()
 
4364
        self.add_cleanup(local_branch.unlock)
 
4365
 
4189
4366
        parent = local_branch.get_parent()
4190
4367
        if other_branch is None:
4191
4368
            other_branch = parent
4200
4377
        remote_branch = Branch.open(other_branch)
4201
4378
        if remote_branch.base == local_branch.base:
4202
4379
            remote_branch = local_branch
 
4380
        else:
 
4381
            remote_branch.lock_read()
 
4382
            self.add_cleanup(remote_branch.unlock)
4203
4383
 
4204
4384
        local_revid_range = _revision_range_to_revid_range(
4205
4385
            _get_revision_range(my_revision, local_branch,
4209
4389
            _get_revision_range(revision,
4210
4390
                remote_branch, self.name()))
4211
4391
 
4212
 
        local_branch.lock_read()
4213
 
        try:
4214
 
            remote_branch.lock_read()
4215
 
            try:
4216
 
                local_extra, remote_extra = find_unmerged(
4217
 
                    local_branch, remote_branch, restrict,
4218
 
                    backward=not reverse,
4219
 
                    include_merges=include_merges,
4220
 
                    local_revid_range=local_revid_range,
4221
 
                    remote_revid_range=remote_revid_range)
4222
 
 
4223
 
                if log_format is None:
4224
 
                    registry = log.log_formatter_registry
4225
 
                    log_format = registry.get_default(local_branch)
4226
 
                lf = log_format(to_file=self.outf,
4227
 
                                show_ids=show_ids,
4228
 
                                show_timezone='original')
4229
 
 
4230
 
                status_code = 0
4231
 
                if local_extra and not theirs_only:
4232
 
                    message("You have %d extra revision(s):\n" %
4233
 
                        len(local_extra))
4234
 
                    for revision in iter_log_revisions(local_extra,
4235
 
                                        local_branch.repository,
4236
 
                                        verbose):
4237
 
                        lf.log_revision(revision)
4238
 
                    printed_local = True
4239
 
                    status_code = 1
4240
 
                else:
4241
 
                    printed_local = False
4242
 
 
4243
 
                if remote_extra and not mine_only:
4244
 
                    if printed_local is True:
4245
 
                        message("\n\n\n")
4246
 
                    message("You are missing %d revision(s):\n" %
4247
 
                        len(remote_extra))
4248
 
                    for revision in iter_log_revisions(remote_extra,
4249
 
                                        remote_branch.repository,
4250
 
                                        verbose):
4251
 
                        lf.log_revision(revision)
4252
 
                    status_code = 1
4253
 
 
4254
 
                if mine_only and not local_extra:
4255
 
                    # We checked local, and found nothing extra
4256
 
                    message('This branch is up to date.\n')
4257
 
                elif theirs_only and not remote_extra:
4258
 
                    # We checked remote, and found nothing extra
4259
 
                    message('Other branch is up to date.\n')
4260
 
                elif not (mine_only or theirs_only or local_extra or
4261
 
                          remote_extra):
4262
 
                    # We checked both branches, and neither one had extra
4263
 
                    # revisions
4264
 
                    message("Branches are up to date.\n")
4265
 
            finally:
4266
 
                remote_branch.unlock()
4267
 
        finally:
4268
 
            local_branch.unlock()
 
4392
        local_extra, remote_extra = find_unmerged(
 
4393
            local_branch, remote_branch, restrict,
 
4394
            backward=not reverse,
 
4395
            include_merges=include_merges,
 
4396
            local_revid_range=local_revid_range,
 
4397
            remote_revid_range=remote_revid_range)
 
4398
 
 
4399
        if log_format is None:
 
4400
            registry = log.log_formatter_registry
 
4401
            log_format = registry.get_default(local_branch)
 
4402
        lf = log_format(to_file=self.outf,
 
4403
                        show_ids=show_ids,
 
4404
                        show_timezone='original')
 
4405
 
 
4406
        status_code = 0
 
4407
        if local_extra and not theirs_only:
 
4408
            message("You have %d extra revision(s):\n" %
 
4409
                len(local_extra))
 
4410
            for revision in iter_log_revisions(local_extra,
 
4411
                                local_branch.repository,
 
4412
                                verbose):
 
4413
                lf.log_revision(revision)
 
4414
            printed_local = True
 
4415
            status_code = 1
 
4416
        else:
 
4417
            printed_local = False
 
4418
 
 
4419
        if remote_extra and not mine_only:
 
4420
            if printed_local is True:
 
4421
                message("\n\n\n")
 
4422
            message("You are missing %d revision(s):\n" %
 
4423
                len(remote_extra))
 
4424
            for revision in iter_log_revisions(remote_extra,
 
4425
                                remote_branch.repository,
 
4426
                                verbose):
 
4427
                lf.log_revision(revision)
 
4428
            status_code = 1
 
4429
 
 
4430
        if mine_only and not local_extra:
 
4431
            # We checked local, and found nothing extra
 
4432
            message('This branch is up to date.\n')
 
4433
        elif theirs_only and not remote_extra:
 
4434
            # We checked remote, and found nothing extra
 
4435
            message('Other branch is up to date.\n')
 
4436
        elif not (mine_only or theirs_only or local_extra or
 
4437
                  remote_extra):
 
4438
            # We checked both branches, and neither one had extra
 
4439
            # revisions
 
4440
            message("Branches are up to date.\n")
 
4441
        self.cleanup_now()
4269
4442
        if not status_code and parent is None and other_branch is not None:
4270
4443
            local_branch.lock_write()
4271
 
            try:
4272
 
                # handle race conditions - a parent might be set while we run.
4273
 
                if local_branch.get_parent() is None:
4274
 
                    local_branch.set_parent(remote_branch.base)
4275
 
            finally:
4276
 
                local_branch.unlock()
 
4444
            self.add_cleanup(local_branch.unlock)
 
4445
            # handle race conditions - a parent might be set while we run.
 
4446
            if local_branch.get_parent() is None:
 
4447
                local_branch.set_parent(remote_branch.base)
4277
4448
        return status_code
4278
4449
 
4279
4450
 
4280
4451
class cmd_pack(Command):
4281
 
    """Compress the data within a repository."""
 
4452
    __doc__ = """Compress the data within a repository.
 
4453
 
 
4454
    This operation compresses the data within a bazaar repository. As
 
4455
    bazaar supports automatic packing of repository, this operation is
 
4456
    normally not required to be done manually.
 
4457
 
 
4458
    During the pack operation, bazaar takes a backup of existing repository
 
4459
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4460
    automatically when it is safe to do so. To save disk space by removing
 
4461
    the backed up pack files, the --clean-obsolete-packs option may be
 
4462
    used.
 
4463
 
 
4464
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4465
    during or immediately after repacking, you may be left with a state
 
4466
    where the deletion has been written to disk but the new packs have not
 
4467
    been. In this case the repository may be unusable.
 
4468
    """
4282
4469
 
4283
4470
    _see_also = ['repositories']
4284
4471
    takes_args = ['branch_or_repo?']
 
4472
    takes_options = [
 
4473
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4474
        ]
4285
4475
 
4286
 
    def run(self, branch_or_repo='.'):
 
4476
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4287
4477
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4288
4478
        try:
4289
4479
            branch = dir.open_branch()
4290
4480
            repository = branch.repository
4291
4481
        except errors.NotBranchError:
4292
4482
            repository = dir.open_repository()
4293
 
        repository.pack()
 
4483
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4294
4484
 
4295
4485
 
4296
4486
class cmd_plugins(Command):
4297
 
    """List the installed plugins.
 
4487
    __doc__ = """List the installed plugins.
4298
4488
 
4299
4489
    This command displays the list of installed plugins including
4300
4490
    version of plugin and a short description of each.
4307
4497
    adding new commands, providing additional network transports and
4308
4498
    customizing log output.
4309
4499
 
4310
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4311
 
    information on plugins including where to find them and how to
4312
 
    install them. Instructions are also provided there on how to
4313
 
    write new plugins using the Python programming language.
 
4500
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4501
    for further information on plugins including where to find them and how to
 
4502
    install them. Instructions are also provided there on how to write new
 
4503
    plugins using the Python programming language.
4314
4504
    """
4315
4505
    takes_options = ['verbose']
4316
4506
 
4331
4521
                doc = '(no description)'
4332
4522
            result.append((name_ver, doc, plugin.path()))
4333
4523
        for name_ver, doc, path in sorted(result):
4334
 
            print name_ver
4335
 
            print '   ', doc
 
4524
            self.outf.write("%s\n" % name_ver)
 
4525
            self.outf.write("   %s\n" % doc)
4336
4526
            if verbose:
4337
 
                print '   ', path
4338
 
            print
 
4527
                self.outf.write("   %s\n" % path)
 
4528
            self.outf.write("\n")
4339
4529
 
4340
4530
 
4341
4531
class cmd_testament(Command):
4342
 
    """Show testament (signing-form) of a revision."""
 
4532
    __doc__ = """Show testament (signing-form) of a revision."""
4343
4533
    takes_options = [
4344
4534
            'revision',
4345
4535
            Option('long', help='Produce long-format testament.'),
4358
4548
        else:
4359
4549
            b = Branch.open(branch)
4360
4550
        b.lock_read()
4361
 
        try:
4362
 
            if revision is None:
4363
 
                rev_id = b.last_revision()
4364
 
            else:
4365
 
                rev_id = revision[0].as_revision_id(b)
4366
 
            t = testament_class.from_revision(b.repository, rev_id)
4367
 
            if long:
4368
 
                sys.stdout.writelines(t.as_text_lines())
4369
 
            else:
4370
 
                sys.stdout.write(t.as_short_text())
4371
 
        finally:
4372
 
            b.unlock()
 
4551
        self.add_cleanup(b.unlock)
 
4552
        if revision is None:
 
4553
            rev_id = b.last_revision()
 
4554
        else:
 
4555
            rev_id = revision[0].as_revision_id(b)
 
4556
        t = testament_class.from_revision(b.repository, rev_id)
 
4557
        if long:
 
4558
            sys.stdout.writelines(t.as_text_lines())
 
4559
        else:
 
4560
            sys.stdout.write(t.as_short_text())
4373
4561
 
4374
4562
 
4375
4563
class cmd_annotate(Command):
4376
 
    """Show the origin of each line in a file.
 
4564
    __doc__ = """Show the origin of each line in a file.
4377
4565
 
4378
4566
    This prints out the given file with an annotation on the left side
4379
4567
    indicating which revision, author and date introduced the change.
4401
4589
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4402
4590
        if wt is not None:
4403
4591
            wt.lock_read()
 
4592
            self.add_cleanup(wt.unlock)
4404
4593
        else:
4405
4594
            branch.lock_read()
4406
 
        try:
4407
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4408
 
            if wt is not None:
4409
 
                file_id = wt.path2id(relpath)
4410
 
            else:
4411
 
                file_id = tree.path2id(relpath)
4412
 
            if file_id is None:
4413
 
                raise errors.NotVersionedError(filename)
4414
 
            file_version = tree.inventory[file_id].revision
4415
 
            if wt is not None and revision is None:
4416
 
                # If there is a tree and we're not annotating historical
4417
 
                # versions, annotate the working tree's content.
4418
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4419
 
                    show_ids=show_ids)
4420
 
            else:
4421
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4422
 
                              show_ids=show_ids)
4423
 
        finally:
4424
 
            if wt is not None:
4425
 
                wt.unlock()
4426
 
            else:
4427
 
                branch.unlock()
 
4595
            self.add_cleanup(branch.unlock)
 
4596
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4597
        tree.lock_read()
 
4598
        self.add_cleanup(tree.unlock)
 
4599
        if wt is not None:
 
4600
            file_id = wt.path2id(relpath)
 
4601
        else:
 
4602
            file_id = tree.path2id(relpath)
 
4603
        if file_id is None:
 
4604
            raise errors.NotVersionedError(filename)
 
4605
        file_version = tree.inventory[file_id].revision
 
4606
        if wt is not None and revision is None:
 
4607
            # If there is a tree and we're not annotating historical
 
4608
            # versions, annotate the working tree's content.
 
4609
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4610
                show_ids=show_ids)
 
4611
        else:
 
4612
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4613
                          show_ids=show_ids)
4428
4614
 
4429
4615
 
4430
4616
class cmd_re_sign(Command):
4431
 
    """Create a digital signature for an existing revision."""
 
4617
    __doc__ = """Create a digital signature for an existing revision."""
4432
4618
    # TODO be able to replace existing ones.
4433
4619
 
4434
4620
    hidden = True # is this right ?
4442
4628
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4443
4629
        b = WorkingTree.open_containing(u'.')[0].branch
4444
4630
        b.lock_write()
4445
 
        try:
4446
 
            return self._run(b, revision_id_list, revision)
4447
 
        finally:
4448
 
            b.unlock()
 
4631
        self.add_cleanup(b.unlock)
 
4632
        return self._run(b, revision_id_list, revision)
4449
4633
 
4450
4634
    def _run(self, b, revision_id_list, revision):
4451
4635
        import bzrlib.gpg as gpg
4496
4680
 
4497
4681
 
4498
4682
class cmd_bind(Command):
4499
 
    """Convert the current branch into a checkout of the supplied branch.
 
4683
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4684
    If no branch is supplied, rebind to the last bound location.
4500
4685
 
4501
4686
    Once converted into a checkout, commits must succeed on the master branch
4502
4687
    before they will be applied to the local branch.
4503
4688
 
4504
4689
    Bound branches use the nickname of its master branch unless it is set
4505
 
    locally, in which case binding will update the the local nickname to be
 
4690
    locally, in which case binding will update the local nickname to be
4506
4691
    that of the master.
4507
4692
    """
4508
4693
 
4520
4705
                    'This format does not remember old locations.')
4521
4706
            else:
4522
4707
                if location is None:
4523
 
                    raise errors.BzrCommandError('No location supplied and no '
4524
 
                        'previous location known')
 
4708
                    if b.get_bound_location() is not None:
 
4709
                        raise errors.BzrCommandError('Branch is already bound')
 
4710
                    else:
 
4711
                        raise errors.BzrCommandError('No location supplied '
 
4712
                            'and no previous location known')
4525
4713
        b_other = Branch.open(location)
4526
4714
        try:
4527
4715
            b.bind(b_other)
4533
4721
 
4534
4722
 
4535
4723
class cmd_unbind(Command):
4536
 
    """Convert the current checkout into a regular branch.
 
4724
    __doc__ = """Convert the current checkout into a regular branch.
4537
4725
 
4538
4726
    After unbinding, the local branch is considered independent and subsequent
4539
4727
    commits will be local only.
4550
4738
 
4551
4739
 
4552
4740
class cmd_uncommit(Command):
4553
 
    """Remove the last committed revision.
 
4741
    __doc__ = """Remove the last committed revision.
4554
4742
 
4555
4743
    --verbose will print out what is being removed.
4556
4744
    --dry-run will go through all the motions, but not actually
4597
4785
 
4598
4786
        if tree is not None:
4599
4787
            tree.lock_write()
 
4788
            self.add_cleanup(tree.unlock)
4600
4789
        else:
4601
4790
            b.lock_write()
4602
 
        try:
4603
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4604
 
                             local=local)
4605
 
        finally:
4606
 
            if tree is not None:
4607
 
                tree.unlock()
4608
 
            else:
4609
 
                b.unlock()
 
4791
            self.add_cleanup(b.unlock)
 
4792
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4610
4793
 
4611
4794
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4612
4795
        from bzrlib.log import log_formatter, show_log
4644
4827
                 end_revision=last_revno)
4645
4828
 
4646
4829
        if dry_run:
4647
 
            print 'Dry-run, pretending to remove the above revisions.'
4648
 
            if not force:
4649
 
                val = raw_input('Press <enter> to continue')
 
4830
            self.outf.write('Dry-run, pretending to remove'
 
4831
                            ' the above revisions.\n')
4650
4832
        else:
4651
 
            print 'The above revision(s) will be removed.'
4652
 
            if not force:
4653
 
                val = raw_input('Are you sure [y/N]? ')
4654
 
                if val.lower() not in ('y', 'yes'):
4655
 
                    print 'Canceled'
4656
 
                    return 0
 
4833
            self.outf.write('The above revision(s) will be removed.\n')
 
4834
 
 
4835
        if not force:
 
4836
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4837
                self.outf.write('Canceled')
 
4838
                return 0
4657
4839
 
4658
4840
        mutter('Uncommitting from {%s} to {%s}',
4659
4841
               last_rev_id, rev_id)
4660
4842
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4661
4843
                 revno=revno, local=local)
4662
 
        note('You can restore the old tip by running:\n'
4663
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4844
        self.outf.write('You can restore the old tip by running:\n'
 
4845
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4664
4846
 
4665
4847
 
4666
4848
class cmd_break_lock(Command):
4667
 
    """Break a dead lock on a repository, branch or working directory.
 
4849
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4668
4850
 
4669
4851
    CAUTION: Locks should only be broken when you are sure that the process
4670
4852
    holding the lock has been stopped.
4671
4853
 
4672
 
    You can get information on what locks are open via the 'bzr info' command.
 
4854
    You can get information on what locks are open via the 'bzr info
 
4855
    [location]' command.
4673
4856
 
4674
4857
    :Examples:
4675
4858
        bzr break-lock
 
4859
        bzr break-lock bzr+ssh://example.com/bzr/foo
4676
4860
    """
4677
4861
    takes_args = ['location?']
4678
4862
 
4687
4871
 
4688
4872
 
4689
4873
class cmd_wait_until_signalled(Command):
4690
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4874
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4691
4875
 
4692
4876
    This just prints a line to signal when it is ready, then blocks on stdin.
4693
4877
    """
4701
4885
 
4702
4886
 
4703
4887
class cmd_serve(Command):
4704
 
    """Run the bzr server."""
 
4888
    __doc__ = """Run the bzr server."""
4705
4889
 
4706
4890
    aliases = ['server']
4707
4891
 
4708
4892
    takes_options = [
4709
4893
        Option('inet',
4710
4894
               help='Serve on stdin/out for use from inetd or sshd.'),
4711
 
        RegistryOption('protocol', 
4712
 
               help="Protocol to serve.", 
 
4895
        RegistryOption('protocol',
 
4896
               help="Protocol to serve.",
4713
4897
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4714
4898
               value_switches=True),
4715
4899
        Option('port',
4724
4908
        Option('allow-writes',
4725
4909
               help='By default the server is a readonly server.  Supplying '
4726
4910
                    '--allow-writes enables write access to the contents of '
4727
 
                    'the served directory and below.'
 
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.'
4728
4916
                ),
4729
4917
        ]
4730
4918
 
4763
4951
 
4764
4952
 
4765
4953
class cmd_join(Command):
4766
 
    """Combine a tree into its containing tree.
 
4954
    __doc__ = """Combine a tree into its containing tree.
4767
4955
 
4768
4956
    This command requires the target tree to be in a rich-root format.
4769
4957
 
4809
4997
 
4810
4998
 
4811
4999
class cmd_split(Command):
4812
 
    """Split a subdirectory of a tree into a separate tree.
 
5000
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4813
5001
 
4814
5002
    This command will produce a target tree in a format that supports
4815
5003
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4835
5023
 
4836
5024
 
4837
5025
class cmd_merge_directive(Command):
4838
 
    """Generate a merge directive for auto-merge tools.
 
5026
    __doc__ = """Generate a merge directive for auto-merge tools.
4839
5027
 
4840
5028
    A directive requests a merge to be performed, and also provides all the
4841
5029
    information necessary to do so.  This means it must either include a
4934
5122
 
4935
5123
 
4936
5124
class cmd_send(Command):
4937
 
    """Mail or create a merge-directive for submitting changes.
 
5125
    __doc__ = """Mail or create a merge-directive for submitting changes.
4938
5126
 
4939
5127
    A merge directive provides many things needed for requesting merges:
4940
5128
 
4946
5134
      directly from the merge directive, without retrieving data from a
4947
5135
      branch.
4948
5136
 
4949
 
    If --no-bundle is specified, then public_branch is needed (and must be
4950
 
    up-to-date), so that the receiver can perform the merge using the
4951
 
    public_branch.  The public_branch is always included if known, so that
4952
 
    people can check it later.
4953
 
 
4954
 
    The submit branch defaults to the parent, but can be overridden.  Both
4955
 
    submit branch and public branch will be remembered if supplied.
4956
 
 
4957
 
    If a public_branch is known for the submit_branch, that public submit
4958
 
    branch is used in the merge instructions.  This means that a local mirror
4959
 
    can be used as your actual submit branch, once you have set public_branch
4960
 
    for that mirror.
 
5137
    `bzr send` creates a compact data set that, when applied using bzr
 
5138
    merge, has the same effect as merging from the source branch.  
 
5139
    
 
5140
    By default the merge directive is self-contained and can be applied to any
 
5141
    branch containing submit_branch in its ancestory without needing access to
 
5142
    the source branch.
 
5143
    
 
5144
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5145
    revisions, but only a structured request to merge from the
 
5146
    public_location.  In that case the public_branch is needed and it must be
 
5147
    up-to-date and accessible to the recipient.  The public_branch is always
 
5148
    included if known, so that people can check it later.
 
5149
 
 
5150
    The submit branch defaults to the parent of the source branch, but can be
 
5151
    overridden.  Both submit branch and public branch will be remembered in
 
5152
    branch.conf the first time they are used for a particular branch.  The
 
5153
    source branch defaults to that containing the working directory, but can
 
5154
    be changed using --from.
 
5155
 
 
5156
    In order to calculate those changes, bzr must analyse the submit branch.
 
5157
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5158
    If a public location is known for the submit_branch, that location is used
 
5159
    in the merge directive.
 
5160
 
 
5161
    The default behaviour is to send the merge directive by mail, unless -o is
 
5162
    given, in which case it is sent to a file.
4961
5163
 
4962
5164
    Mail is sent using your preferred mail program.  This should be transparent
4963
5165
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
4965
5167
 
4966
5168
    To use a specific mail program, set the mail_client configuration option.
4967
5169
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4968
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
4969
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4970
 
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
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.
4971
5174
 
4972
5175
    If mail is being sent, a to address is required.  This can be supplied
4973
5176
    either on the commandline, by setting the submit_to configuration
4982
5185
 
4983
5186
    The merge directives created by bzr send may be applied using bzr merge or
4984
5187
    bzr pull by specifying a file containing a merge directive as the location.
 
5188
 
 
5189
    bzr send makes extensive use of public locations to map local locations into
 
5190
    URLs that can be used by other people.  See `bzr help configuration` to
 
5191
    set them, and use `bzr info` to display them.
4985
5192
    """
4986
5193
 
4987
5194
    encoding_type = 'exact'
5003
5210
               short_name='f',
5004
5211
               type=unicode),
5005
5212
        Option('output', short_name='o',
5006
 
               help='Write merge directive to this file; '
 
5213
               help='Write merge directive to this file or directory; '
5007
5214
                    'use - for stdout.',
5008
5215
               type=unicode),
5009
5216
        Option('strict',
5032
5239
 
5033
5240
 
5034
5241
class cmd_bundle_revisions(cmd_send):
5035
 
    """Create a merge-directive for submitting changes.
 
5242
    __doc__ = """Create a merge-directive for submitting changes.
5036
5243
 
5037
5244
    A merge directive provides many things needed for requesting merges:
5038
5245
 
5105
5312
 
5106
5313
 
5107
5314
class cmd_tag(Command):
5108
 
    """Create, remove or modify a tag naming a revision.
 
5315
    __doc__ = """Create, remove or modify a tag naming a revision.
5109
5316
 
5110
5317
    Tags give human-meaningful names to revisions.  Commands that take a -r
5111
5318
    (--revision) option can be given -rtag:X, where X is any previously
5119
5326
 
5120
5327
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5121
5328
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5329
 
 
5330
    If no tag name is specified it will be determined through the 
 
5331
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5332
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5333
    details.
5122
5334
    """
5123
5335
 
5124
5336
    _see_also = ['commit', 'tags']
5125
 
    takes_args = ['tag_name']
 
5337
    takes_args = ['tag_name?']
5126
5338
    takes_options = [
5127
5339
        Option('delete',
5128
5340
            help='Delete this tag rather than placing it.',
5138
5350
        'revision',
5139
5351
        ]
5140
5352
 
5141
 
    def run(self, tag_name,
 
5353
    def run(self, tag_name=None,
5142
5354
            delete=None,
5143
5355
            directory='.',
5144
5356
            force=None,
5146
5358
            ):
5147
5359
        branch, relpath = Branch.open_containing(directory)
5148
5360
        branch.lock_write()
5149
 
        try:
5150
 
            if delete:
5151
 
                branch.tags.delete_tag(tag_name)
5152
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5361
        self.add_cleanup(branch.unlock)
 
5362
        if delete:
 
5363
            if tag_name is None:
 
5364
                raise errors.BzrCommandError("No tag specified to delete.")
 
5365
            branch.tags.delete_tag(tag_name)
 
5366
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5367
        else:
 
5368
            if revision:
 
5369
                if len(revision) != 1:
 
5370
                    raise errors.BzrCommandError(
 
5371
                        "Tags can only be placed on a single revision, "
 
5372
                        "not on a range")
 
5373
                revision_id = revision[0].as_revision_id(branch)
5153
5374
            else:
5154
 
                if revision:
5155
 
                    if len(revision) != 1:
5156
 
                        raise errors.BzrCommandError(
5157
 
                            "Tags can only be placed on a single revision, "
5158
 
                            "not on a range")
5159
 
                    revision_id = revision[0].as_revision_id(branch)
5160
 
                else:
5161
 
                    revision_id = branch.last_revision()
5162
 
                if (not force) and branch.tags.has_tag(tag_name):
5163
 
                    raise errors.TagAlreadyExists(tag_name)
5164
 
                branch.tags.set_tag(tag_name, revision_id)
5165
 
                self.outf.write('Created tag %s.\n' % tag_name)
5166
 
        finally:
5167
 
            branch.unlock()
 
5375
                revision_id = branch.last_revision()
 
5376
            if tag_name is None:
 
5377
                tag_name = branch.automatic_tag_name(revision_id)
 
5378
                if tag_name is None:
 
5379
                    raise errors.BzrCommandError(
 
5380
                        "Please specify a tag name.")
 
5381
            if (not force) and branch.tags.has_tag(tag_name):
 
5382
                raise errors.TagAlreadyExists(tag_name)
 
5383
            branch.tags.set_tag(tag_name, revision_id)
 
5384
            self.outf.write('Created tag %s.\n' % tag_name)
5168
5385
 
5169
5386
 
5170
5387
class cmd_tags(Command):
5171
 
    """List tags.
 
5388
    __doc__ = """List tags.
5172
5389
 
5173
5390
    This command shows a table of tag names and the revisions they reference.
5174
5391
    """
5203
5420
            return
5204
5421
 
5205
5422
        branch.lock_read()
5206
 
        try:
5207
 
            if revision:
5208
 
                graph = branch.repository.get_graph()
5209
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5210
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5211
 
                # only show revisions between revid1 and revid2 (inclusive)
5212
 
                tags = [(tag, revid) for tag, revid in tags if
5213
 
                    graph.is_between(revid, revid1, revid2)]
5214
 
            if sort == 'alpha':
5215
 
                tags.sort()
5216
 
            elif sort == 'time':
5217
 
                timestamps = {}
5218
 
                for tag, revid in tags:
5219
 
                    try:
5220
 
                        revobj = branch.repository.get_revision(revid)
5221
 
                    except errors.NoSuchRevision:
5222
 
                        timestamp = sys.maxint # place them at the end
5223
 
                    else:
5224
 
                        timestamp = revobj.timestamp
5225
 
                    timestamps[revid] = timestamp
5226
 
                tags.sort(key=lambda x: timestamps[x[1]])
5227
 
            if not show_ids:
5228
 
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5229
 
                for index, (tag, revid) in enumerate(tags):
5230
 
                    try:
5231
 
                        revno = branch.revision_id_to_dotted_revno(revid)
5232
 
                        if isinstance(revno, tuple):
5233
 
                            revno = '.'.join(map(str, revno))
5234
 
                    except errors.NoSuchRevision:
5235
 
                        # Bad tag data/merges can lead to tagged revisions
5236
 
                        # which are not in this branch. Fail gracefully ...
5237
 
                        revno = '?'
5238
 
                    tags[index] = (tag, revno)
5239
 
        finally:
5240
 
            branch.unlock()
 
5423
        self.add_cleanup(branch.unlock)
 
5424
        if revision:
 
5425
            graph = branch.repository.get_graph()
 
5426
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5427
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5428
            # only show revisions between revid1 and revid2 (inclusive)
 
5429
            tags = [(tag, revid) for tag, revid in tags if
 
5430
                graph.is_between(revid, revid1, revid2)]
 
5431
        if sort == 'alpha':
 
5432
            tags.sort()
 
5433
        elif sort == 'time':
 
5434
            timestamps = {}
 
5435
            for tag, revid in tags:
 
5436
                try:
 
5437
                    revobj = branch.repository.get_revision(revid)
 
5438
                except errors.NoSuchRevision:
 
5439
                    timestamp = sys.maxint # place them at the end
 
5440
                else:
 
5441
                    timestamp = revobj.timestamp
 
5442
                timestamps[revid] = timestamp
 
5443
            tags.sort(key=lambda x: timestamps[x[1]])
 
5444
        if not show_ids:
 
5445
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5446
            for index, (tag, revid) in enumerate(tags):
 
5447
                try:
 
5448
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5449
                    if isinstance(revno, tuple):
 
5450
                        revno = '.'.join(map(str, revno))
 
5451
                except errors.NoSuchRevision:
 
5452
                    # Bad tag data/merges can lead to tagged revisions
 
5453
                    # which are not in this branch. Fail gracefully ...
 
5454
                    revno = '?'
 
5455
                tags[index] = (tag, revno)
 
5456
        self.cleanup_now()
5241
5457
        for tag, revspec in tags:
5242
5458
            self.outf.write('%-20s %s\n' % (tag, revspec))
5243
5459
 
5244
5460
 
5245
5461
class cmd_reconfigure(Command):
5246
 
    """Reconfigure the type of a bzr directory.
 
5462
    __doc__ = """Reconfigure the type of a bzr directory.
5247
5463
 
5248
5464
    A target configuration must be specified.
5249
5465
 
5334
5550
 
5335
5551
 
5336
5552
class cmd_switch(Command):
5337
 
    """Set the branch of a checkout and update.
 
5553
    __doc__ = """Set the branch of a checkout and update.
5338
5554
 
5339
5555
    For lightweight checkouts, this changes the branch being referenced.
5340
5556
    For heavyweight checkouts, this checks that there are no local commits
5352
5568
    /path/to/newbranch.
5353
5569
 
5354
5570
    Bound branches use the nickname of its master branch unless it is set
5355
 
    locally, in which case switching will update the the local nickname to be
 
5571
    locally, in which case switching will update the local nickname to be
5356
5572
    that of the master.
5357
5573
    """
5358
5574
 
5359
 
    takes_args = ['to_location']
 
5575
    takes_args = ['to_location?']
5360
5576
    takes_options = [Option('force',
5361
5577
                        help='Switch even if local commits will be lost.'),
 
5578
                     'revision',
5362
5579
                     Option('create-branch', short_name='b',
5363
5580
                        help='Create the target branch from this one before'
5364
5581
                             ' switching to it.'),
5365
 
                     ]
 
5582
                    ]
5366
5583
 
5367
 
    def run(self, to_location, force=False, create_branch=False):
 
5584
    def run(self, to_location=None, force=False, create_branch=False,
 
5585
            revision=None):
5368
5586
        from bzrlib import switch
5369
5587
        tree_location = '.'
 
5588
        revision = _get_one_revision('switch', revision)
5370
5589
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5590
        if to_location is None:
 
5591
            if revision is None:
 
5592
                raise errors.BzrCommandError('You must supply either a'
 
5593
                                             ' revision or a location')
 
5594
            to_location = '.'
5371
5595
        try:
5372
5596
            branch = control_dir.open_branch()
5373
5597
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5378
5602
            if branch is None:
5379
5603
                raise errors.BzrCommandError('cannot create branch without'
5380
5604
                                             ' source branch')
 
5605
            to_location = directory_service.directories.dereference(
 
5606
                              to_location)
5381
5607
            if '/' not in to_location and '\\' not in to_location:
5382
5608
                # This path is meant to be relative to the existing branch
5383
5609
                this_url = self._get_branch_location(control_dir)
5385
5611
            to_branch = branch.bzrdir.sprout(to_location,
5386
5612
                                 possible_transports=[branch.bzrdir.root_transport],
5387
5613
                                 source_branch=branch).open_branch()
5388
 
            # try:
5389
 
            #     from_branch = control_dir.open_branch()
5390
 
            # except errors.NotBranchError:
5391
 
            #     raise BzrCommandError('Cannot create a branch from this'
5392
 
            #         ' location when we cannot open this branch')
5393
 
            # from_branch.bzrdir.sprout(
5394
 
            pass
5395
5614
        else:
5396
5615
            try:
5397
5616
                to_branch = Branch.open(to_location)
5399
5618
                this_url = self._get_branch_location(control_dir)
5400
5619
                to_branch = Branch.open(
5401
5620
                    urlutils.join(this_url, '..', to_location))
5402
 
        switch.switch(control_dir, to_branch, force)
 
5621
        if revision is not None:
 
5622
            revision = revision.as_revision_id(to_branch)
 
5623
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5403
5624
        if had_explicit_nick:
5404
5625
            branch = control_dir.open_branch() #get the new branch!
5405
5626
            branch.nick = to_branch.nick
5425
5646
 
5426
5647
 
5427
5648
class cmd_view(Command):
5428
 
    """Manage filtered views.
 
5649
    __doc__ = """Manage filtered views.
5429
5650
 
5430
5651
    Views provide a mask over the tree so that users can focus on
5431
5652
    a subset of a tree when doing their work. After creating a view,
5579
5800
 
5580
5801
 
5581
5802
class cmd_hooks(Command):
5582
 
    """Show hooks."""
 
5803
    __doc__ = """Show hooks."""
5583
5804
 
5584
5805
    hidden = True
5585
5806
 
5598
5819
                    self.outf.write("    <no hooks installed>\n")
5599
5820
 
5600
5821
 
 
5822
class cmd_remove_branch(Command):
 
5823
    __doc__ = """Remove a branch.
 
5824
 
 
5825
    This will remove the branch from the specified location but 
 
5826
    will keep any working tree or repository in place.
 
5827
 
 
5828
    :Examples:
 
5829
 
 
5830
      Remove the branch at repo/trunk::
 
5831
 
 
5832
        bzr remove-branch repo/trunk
 
5833
 
 
5834
    """
 
5835
 
 
5836
    takes_args = ["location?"]
 
5837
 
 
5838
    aliases = ["rmbranch"]
 
5839
 
 
5840
    def run(self, location=None):
 
5841
        if location is None:
 
5842
            location = "."
 
5843
        branch = Branch.open_containing(location)[0]
 
5844
        branch.bzrdir.destroy_branch()
 
5845
        
 
5846
 
5601
5847
class cmd_shelve(Command):
5602
 
    """Temporarily set aside some changes from the current tree.
 
5848
    __doc__ = """Temporarily set aside some changes from the current tree.
5603
5849
 
5604
5850
    Shelve allows you to temporarily put changes you've made "on the shelf",
5605
5851
    ie. out of the way, until a later time when you can bring them back from
5652
5898
            try:
5653
5899
                shelver.run()
5654
5900
            finally:
5655
 
                shelver.work_tree.unlock()
 
5901
                shelver.finalize()
5656
5902
        except errors.UserAbort:
5657
5903
            return 0
5658
5904
 
5659
5905
    def run_for_list(self):
5660
5906
        tree = WorkingTree.open_containing('.')[0]
5661
5907
        tree.lock_read()
5662
 
        try:
5663
 
            manager = tree.get_shelf_manager()
5664
 
            shelves = manager.active_shelves()
5665
 
            if len(shelves) == 0:
5666
 
                note('No shelved changes.')
5667
 
                return 0
5668
 
            for shelf_id in reversed(shelves):
5669
 
                message = manager.get_metadata(shelf_id).get('message')
5670
 
                if message is None:
5671
 
                    message = '<no message>'
5672
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5673
 
            return 1
5674
 
        finally:
5675
 
            tree.unlock()
 
5908
        self.add_cleanup(tree.unlock)
 
5909
        manager = tree.get_shelf_manager()
 
5910
        shelves = manager.active_shelves()
 
5911
        if len(shelves) == 0:
 
5912
            note('No shelved changes.')
 
5913
            return 0
 
5914
        for shelf_id in reversed(shelves):
 
5915
            message = manager.get_metadata(shelf_id).get('message')
 
5916
            if message is None:
 
5917
                message = '<no message>'
 
5918
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5919
        return 1
5676
5920
 
5677
5921
 
5678
5922
class cmd_unshelve(Command):
5679
 
    """Restore shelved changes.
 
5923
    __doc__ = """Restore shelved changes.
5680
5924
 
5681
5925
    By default, the most recently shelved changes are restored. However if you
5682
5926
    specify a shelf by id those changes will be restored instead.  This works
5690
5934
            enum_switch=False, value_switches=True,
5691
5935
            apply="Apply changes and remove from the shelf.",
5692
5936
            dry_run="Show changes, but do not apply or remove them.",
5693
 
            delete_only="Delete changes without applying them."
 
5937
            preview="Instead of unshelving the changes, show the diff that "
 
5938
                    "would result from unshelving.",
 
5939
            delete_only="Delete changes without applying them.",
 
5940
            keep="Apply changes but don't delete them.",
5694
5941
        )
5695
5942
    ]
5696
5943
    _see_also = ['shelve']
5705
5952
 
5706
5953
 
5707
5954
class cmd_clean_tree(Command):
5708
 
    """Remove unwanted files from working tree.
 
5955
    __doc__ = """Remove unwanted files from working tree.
5709
5956
 
5710
5957
    By default, only unknown files, not ignored files, are deleted.  Versioned
5711
5958
    files are never deleted.
5739
5986
 
5740
5987
 
5741
5988
class cmd_reference(Command):
5742
 
    """list, view and set branch locations for nested trees.
 
5989
    __doc__ = """list, view and set branch locations for nested trees.
5743
5990
 
5744
5991
    If no arguments are provided, lists the branch locations for nested trees.
5745
5992
    If one argument is provided, display the branch location for that tree.
5785
6032
            self.outf.write('%s %s\n' % (path, location))
5786
6033
 
5787
6034
 
5788
 
# these get imported and then picked up by the scan for cmd_*
5789
 
# TODO: Some more consistent way to split command definitions across files;
5790
 
# we do need to load at least some information about them to know of
5791
 
# aliases.  ideally we would avoid loading the implementation until the
5792
 
# details were needed.
5793
 
from bzrlib.cmd_version_info import cmd_version_info
5794
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5795
 
from bzrlib.bundle.commands import (
5796
 
    cmd_bundle_info,
5797
 
    )
5798
 
from bzrlib.foreign import cmd_dpush
5799
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5800
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5801
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6035
def _register_lazy_builtins():
 
6036
    # register lazy builtins from other modules; called at startup and should
 
6037
    # be only called once.
 
6038
    for (name, aliases, module_name) in [
 
6039
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6040
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6041
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6042
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6043
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6044
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6045
        ]:
 
6046
        builtin_command_registry.register_lazy(name, aliases, module_name)