/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
 
34
    directory_service,
34
35
    delta,
35
36
    config,
36
37
    errors,
43
44
    reconfigure,
44
45
    rename_map,
45
46
    revision as _mod_revision,
 
47
    static_tuple,
46
48
    symbol_versioning,
 
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,
120
128
 
121
129
 
122
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
131
    """Get a revision tree. Not suitable for commands that change the tree.
 
132
    
 
133
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
134
    and doing a commit/uncommit/pull will at best fail due to changing the
 
135
    basis revision data.
 
136
 
 
137
    If tree is passed in, it should be already locked, for lifetime management
 
138
    of the trees internal cached state.
 
139
    """
123
140
    if branch is None:
124
141
        branch = tree.branch
125
142
    if revisions is None:
222
239
# opens the branch?)
223
240
 
224
241
class cmd_status(Command):
225
 
    """Display status summary.
 
242
    __doc__ = """Display status summary.
226
243
 
227
244
    This reports on versioned and unknown files, reporting them
228
245
    grouped by state.  Possible states are:
248
265
    unknown
249
266
        Not versioned and not matching an ignore pattern.
250
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
 
251
272
    To see ignored files use 'bzr ignored'.  For details on the
252
273
    changes to file texts, use 'bzr diff'.
253
274
 
311
332
 
312
333
 
313
334
class cmd_cat_revision(Command):
314
 
    """Write out metadata for a revision.
 
335
    __doc__ = """Write out metadata for a revision.
315
336
 
316
337
    The revision to print can either be specified by a specific
317
338
    revision identifier, or you can use --revision.
323
344
    # cat-revision is more for frontends so should be exact
324
345
    encoding = 'strict'
325
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
 
326
355
    @display_command
327
356
    def run(self, revision_id=None, revision=None):
328
357
        if revision_id is not None and revision is not None:
333
362
                                         ' --revision or a revision_id')
334
363
        b = WorkingTree.open_containing(u'.')[0].branch
335
364
 
336
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
337
 
        if revision_id is not None:
338
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
339
 
            try:
340
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
341
 
            except errors.NoSuchRevision:
342
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
343
 
                    revision_id)
344
 
                raise errors.BzrCommandError(msg)
345
 
        elif revision is not None:
346
 
            for rev in revision:
347
 
                if rev is None:
348
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
349
 
                                                 ' revision.')
350
 
                rev_id = rev.as_revision_id(b)
351
 
                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')
352
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
        
353
391
 
354
392
class cmd_dump_btree(Command):
355
 
    """Dump the contents of a btree index file to stdout.
 
393
    __doc__ = """Dump the contents of a btree index file to stdout.
356
394
 
357
395
    PATH is a btree index file, it can be any URL. This includes things like
358
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
422
460
        for node in bt.iter_all_entries():
423
461
            # Node is made up of:
424
462
            # (index, key, value, [references])
425
 
            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,))
426
471
 
427
472
 
428
473
class cmd_remove_tree(Command):
429
 
    """Remove the working tree from a given branch/checkout.
 
474
    __doc__ = """Remove the working tree from a given branch/checkout.
430
475
 
431
476
    Since a lightweight checkout is little more than a working tree
432
477
    this will refuse to run against one.
434
479
    To re-create the working tree, use "bzr checkout".
435
480
    """
436
481
    _see_also = ['checkout', 'working-trees']
437
 
    takes_args = ['location?']
 
482
    takes_args = ['location*']
438
483
    takes_options = [
439
484
        Option('force',
440
485
               help='Remove the working tree even if it has '
441
486
                    'uncommitted changes.'),
442
487
        ]
443
488
 
444
 
    def run(self, location='.', force=False):
445
 
        d = bzrdir.BzrDir.open(location)
446
 
 
447
 
        try:
448
 
            working = d.open_workingtree()
449
 
        except errors.NoWorkingTree:
450
 
            raise errors.BzrCommandError("No working tree to remove")
451
 
        except errors.NotLocalUrl:
452
 
            raise errors.BzrCommandError("You cannot remove the working tree"
453
 
                                         " of a remote path")
454
 
        if not force:
455
 
            # XXX: What about pending merges ? -- vila 20090629
456
 
            if working.has_changes(working.basis_tree()):
457
 
                raise errors.UncommittedChanges(working)
458
 
 
459
 
        working_path = working.bzrdir.root_transport.base
460
 
        branch_path = working.branch.bzrdir.root_transport.base
461
 
        if working_path != branch_path:
462
 
            raise errors.BzrCommandError("You cannot remove the working tree"
463
 
                                         " from a lightweight checkout")
464
 
 
465
 
        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()
466
512
 
467
513
 
468
514
class cmd_revno(Command):
469
 
    """Show current revision number.
 
515
    __doc__ = """Show current revision number.
470
516
 
471
517
    This is equal to the number of revisions on this branch.
472
518
    """
485
531
                wt.lock_read()
486
532
            except (errors.NoWorkingTree, errors.NotLocalUrl):
487
533
                raise errors.NoWorkingTree(location)
 
534
            self.add_cleanup(wt.unlock)
 
535
            revid = wt.last_revision()
488
536
            try:
489
 
                revid = wt.last_revision()
490
 
                try:
491
 
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
492
 
                except errors.NoSuchRevision:
493
 
                    revno_t = ('???',)
494
 
                revno = ".".join(str(n) for n in revno_t)
495
 
            finally:
496
 
                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)
497
541
        else:
498
542
            b = Branch.open_containing(location)[0]
499
543
            b.lock_read()
500
 
            try:
501
 
                revno = b.revno()
502
 
            finally:
503
 
                b.unlock()
504
 
 
 
544
            self.add_cleanup(b.unlock)
 
545
            revno = b.revno()
 
546
        self.cleanup_now()
505
547
        self.outf.write(str(revno) + '\n')
506
548
 
507
549
 
508
550
class cmd_revision_info(Command):
509
 
    """Show revision number and revision id for a given revision identifier.
 
551
    __doc__ = """Show revision number and revision id for a given revision identifier.
510
552
    """
511
553
    hidden = True
512
554
    takes_args = ['revision_info*']
529
571
            wt = WorkingTree.open_containing(directory)[0]
530
572
            b = wt.branch
531
573
            wt.lock_read()
 
574
            self.add_cleanup(wt.unlock)
532
575
        except (errors.NoWorkingTree, errors.NotLocalUrl):
533
576
            wt = None
534
577
            b = Branch.open_containing(directory)[0]
535
578
            b.lock_read()
536
 
        try:
537
 
            revision_ids = []
538
 
            if revision is not None:
539
 
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
540
 
            if revision_info_list is not None:
541
 
                for rev_str in revision_info_list:
542
 
                    rev_spec = RevisionSpec.from_string(rev_str)
543
 
                    revision_ids.append(rev_spec.as_revision_id(b))
544
 
            # No arguments supplied, default to the last revision
545
 
            if len(revision_ids) == 0:
546
 
                if tree:
547
 
                    if wt is None:
548
 
                        raise errors.NoWorkingTree(directory)
549
 
                    revision_ids.append(wt.last_revision())
550
 
                else:
551
 
                    revision_ids.append(b.last_revision())
552
 
 
553
 
            revinfos = []
554
 
            maxlen = 0
555
 
            for revision_id in revision_ids:
556
 
                try:
557
 
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
558
 
                    revno = '.'.join(str(i) for i in dotted_revno)
559
 
                except errors.NoSuchRevision:
560
 
                    revno = '???'
561
 
                maxlen = max(maxlen, len(revno))
562
 
                revinfos.append([revno, revision_id])
563
 
        finally:
564
 
            if wt is None:
565
 
                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())
566
593
            else:
567
 
                wt.unlock()
568
 
 
 
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()
569
608
        for ri in revinfos:
570
609
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
571
610
 
572
611
 
573
612
class cmd_add(Command):
574
 
    """Add specified files or directories.
 
613
    __doc__ = """Add specified files or directories.
575
614
 
576
615
    In non-recursive mode, all the named items are added, regardless
577
616
    of whether they were previously ignored.  A warning is given if
603
642
    branches that will be merged later (without showing the two different
604
643
    adds as a conflict). It is also useful when merging another project
605
644
    into a subdirectory of this one.
 
645
    
 
646
    Any files matching patterns in the ignore list will not be added
 
647
    unless they are explicitly mentioned.
606
648
    """
607
649
    takes_args = ['file*']
608
650
    takes_options = [
616
658
               help='Lookup file ids from this tree.'),
617
659
        ]
618
660
    encoding_type = 'replace'
619
 
    _see_also = ['remove']
 
661
    _see_also = ['remove', 'ignore']
620
662
 
621
663
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
622
664
            file_ids_from=None):
640
682
 
641
683
        if base_tree:
642
684
            base_tree.lock_read()
643
 
        try:
644
 
            file_list = self._maybe_expand_globs(file_list)
645
 
            tree, file_list = tree_files_for_add(file_list)
646
 
            added, ignored = tree.smart_add(file_list, not
647
 
                no_recurse, action=action, save=not dry_run)
648
 
        finally:
649
 
            if base_tree is not None:
650
 
                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()
651
690
        if len(ignored) > 0:
652
691
            if verbose:
653
692
                for glob in sorted(ignored.keys()):
654
693
                    for path in ignored[glob]:
655
694
                        self.outf.write("ignored %s matching \"%s\"\n"
656
695
                                        % (path, glob))
657
 
            else:
658
 
                match_len = 0
659
 
                for glob, paths in ignored.items():
660
 
                    match_len += len(paths)
661
 
                self.outf.write("ignored %d file(s).\n" % match_len)
662
 
            self.outf.write("If you wish to add ignored files, "
663
 
                            "please add them explicitly by name. "
664
 
                            "(\"bzr ignored\" gives a list)\n")
665
696
 
666
697
 
667
698
class cmd_mkdir(Command):
668
 
    """Create a new versioned directory.
 
699
    __doc__ = """Create a new versioned directory.
669
700
 
670
701
    This is equivalent to creating the directory and then adding it.
671
702
    """
675
706
 
676
707
    def run(self, dir_list):
677
708
        for d in dir_list:
678
 
            os.mkdir(d)
679
709
            wt, dd = WorkingTree.open_containing(d)
680
 
            wt.add([dd])
681
 
            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)
682
718
 
683
719
 
684
720
class cmd_relpath(Command):
685
 
    """Show path of a file relative to root"""
 
721
    __doc__ = """Show path of a file relative to root"""
686
722
 
687
723
    takes_args = ['filename']
688
724
    hidden = True
697
733
 
698
734
 
699
735
class cmd_inventory(Command):
700
 
    """Show inventory of the current working copy or a revision.
 
736
    __doc__ = """Show inventory of the current working copy or a revision.
701
737
 
702
738
    It is possible to limit the output to a particular entry
703
739
    type using the --kind option.  For example: --kind file.
725
761
        revision = _get_one_revision('inventory', revision)
726
762
        work_tree, file_list = tree_files(file_list)
727
763
        work_tree.lock_read()
728
 
        try:
729
 
            if revision is not None:
730
 
                tree = revision.as_tree(work_tree.branch)
731
 
 
732
 
                extra_trees = [work_tree]
733
 
                tree.lock_read()
734
 
            else:
735
 
                tree = work_tree
736
 
                extra_trees = []
737
 
 
738
 
            if file_list is not None:
739
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
740
 
                                          require_versioned=True)
741
 
                # find_ids_across_trees may include some paths that don't
742
 
                # exist in 'tree'.
743
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
744
 
                                 for file_id in file_ids if file_id in tree)
745
 
            else:
746
 
                entries = tree.inventory.entries()
747
 
        finally:
748
 
            tree.unlock()
749
 
            if tree is not work_tree:
750
 
                work_tree.unlock()
751
 
 
 
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()
752
786
        for path, entry in entries:
753
787
            if kind and kind != entry.kind:
754
788
                continue
760
794
 
761
795
 
762
796
class cmd_mv(Command):
763
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
764
798
 
765
799
    :Usage:
766
800
        bzr mv OLDNAME NEWNAME
800
834
            raise errors.BzrCommandError("missing file argument")
801
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
802
836
        tree.lock_tree_write()
803
 
        try:
804
 
            self._run(tree, names_list, rel_names, after)
805
 
        finally:
806
 
            tree.unlock()
 
837
        self.add_cleanup(tree.unlock)
 
838
        self._run(tree, names_list, rel_names, after)
807
839
 
808
840
    def run_auto(self, names_list, after, dry_run):
809
841
        if names_list is not None and len(names_list) > 1:
814
846
                                         ' --auto.')
815
847
        work_tree, file_list = tree_files(names_list, default_branch='.')
816
848
        work_tree.lock_tree_write()
817
 
        try:
818
 
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
819
 
        finally:
820
 
            work_tree.unlock()
 
849
        self.add_cleanup(work_tree.unlock)
 
850
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
821
851
 
822
852
    def _run(self, tree, names_list, rel_names, after):
823
853
        into_existing = osutils.isdir(names_list[-1])
844
874
            # All entries reference existing inventory items, so fix them up
845
875
            # for cicp file-systems.
846
876
            rel_names = tree.get_canonical_inventory_paths(rel_names)
847
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
848
 
                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))
849
880
        else:
850
881
            if len(names_list) != 2:
851
882
                raise errors.BzrCommandError('to mv multiple files the'
895
926
            dest = osutils.pathjoin(dest_parent, dest_tail)
896
927
            mutter("attempting to move %s => %s", src, dest)
897
928
            tree.rename_one(src, dest, after=after)
898
 
            self.outf.write("%s => %s\n" % (src, dest))
 
929
            if not is_quiet():
 
930
                self.outf.write("%s => %s\n" % (src, dest))
899
931
 
900
932
 
901
933
class cmd_pull(Command):
902
 
    """Turn this branch into a mirror of another branch.
 
934
    __doc__ = """Turn this branch into a mirror of another branch.
903
935
 
904
 
    This command only works on branches that have not diverged.  Branches are
905
 
    considered diverged if the destination branch's most recent commit is one
906
 
    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.
907
940
 
908
941
    If branches have diverged, you can use 'bzr merge' to integrate the changes
909
942
    from one into the other.  Once one branch has merged, the other should
910
943
    be able to pull it again.
911
944
 
912
 
    If you want to forget your local changes and just update your branch to
913
 
    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.
914
948
 
915
949
    If there is no default location set, the first pull will set it.  After
916
950
    that, you can omit the location to use the default.  To change the
952
986
        try:
953
987
            tree_to = WorkingTree.open_containing(directory)[0]
954
988
            branch_to = tree_to.branch
 
989
            tree_to.lock_write()
 
990
            self.add_cleanup(tree_to.unlock)
955
991
        except errors.NoWorkingTree:
956
992
            tree_to = None
957
993
            branch_to = Branch.open_containing(directory)[0]
958
 
        
 
994
            branch_to.lock_write()
 
995
            self.add_cleanup(branch_to.unlock)
 
996
 
959
997
        if local and not branch_to.get_bound_location():
960
998
            raise errors.LocalRequiresBoundBranch()
961
999
 
991
1029
        else:
992
1030
            branch_from = Branch.open(location,
993
1031
                possible_transports=possible_transports)
 
1032
            branch_from.lock_read()
 
1033
            self.add_cleanup(branch_from.unlock)
994
1034
 
995
1035
            if branch_to.get_parent() is None or remember:
996
1036
                branch_to.set_parent(branch_from.base)
997
1037
 
998
 
        if branch_from is not branch_to:
999
 
            branch_from.lock_read()
1000
 
        try:
1001
 
            if revision is not None:
1002
 
                revision_id = revision.as_revision_id(branch_from)
1003
 
 
1004
 
            branch_to.lock_write()
1005
 
            try:
1006
 
                if tree_to is not None:
1007
 
                    view_info = _get_view_info_for_change_reporter(tree_to)
1008
 
                    change_reporter = delta._ChangeReporter(
1009
 
                        unversioned_filter=tree_to.is_ignored,
1010
 
                        view_info=view_info)
1011
 
                    result = tree_to.pull(
1012
 
                        branch_from, overwrite, revision_id, change_reporter,
1013
 
                        possible_transports=possible_transports, local=local)
1014
 
                else:
1015
 
                    result = branch_to.pull(
1016
 
                        branch_from, overwrite, revision_id, local=local)
1017
 
 
1018
 
                result.report(self.outf)
1019
 
                if verbose and result.old_revid != result.new_revid:
1020
 
                    log.show_branch_change(
1021
 
                        branch_to, self.outf, result.old_revno,
1022
 
                        result.old_revid)
1023
 
            finally:
1024
 
                branch_to.unlock()
1025
 
        finally:
1026
 
            if branch_from is not branch_to:
1027
 
                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)
1028
1058
 
1029
1059
 
1030
1060
class cmd_push(Command):
1031
 
    """Update a mirror of this branch.
 
1061
    __doc__ = """Update a mirror of this branch.
1032
1062
 
1033
1063
    The target branch will not have its working tree populated because this
1034
1064
    is both expensive, and is not supported on remote file systems.
1095
1125
        # Get the source branch
1096
1126
        (tree, br_from,
1097
1127
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1098
 
        if strict is None:
1099
 
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
1100
 
        if strict is None: strict = True # default value
1101
1128
        # Get the tip's revision_id
1102
1129
        revision = _get_one_revision('push', revision)
1103
1130
        if revision is not None:
1104
1131
            revision_id = revision.in_history(br_from).rev_id
1105
1132
        else:
1106
1133
            revision_id = None
1107
 
        if strict and tree is not None and revision_id is None:
1108
 
            if (tree.has_changes(tree.basis_tree())
1109
 
                or len(tree.get_parent_ids()) > 1):
1110
 
                raise errors.UncommittedChanges(
1111
 
                    tree, more='Use --no-strict to force the push.')
1112
 
            if tree.last_revision() != tree.branch.last_revision():
1113
 
                # The tree has lost sync with its branch, there is little
1114
 
                # chance that the user is aware of it but he can still force
1115
 
                # the push with --no-strict
1116
 
                raise errors.OutOfDateTree(
1117
 
                    tree, more='Use --no-strict to force the push.')
1118
 
 
 
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.')
1119
1139
        # Get the stacked_on branch, if any
1120
1140
        if stacked_on is not None:
1121
1141
            stacked_on = urlutils.normalize_url(stacked_on)
1153
1173
 
1154
1174
 
1155
1175
class cmd_branch(Command):
1156
 
    """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.
1157
1177
 
1158
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1159
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1172
1192
        help='Hard-link working tree files where possible.'),
1173
1193
        Option('no-tree',
1174
1194
            help="Create a branch without a working-tree."),
 
1195
        Option('switch',
 
1196
            help="Switch the checkout in the current directory "
 
1197
                 "to the new branch."),
1175
1198
        Option('stacked',
1176
1199
            help='Create a stacked branch referring to the source branch. '
1177
1200
                'The new branch will depend on the availability of the source '
1183
1206
                    ' directory exists, but does not already'
1184
1207
                    ' have a control directory.  This flag will'
1185
1208
                    ' allow branch to proceed.'),
 
1209
        Option('bind',
 
1210
            help="Bind new branch to from location."),
1186
1211
        ]
1187
1212
    aliases = ['get', 'clone']
1188
1213
 
1189
1214
    def run(self, from_location, to_location=None, revision=None,
1190
1215
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1191
 
            use_existing_dir=False):
 
1216
            use_existing_dir=False, switch=False, bind=False):
 
1217
        from bzrlib import switch as _mod_switch
1192
1218
        from bzrlib.tag import _merge_tags_if_possible
1193
 
 
1194
1219
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1195
1220
            from_location)
1196
 
        if (accelerator_tree is not None and
1197
 
            accelerator_tree.supports_content_filtering()):
1198
 
            accelerator_tree = None
1199
1221
        revision = _get_one_revision('branch', revision)
1200
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)
1201
1234
        try:
1202
 
            if revision is not None:
1203
 
                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)
1204
1240
            else:
1205
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1206
 
                # None or perhaps NULL_REVISION to mean copy nothing
1207
 
                # RBC 20060209
1208
 
                revision_id = br_from.last_revision()
1209
 
            if to_location is None:
1210
 
                to_location = urlutils.derive_to_location(from_location)
1211
 
            to_transport = transport.get_transport(to_location)
1212
 
            try:
1213
 
                to_transport.mkdir('.')
1214
 
            except errors.FileExists:
1215
 
                if not use_existing_dir:
1216
 
                    raise errors.BzrCommandError('Target directory "%s" '
1217
 
                        'already exists.' % to_location)
 
1241
                try:
 
1242
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1243
                except errors.NotBranchError:
 
1244
                    pass
1218
1245
                else:
1219
 
                    try:
1220
 
                        bzrdir.BzrDir.open_from_transport(to_transport)
1221
 
                    except errors.NotBranchError:
1222
 
                        pass
1223
 
                    else:
1224
 
                        raise errors.AlreadyBranchError(to_location)
1225
 
            except errors.NoSuchFile:
1226
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1227
 
                                             % to_location)
1228
 
            try:
1229
 
                # preserve whatever source format we have.
1230
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1231
 
                                            possible_transports=[to_transport],
1232
 
                                            accelerator_tree=accelerator_tree,
1233
 
                                            hardlink=hardlink, stacked=stacked,
1234
 
                                            force_new_repo=standalone,
1235
 
                                            create_tree_if_local=not no_tree,
1236
 
                                            source_branch=br_from)
1237
 
                branch = dir.open_branch()
1238
 
            except errors.NoSuchRevision:
1239
 
                to_transport.delete_tree('.')
1240
 
                msg = "The branch %s has no revision %s." % (from_location,
1241
 
                    revision)
1242
 
                raise errors.BzrCommandError(msg)
1243
 
            _merge_tags_if_possible(br_from, branch)
1244
 
            # If the source branch is stacked, the new branch may
1245
 
            # be stacked whether we asked for that explicitly or not.
1246
 
            # We therefore need a try/except here and not just 'if stacked:'
1247
 
            try:
1248
 
                note('Created new stacked branch referring to %s.' %
1249
 
                    branch.get_stacked_on_url())
1250
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1251
 
                errors.UnstackableRepositoryFormat), e:
1252
 
                note('Branched %d revision(s).' % branch.revno())
1253
 
        finally:
1254
 
            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'))
1255
1286
 
1256
1287
 
1257
1288
class cmd_checkout(Command):
1258
 
    """Create a new checkout of an existing branch.
 
1289
    __doc__ = """Create a new checkout of an existing branch.
1259
1290
 
1260
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1261
1292
    the branch found in '.'. This is useful if you have removed the working tree
1324
1355
 
1325
1356
 
1326
1357
class cmd_renames(Command):
1327
 
    """Show list of renamed files.
 
1358
    __doc__ = """Show list of renamed files.
1328
1359
    """
1329
1360
    # TODO: Option to show renames between two historical versions.
1330
1361
 
1336
1367
    def run(self, dir=u'.'):
1337
1368
        tree = WorkingTree.open_containing(dir)[0]
1338
1369
        tree.lock_read()
1339
 
        try:
1340
 
            new_inv = tree.inventory
1341
 
            old_tree = tree.basis_tree()
1342
 
            old_tree.lock_read()
1343
 
            try:
1344
 
                old_inv = old_tree.inventory
1345
 
                renames = []
1346
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1347
 
                for f, paths, c, v, p, n, k, e in iterator:
1348
 
                    if paths[0] == paths[1]:
1349
 
                        continue
1350
 
                    if None in (paths):
1351
 
                        continue
1352
 
                    renames.append(paths)
1353
 
                renames.sort()
1354
 
                for old_name, new_name in renames:
1355
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1356
 
            finally:
1357
 
                old_tree.unlock()
1358
 
        finally:
1359
 
            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))
1360
1387
 
1361
1388
 
1362
1389
class cmd_update(Command):
1363
 
    """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.
1364
1391
 
1365
1392
    This will perform a merge into the working tree, and may generate
1366
1393
    conflicts. If you have any local changes, you will still
1368
1395
 
1369
1396
    If you want to discard your local changes, you can just do a
1370
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.
1371
1401
    """
1372
1402
 
1373
1403
    _see_also = ['pull', 'working-trees', 'status-flags']
1374
1404
    takes_args = ['dir?']
 
1405
    takes_options = ['revision']
1375
1406
    aliases = ['up']
1376
1407
 
1377
 
    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")
1378
1412
        tree = WorkingTree.open_containing(dir)[0]
 
1413
        branch = tree.branch
1379
1414
        possible_transports = []
1380
 
        master = tree.branch.get_master_branch(
 
1415
        master = branch.get_master_branch(
1381
1416
            possible_transports=possible_transports)
1382
1417
        if master is not None:
1383
1418
            tree.lock_write()
 
1419
            branch_location = master.base
1384
1420
        else:
1385
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)
1386
1449
        try:
1387
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1388
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1389
 
            if last_rev == _mod_revision.ensure_null(
1390
 
                tree.branch.last_revision()):
1391
 
                # may be up to date, check master too.
1392
 
                if master is None or last_rev == _mod_revision.ensure_null(
1393
 
                    master.last_revision()):
1394
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1395
 
                    note("Tree is up to date at revision %d." % (revno,))
1396
 
                    return 0
1397
 
            view_info = _get_view_info_for_change_reporter(tree)
1398
1450
            conflicts = tree.update(
1399
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1400
 
                view_info=view_info), possible_transports=possible_transports)
1401
 
            revno = tree.branch.revision_id_to_revno(
1402
 
                _mod_revision.ensure_null(tree.last_revision()))
1403
 
            note('Updated to revision %d.' % (revno,))
1404
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1405
 
                note('Your local commits will now show as pending merges with '
1406
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1407
 
            if conflicts != 0:
1408
 
                return 1
1409
 
            else:
1410
 
                return 0
1411
 
        finally:
1412
 
            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
1413
1473
 
1414
1474
 
1415
1475
class cmd_info(Command):
1416
 
    """Show information about a working tree, branch or repository.
 
1476
    __doc__ = """Show information about a working tree, branch or repository.
1417
1477
 
1418
1478
    This command will show all known locations and formats associated to the
1419
1479
    tree, branch or repository.
1457
1517
 
1458
1518
 
1459
1519
class cmd_remove(Command):
1460
 
    """Remove files or directories.
 
1520
    __doc__ = """Remove files or directories.
1461
1521
 
1462
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1463
1523
    them if they can easily be recovered using revert. If no options or
1486
1546
            file_list = [f for f in file_list]
1487
1547
 
1488
1548
        tree.lock_write()
1489
 
        try:
1490
 
            # Heuristics should probably all move into tree.remove_smart or
1491
 
            # some such?
1492
 
            if new:
1493
 
                added = tree.changes_from(tree.basis_tree(),
1494
 
                    specific_files=file_list).added
1495
 
                file_list = sorted([f[0] for f in added], reverse=True)
1496
 
                if len(file_list) == 0:
1497
 
                    raise errors.BzrCommandError('No matching files.')
1498
 
            elif file_list is None:
1499
 
                # missing files show up in iter_changes(basis) as
1500
 
                # versioned-with-no-kind.
1501
 
                missing = []
1502
 
                for change in tree.iter_changes(tree.basis_tree()):
1503
 
                    # Find paths in the working tree that have no kind:
1504
 
                    if change[1][1] is not None and change[6][1] is None:
1505
 
                        missing.append(change[1][1])
1506
 
                file_list = sorted(missing, reverse=True)
1507
 
                file_deletion_strategy = 'keep'
1508
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1509
 
                keep_files=file_deletion_strategy=='keep',
1510
 
                force=file_deletion_strategy=='force')
1511
 
        finally:
1512
 
            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')
1513
1571
 
1514
1572
 
1515
1573
class cmd_file_id(Command):
1516
 
    """Print file_id of a particular file or directory.
 
1574
    __doc__ = """Print file_id of a particular file or directory.
1517
1575
 
1518
1576
    The file_id is assigned when the file is first added and remains the
1519
1577
    same through all revisions where the file exists, even when it is
1535
1593
 
1536
1594
 
1537
1595
class cmd_file_path(Command):
1538
 
    """Print path of file_ids to a file or directory.
 
1596
    __doc__ = """Print path of file_ids to a file or directory.
1539
1597
 
1540
1598
    This prints one line for each directory down to the target,
1541
1599
    starting at the branch root.
1557
1615
 
1558
1616
 
1559
1617
class cmd_reconcile(Command):
1560
 
    """Reconcile bzr metadata in a branch.
 
1618
    __doc__ = """Reconcile bzr metadata in a branch.
1561
1619
 
1562
1620
    This can correct data mismatches that may have been caused by
1563
1621
    previous ghost operations or bzr upgrades. You should only
1585
1643
 
1586
1644
 
1587
1645
class cmd_revision_history(Command):
1588
 
    """Display the list of revision ids on a branch."""
 
1646
    __doc__ = """Display the list of revision ids on a branch."""
1589
1647
 
1590
1648
    _see_also = ['log']
1591
1649
    takes_args = ['location?']
1601
1659
 
1602
1660
 
1603
1661
class cmd_ancestry(Command):
1604
 
    """List all revisions merged into this branch."""
 
1662
    __doc__ = """List all revisions merged into this branch."""
1605
1663
 
1606
1664
    _see_also = ['log', 'revision-history']
1607
1665
    takes_args = ['location?']
1626
1684
 
1627
1685
 
1628
1686
class cmd_init(Command):
1629
 
    """Make a directory into a versioned branch.
 
1687
    __doc__ = """Make a directory into a versioned branch.
1630
1688
 
1631
1689
    Use this to create an empty branch, or before importing an
1632
1690
    existing project.
1660
1718
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1661
1719
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1662
1720
                value_switches=True,
1663
 
                title="Branch Format",
 
1721
                title="Branch format",
1664
1722
                ),
1665
1723
         Option('append-revisions-only',
1666
1724
                help='Never change revnos or the existing log.'
1735
1793
 
1736
1794
 
1737
1795
class cmd_init_repository(Command):
1738
 
    """Create a shared repository to hold branches.
 
1796
    __doc__ = """Create a shared repository for branches to share storage space.
1739
1797
 
1740
1798
    New branches created under the repository directory will store their
1741
 
    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.
1742
1802
 
1743
 
    If the --no-trees option is used then the branches in the repository
1744
 
    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.
1745
1809
 
1746
1810
    :Examples:
1747
 
        Create a shared repositories holding just branches::
 
1811
        Create a shared repository holding just branches::
1748
1812
 
1749
1813
            bzr init-repo --no-trees repo
1750
1814
            bzr init repo/trunk
1789
1853
 
1790
1854
 
1791
1855
class cmd_diff(Command):
1792
 
    """Show differences in the working tree, between revisions or branches.
 
1856
    __doc__ = """Show differences in the working tree, between revisions or branches.
1793
1857
 
1794
1858
    If no arguments are given, all changes for the current tree are listed.
1795
1859
    If files are given, only the changes in those files are listed.
1816
1880
 
1817
1881
            bzr diff -r1
1818
1882
 
1819
 
        Difference between revision 2 and revision 1::
1820
 
 
1821
 
            bzr diff -r1..2
1822
 
 
1823
 
        Difference between revision 2 and revision 1 for branch xxx::
1824
 
 
1825
 
            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
1826
1904
 
1827
1905
        Show just the differences for file NEWS::
1828
1906
 
1867
1945
            help='Use this command to compare files.',
1868
1946
            type=unicode,
1869
1947
            ),
 
1948
        RegistryOption('format',
 
1949
            help='Diff format to use.',
 
1950
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1951
            value_switches=False, title='Diff format'),
1870
1952
        ]
1871
1953
    aliases = ['di', 'dif']
1872
1954
    encoding_type = 'exact'
1873
1955
 
1874
1956
    @display_command
1875
1957
    def run(self, revision=None, file_list=None, diff_options=None,
1876
 
            prefix=None, old=None, new=None, using=None):
1877
 
        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)
1878
1961
 
1879
1962
        if (prefix is None) or (prefix == '0'):
1880
1963
            # diff -p0 format
1894
1977
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1895
1978
                                         ' one or two revision specifiers')
1896
1979
 
1897
 
        old_tree, new_tree, specific_files, extra_trees = \
1898
 
                _get_trees_to_diff(file_list, revision, old, new,
1899
 
                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)
1900
1988
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1901
1989
                               specific_files=specific_files,
1902
1990
                               external_diff_options=diff_options,
1903
1991
                               old_label=old_label, new_label=new_label,
1904
 
                               extra_trees=extra_trees, using=using)
 
1992
                               extra_trees=extra_trees, using=using,
 
1993
                               format_cls=format)
1905
1994
 
1906
1995
 
1907
1996
class cmd_deleted(Command):
1908
 
    """List files deleted in the working tree.
 
1997
    __doc__ = """List files deleted in the working tree.
1909
1998
    """
1910
1999
    # TODO: Show files deleted since a previous revision, or
1911
2000
    # between two revisions.
1920
2009
    def run(self, show_ids=False):
1921
2010
        tree = WorkingTree.open_containing(u'.')[0]
1922
2011
        tree.lock_read()
1923
 
        try:
1924
 
            old = tree.basis_tree()
1925
 
            old.lock_read()
1926
 
            try:
1927
 
                for path, ie in old.inventory.iter_entries():
1928
 
                    if not tree.has_id(ie.file_id):
1929
 
                        self.outf.write(path)
1930
 
                        if show_ids:
1931
 
                            self.outf.write(' ')
1932
 
                            self.outf.write(ie.file_id)
1933
 
                        self.outf.write('\n')
1934
 
            finally:
1935
 
                old.unlock()
1936
 
        finally:
1937
 
            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')
1938
2023
 
1939
2024
 
1940
2025
class cmd_modified(Command):
1941
 
    """List files modified in working tree.
 
2026
    __doc__ = """List files modified in working tree.
1942
2027
    """
1943
2028
 
1944
2029
    hidden = True
1961
2046
 
1962
2047
 
1963
2048
class cmd_added(Command):
1964
 
    """List files added in working tree.
 
2049
    __doc__ = """List files added in working tree.
1965
2050
    """
1966
2051
 
1967
2052
    hidden = True
1976
2061
    def run(self, null=False):
1977
2062
        wt = WorkingTree.open_containing(u'.')[0]
1978
2063
        wt.lock_read()
1979
 
        try:
1980
 
            basis = wt.basis_tree()
1981
 
            basis.lock_read()
1982
 
            try:
1983
 
                basis_inv = basis.inventory
1984
 
                inv = wt.inventory
1985
 
                for file_id in inv:
1986
 
                    if file_id in basis_inv:
1987
 
                        continue
1988
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1989
 
                        continue
1990
 
                    path = inv.id2path(file_id)
1991
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1992
 
                        continue
1993
 
                    if null:
1994
 
                        self.outf.write(path + '\0')
1995
 
                    else:
1996
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1997
 
            finally:
1998
 
                basis.unlock()
1999
 
        finally:
2000
 
            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')
2001
2082
 
2002
2083
 
2003
2084
class cmd_root(Command):
2004
 
    """Show the tree root directory.
 
2085
    __doc__ = """Show the tree root directory.
2005
2086
 
2006
2087
    The root is the nearest enclosing directory with a .bzr control
2007
2088
    directory."""
2031
2112
 
2032
2113
 
2033
2114
class cmd_log(Command):
2034
 
    """Show historical log for a branch or subset of a branch.
 
2115
    __doc__ = """Show historical log for a branch or subset of a branch.
2035
2116
 
2036
2117
    log is bzr's default tool for exploring the history of a branch.
2037
2118
    The branch to use is taken from the first parameter. If no parameters
2148
2229
    :Tips & tricks:
2149
2230
 
2150
2231
      GUI tools and IDEs are often better at exploring history than command
2151
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2152
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2153
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2154
 
 
2155
 
      Web interfaces are often better at exploring history than command line
2156
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2157
 
      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>.  
2158
2236
 
2159
2237
      You may find it useful to add the aliases below to ``bazaar.conf``::
2160
2238
 
2221
2299
                   help='Show changes made in each revision as a patch.'),
2222
2300
            Option('include-merges',
2223
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
                   )
2224
2306
            ]
2225
2307
    encoding_type = 'replace'
2226
2308
 
2236
2318
            message=None,
2237
2319
            limit=None,
2238
2320
            show_diff=False,
2239
 
            include_merges=False):
 
2321
            include_merges=False,
 
2322
            exclude_common_ancestry=False,
 
2323
            ):
2240
2324
        from bzrlib.log import (
2241
2325
            Logger,
2242
2326
            make_log_request_dict,
2243
2327
            _get_info_for_log_files,
2244
2328
            )
2245
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')
2246
2334
        if include_merges:
2247
2335
            if levels is None:
2248
2336
                levels = 0
2263
2351
        filter_by_dir = False
2264
2352
        if file_list:
2265
2353
            # find the file ids to log and check for directory filtering
2266
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2267
 
                file_list)
 
2354
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2355
                revision, file_list)
 
2356
            self.add_cleanup(b.unlock)
2268
2357
            for relpath, file_id, kind in file_info_list:
2269
2358
                if file_id is None:
2270
2359
                    raise errors.BzrCommandError(
2288
2377
                location = '.'
2289
2378
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2290
2379
            b = dir.open_branch()
 
2380
            b.lock_read()
 
2381
            self.add_cleanup(b.unlock)
2291
2382
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2292
2383
 
2293
2384
        # Decide on the type of delta & diff filtering to use
2303
2394
        else:
2304
2395
            diff_type = 'full'
2305
2396
 
2306
 
        b.lock_read()
2307
 
        try:
2308
 
            # Build the log formatter
2309
 
            if log_format is None:
2310
 
                log_format = log.log_formatter_registry.get_default(b)
2311
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2312
 
                            show_timezone=timezone,
2313
 
                            delta_format=get_verbosity_level(),
2314
 
                            levels=levels,
2315
 
                            show_advice=levels is None)
2316
 
 
2317
 
            # Choose the algorithm for doing the logging. It's annoying
2318
 
            # having multiple code paths like this but necessary until
2319
 
            # the underlying repository format is faster at generating
2320
 
            # deltas or can provide everything we need from the indices.
2321
 
            # The default algorithm - match-using-deltas - works for
2322
 
            # multiple files and directories and is faster for small
2323
 
            # amounts of history (200 revisions say). However, it's too
2324
 
            # slow for logging a single file in a repository with deep
2325
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2326
 
            # evil when adding features", we continue to use the
2327
 
            # original algorithm - per-file-graph - for the "single
2328
 
            # file that isn't a directory without showing a delta" case.
2329
 
            partial_history = revision and b.repository._format.supports_chks
2330
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2331
 
                or delta_type or partial_history)
2332
 
 
2333
 
            # Build the LogRequest and execute it
2334
 
            if len(file_ids) == 0:
2335
 
                file_ids = None
2336
 
            rqst = make_log_request_dict(
2337
 
                direction=direction, specific_fileids=file_ids,
2338
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2339
 
                message_search=message, delta_type=delta_type,
2340
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2341
 
            Logger(b, rqst).show(lf)
2342
 
        finally:
2343
 
            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)
2344
2436
 
2345
2437
 
2346
2438
def _get_revision_range(revisionspec_list, branch, command_name):
2364
2456
            raise errors.BzrCommandError(
2365
2457
                "bzr %s doesn't accept two revisions in different"
2366
2458
                " branches." % command_name)
2367
 
        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)
2368
2464
        # Avoid loading all of history when we know a missing
2369
2465
        # end of range means the last revision ...
2370
2466
        if end_spec.spec is None:
2399
2495
 
2400
2496
 
2401
2497
class cmd_touching_revisions(Command):
2402
 
    """Return revision-ids which affected a particular file.
 
2498
    __doc__ = """Return revision-ids which affected a particular file.
2403
2499
 
2404
2500
    A more user-friendly interface is "bzr log FILE".
2405
2501
    """
2410
2506
    @display_command
2411
2507
    def run(self, filename):
2412
2508
        tree, relpath = WorkingTree.open_containing(filename)
 
2509
        file_id = tree.path2id(relpath)
2413
2510
        b = tree.branch
2414
 
        file_id = tree.path2id(relpath)
2415
 
        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:
2416
2515
            self.outf.write("%6d %s\n" % (revno, what))
2417
2516
 
2418
2517
 
2419
2518
class cmd_ls(Command):
2420
 
    """List files in a tree.
 
2519
    __doc__ = """List files in a tree.
2421
2520
    """
2422
2521
 
2423
2522
    _see_also = ['status', 'cat']
2471
2570
        if from_root:
2472
2571
            if relpath:
2473
2572
                prefix = relpath + '/'
2474
 
        elif fs_path != '.':
 
2573
        elif fs_path != '.' and not fs_path.endswith('/'):
2475
2574
            prefix = fs_path + '/'
2476
2575
 
2477
2576
        if revision is not None or tree is None:
2486
2585
                note("Ignoring files outside view. View is %s" % view_str)
2487
2586
 
2488
2587
        tree.lock_read()
2489
 
        try:
2490
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2491
 
                from_dir=relpath, recursive=recursive):
2492
 
                # Apply additional masking
2493
 
                if not all and not selection[fc]:
2494
 
                    continue
2495
 
                if kind is not None and fkind != kind:
2496
 
                    continue
2497
 
                if apply_view:
2498
 
                    try:
2499
 
                        if relpath:
2500
 
                            fullpath = osutils.pathjoin(relpath, fp)
2501
 
                        else:
2502
 
                            fullpath = fp
2503
 
                        views.check_path_in_view(tree, fullpath)
2504
 
                    except errors.FileOutsideView:
2505
 
                        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
2506
2605
 
2507
 
                # Output the entry
2508
 
                if prefix:
2509
 
                    fp = osutils.pathjoin(prefix, fp)
2510
 
                kindch = entry.kind_character()
2511
 
                outstring = fp + kindch
2512
 
                ui.ui_factory.clear_term()
2513
 
                if verbose:
2514
 
                    outstring = '%-8s %s' % (fc, outstring)
2515
 
                    if show_ids and fid is not None:
2516
 
                        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:
2517
2632
                    self.outf.write(outstring + '\n')
2518
 
                elif null:
2519
 
                    self.outf.write(fp + '\0')
2520
 
                    if show_ids:
2521
 
                        if fid is not None:
2522
 
                            self.outf.write(fid)
2523
 
                        self.outf.write('\0')
2524
 
                    self.outf.flush()
2525
 
                else:
2526
 
                    if show_ids:
2527
 
                        if fid is not None:
2528
 
                            my_id = fid
2529
 
                        else:
2530
 
                            my_id = ''
2531
 
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
2532
 
                    else:
2533
 
                        self.outf.write(outstring + '\n')
2534
 
        finally:
2535
 
            tree.unlock()
2536
2633
 
2537
2634
 
2538
2635
class cmd_unknowns(Command):
2539
 
    """List unknown files.
 
2636
    __doc__ = """List unknown files.
2540
2637
    """
2541
2638
 
2542
2639
    hidden = True
2549
2646
 
2550
2647
 
2551
2648
class cmd_ignore(Command):
2552
 
    """Ignore specified files or patterns.
 
2649
    __doc__ = """Ignore specified files or patterns.
2553
2650
 
2554
2651
    See ``bzr help patterns`` for details on the syntax of patterns.
2555
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
 
2556
2659
    To remove patterns from the ignore list, edit the .bzrignore file.
2557
2660
    After adding, editing or deleting that file either indirectly by
2558
2661
    using this command or directly by using an editor, be sure to commit
2559
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.
2560
2676
 
2561
2677
    Note: ignore patterns containing shell wildcards must be quoted from
2562
2678
    the shell on Unix.
2566
2682
 
2567
2683
            bzr ignore ./Makefile
2568
2684
 
2569
 
        Ignore class files in all directories::
 
2685
        Ignore .class files in all directories...::
2570
2686
 
2571
2687
            bzr ignore "*.class"
2572
2688
 
 
2689
        ...but do not ignore "special.class"::
 
2690
 
 
2691
            bzr ignore "!special.class"
 
2692
 
2573
2693
        Ignore .o files under the lib directory::
2574
2694
 
2575
2695
            bzr ignore "lib/**/*.o"
2581
2701
        Ignore everything but the "debian" toplevel directory::
2582
2702
 
2583
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 "!!*~"
2584
2711
    """
2585
2712
 
2586
2713
    _see_also = ['status', 'ignored', 'patterns']
2587
2714
    takes_args = ['name_pattern*']
2588
2715
    takes_options = [
2589
 
        Option('old-default-rules',
2590
 
               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.')
2591
2718
        ]
2592
2719
 
2593
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2720
    def run(self, name_pattern_list=None, default_rules=None):
2594
2721
        from bzrlib import ignores
2595
 
        if old_default_rules is not None:
2596
 
            # dump the rules and exit
2597
 
            for pattern in ignores.OLD_DEFAULTS:
2598
 
                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)
2599
2726
            return
2600
2727
        if not name_pattern_list:
2601
2728
            raise errors.BzrCommandError("ignore requires at least one "
2602
 
                                  "NAME_PATTERN or --old-default-rules")
 
2729
                "NAME_PATTERN or --default-rules.")
2603
2730
        name_pattern_list = [globbing.normalize_pattern(p)
2604
2731
                             for p in name_pattern_list]
2605
2732
        for name_pattern in name_pattern_list:
2617
2744
            if id is not None:
2618
2745
                filename = entry[0]
2619
2746
                if ignored.match(filename):
2620
 
                    matches.append(filename.encode('utf-8'))
 
2747
                    matches.append(filename)
2621
2748
        tree.unlock()
2622
2749
        if len(matches) > 0:
2623
 
            print "Warning: the following files are version controlled and" \
2624
 
                  " match your ignore pattern:\n%s" \
2625
 
                  "\nThese files will continue to be version controlled" \
2626
 
                  " 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),))
2627
2754
 
2628
2755
 
2629
2756
class cmd_ignored(Command):
2630
 
    """List ignored files and the patterns that matched them.
 
2757
    __doc__ = """List ignored files and the patterns that matched them.
2631
2758
 
2632
2759
    List all the ignored files and the ignore pattern that caused the file to
2633
2760
    be ignored.
2644
2771
    def run(self):
2645
2772
        tree = WorkingTree.open_containing(u'.')[0]
2646
2773
        tree.lock_read()
2647
 
        try:
2648
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2649
 
                if file_class != 'I':
2650
 
                    continue
2651
 
                ## XXX: Slightly inefficient since this was already calculated
2652
 
                pat = tree.is_ignored(path)
2653
 
                self.outf.write('%-50s %s\n' % (path, pat))
2654
 
        finally:
2655
 
            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))
2656
2781
 
2657
2782
 
2658
2783
class cmd_lookup_revision(Command):
2659
 
    """Lookup the revision-id from a revision-number
 
2784
    __doc__ = """Lookup the revision-id from a revision-number
2660
2785
 
2661
2786
    :Examples:
2662
2787
        bzr lookup-revision 33
2669
2794
        try:
2670
2795
            revno = int(revno)
2671
2796
        except ValueError:
2672
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2673
 
 
2674
 
        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)
2675
2801
 
2676
2802
 
2677
2803
class cmd_export(Command):
2678
 
    """Export current or past revision to a destination directory or archive.
 
2804
    __doc__ = """Export current or past revision to a destination directory or archive.
2679
2805
 
2680
2806
    If no revision is specified this exports the last committed revision.
2681
2807
 
2713
2839
        Option('root',
2714
2840
               type=str,
2715
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.'),
2716
2845
        ]
2717
2846
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2718
 
        root=None, filters=False):
 
2847
        root=None, filters=False, per_file_timestamps=False):
2719
2848
        from bzrlib.export import export
2720
2849
 
2721
2850
        if branch_or_subdir is None:
2728
2857
 
2729
2858
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2730
2859
        try:
2731
 
            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)
2732
2862
        except errors.NoSuchExportFormat, e:
2733
2863
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2734
2864
 
2735
2865
 
2736
2866
class cmd_cat(Command):
2737
 
    """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.
2738
2868
 
2739
2869
    If no revision is nominated, the last revision is used.
2740
2870
 
2761
2891
        tree, branch, relpath = \
2762
2892
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2763
2893
        branch.lock_read()
2764
 
        try:
2765
 
            return self._run(tree, branch, relpath, filename, revision,
2766
 
                             name_from_revision, filters)
2767
 
        finally:
2768
 
            branch.unlock()
 
2894
        self.add_cleanup(branch.unlock)
 
2895
        return self._run(tree, branch, relpath, filename, revision,
 
2896
                         name_from_revision, filters)
2769
2897
 
2770
2898
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2771
2899
        filtered):
2772
2900
        if tree is None:
2773
2901
            tree = b.basis_tree()
2774
2902
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2903
        rev_tree.lock_read()
 
2904
        self.add_cleanup(rev_tree.unlock)
2775
2905
 
2776
2906
        old_file_id = rev_tree.path2id(relpath)
2777
2907
 
2812
2942
            chunks = content.splitlines(True)
2813
2943
            content = filtered_output_bytes(chunks, filters,
2814
2944
                ContentFilterContext(relpath, rev_tree))
 
2945
            self.cleanup_now()
2815
2946
            self.outf.writelines(content)
2816
2947
        else:
 
2948
            self.cleanup_now()
2817
2949
            self.outf.write(content)
2818
2950
 
2819
2951
 
2820
2952
class cmd_local_time_offset(Command):
2821
 
    """Show the offset in seconds from GMT to local time."""
 
2953
    __doc__ = """Show the offset in seconds from GMT to local time."""
2822
2954
    hidden = True
2823
2955
    @display_command
2824
2956
    def run(self):
2825
 
        print osutils.local_time_offset()
 
2957
        self.outf.write("%s\n" % osutils.local_time_offset())
2826
2958
 
2827
2959
 
2828
2960
 
2829
2961
class cmd_commit(Command):
2830
 
    """Commit changes into a new revision.
 
2962
    __doc__ = """Commit changes into a new revision.
2831
2963
 
2832
2964
    An explanatory message needs to be given for each commit. This is
2833
2965
    often done by using the --message option (getting the message from the
2926
3058
             Option('strict',
2927
3059
                    help="Refuse to commit if there are unknown "
2928
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'."),
2929
3064
             ListOption('fixes', type=str,
2930
3065
                    help="Mark a bug as being fixed by this revision "
2931
3066
                         "(see \"bzr help bugs\")."),
2938
3073
                         "the master branch until a normal commit "
2939
3074
                         "is performed."
2940
3075
                    ),
2941
 
              Option('show-diff',
2942
 
                     help='When no message is supplied, show the diff along'
2943
 
                     ' 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.'),
2944
3079
             ]
2945
3080
    aliases = ['ci', 'checkin']
2946
3081
 
2965
3100
 
2966
3101
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2967
3102
            unchanged=False, strict=False, local=False, fixes=None,
2968
 
            author=None, show_diff=False, exclude=None):
 
3103
            author=None, show_diff=False, exclude=None, commit_time=None):
2969
3104
        from bzrlib.errors import (
2970
3105
            PointlessCommit,
2971
3106
            ConflictsInTree,
2977
3112
            make_commit_message_template_encoded
2978
3113
        )
2979
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
 
2980
3123
        # TODO: Need a blackbox test for invoking the external editor; may be
2981
3124
        # slightly problematic to run this cross-platform.
2982
3125
 
3002
3145
        if local and not tree.branch.get_bound_location():
3003
3146
            raise errors.LocalRequiresBoundBranch()
3004
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
 
3005
3169
        def get_message(commit_obj):
3006
3170
            """Callback to get commit message"""
3007
 
            my_message = message
3008
 
            if my_message is None and not file:
3009
 
                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,
3010
3180
                        selected_list, diff=show_diff,
3011
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.
3012
3187
                start_message = generate_commit_message_template(commit_obj)
3013
 
                my_message = edit_commit_message_encoded(t,
 
3188
                my_message = edit_commit_message_encoded(text,
3014
3189
                    start_message=start_message)
3015
3190
                if my_message is None:
3016
3191
                    raise errors.BzrCommandError("please specify a commit"
3017
3192
                        " message with either --message or --file")
3018
 
            elif my_message and file:
3019
 
                raise errors.BzrCommandError(
3020
 
                    "please specify either --message or --file")
3021
 
            if file:
3022
 
                my_message = codecs.open(file, 'rt',
3023
 
                                         osutils.get_user_encoding()).read()
3024
3193
            if my_message == "":
3025
3194
                raise errors.BzrCommandError("empty commit message specified")
3026
3195
            return my_message
3027
3196
 
 
3197
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3198
        # but the command line should not do that.
 
3199
        if not selected_list:
 
3200
            selected_list = None
3028
3201
        try:
3029
3202
            tree.commit(message_callback=get_message,
3030
3203
                        specific_files=selected_list,
3031
3204
                        allow_pointless=unchanged, strict=strict, local=local,
3032
3205
                        reporter=None, verbose=verbose, revprops=properties,
3033
 
                        authors=author,
 
3206
                        authors=author, timestamp=commit_stamp,
 
3207
                        timezone=offset,
3034
3208
                        exclude=safe_relpath_files(tree, exclude))
3035
3209
        except PointlessCommit:
3036
 
            # FIXME: This should really happen before the file is read in;
3037
 
            # perhaps prepare the commit; get the message; then actually commit
3038
3210
            raise errors.BzrCommandError("No changes to commit."
3039
3211
                              " Use --unchanged to commit anyhow.")
3040
3212
        except ConflictsInTree:
3045
3217
            raise errors.BzrCommandError("Commit refused because there are"
3046
3218
                              " unknown files in the working tree.")
3047
3219
        except errors.BoundBranchOutOfDate, e:
3048
 
            raise errors.BzrCommandError(str(e) + "\n"
3049
 
            'To commit to master branch, run update and then commit.\n'
3050
 
            'You can also pass --local to commit to continue working '
3051
 
            '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
3052
3225
 
3053
3226
 
3054
3227
class cmd_check(Command):
3055
 
    """Validate working tree structure, branch consistency and repository history.
 
3228
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3056
3229
 
3057
3230
    This command checks various invariants about branch and repository storage
3058
3231
    to detect data corruption or bzr bugs.
3122
3295
 
3123
3296
 
3124
3297
class cmd_upgrade(Command):
3125
 
    """Upgrade branch storage to current format.
 
3298
    __doc__ = """Upgrade branch storage to current format.
3126
3299
 
3127
3300
    The check command or bzr developers may sometimes advise you to run
3128
3301
    this command. When the default format has changed you may also be warned
3146
3319
 
3147
3320
 
3148
3321
class cmd_whoami(Command):
3149
 
    """Show or set bzr user id.
 
3322
    __doc__ = """Show or set bzr user id.
3150
3323
 
3151
3324
    :Examples:
3152
3325
        Show the email of the current user::
3196
3369
 
3197
3370
 
3198
3371
class cmd_nick(Command):
3199
 
    """Print or set the branch nickname.
 
3372
    __doc__ = """Print or set the branch nickname.
3200
3373
 
3201
3374
    If unset, the tree root directory name is used as the nickname.
3202
3375
    To print the current nickname, execute with no argument.
3216
3389
 
3217
3390
    @display_command
3218
3391
    def printme(self, branch):
3219
 
        print branch.nick
 
3392
        self.outf.write('%s\n' % branch.nick)
3220
3393
 
3221
3394
 
3222
3395
class cmd_alias(Command):
3223
 
    """Set/unset and display aliases.
 
3396
    __doc__ = """Set/unset and display aliases.
3224
3397
 
3225
3398
    :Examples:
3226
3399
        Show the current aliases::
3290
3463
 
3291
3464
 
3292
3465
class cmd_selftest(Command):
3293
 
    """Run internal test suite.
 
3466
    __doc__ = """Run internal test suite.
3294
3467
 
3295
3468
    If arguments are given, they are regular expressions that say which tests
3296
3469
    should run.  Tests matching any expression are run, and other tests are
3323
3496
    Tests that need working space on disk use a common temporary directory,
3324
3497
    typically inside $TMPDIR or /tmp.
3325
3498
 
 
3499
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3500
    into a pdb postmortem session.
 
3501
 
3326
3502
    :Examples:
3327
3503
        Run only tests relating to 'ignore'::
3328
3504
 
3337
3513
    def get_transport_type(typestring):
3338
3514
        """Parse and return a transport specifier."""
3339
3515
        if typestring == "sftp":
3340
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3341
 
            return SFTPAbsoluteServer
 
3516
            from bzrlib.tests import stub_sftp
 
3517
            return stub_sftp.SFTPAbsoluteServer
3342
3518
        if typestring == "memory":
3343
 
            from bzrlib.transport.memory import MemoryServer
3344
 
            return MemoryServer
 
3519
            from bzrlib.tests import test_server
 
3520
            return memory.MemoryServer
3345
3521
        if typestring == "fakenfs":
3346
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3347
 
            return FakeNFSServer
 
3522
            from bzrlib.tests import test_server
 
3523
            return test_server.FakeNFSServer
3348
3524
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3349
3525
            (typestring)
3350
3526
        raise errors.BzrCommandError(msg)
3365
3541
                     Option('lsprof-timed',
3366
3542
                            help='Generate lsprof output for benchmarked'
3367
3543
                                 ' sections of code.'),
 
3544
                     Option('lsprof-tests',
 
3545
                            help='Generate lsprof output for each test.'),
3368
3546
                     Option('cache-dir', type=str,
3369
3547
                            help='Cache intermediate benchmark output in this '
3370
3548
                                 'directory.'),
3411
3589
            first=False, list_only=False,
3412
3590
            randomize=None, exclude=None, strict=False,
3413
3591
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3414
 
            parallel=None):
 
3592
            parallel=None, lsprof_tests=False):
3415
3593
        from bzrlib.tests import selftest
3416
3594
        import bzrlib.benchmarks as benchmarks
3417
3595
        from bzrlib.benchmarks import tree_creator
3432
3610
                raise errors.BzrCommandError("subunit not available. subunit "
3433
3611
                    "needs to be installed to use --subunit.")
3434
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)
3435
3618
        if parallel:
3436
3619
            self.additional_selftest_args.setdefault(
3437
3620
                'suite_decorators', []).append(parallel)
3441
3624
            verbose = not is_quiet()
3442
3625
            # TODO: should possibly lock the history file...
3443
3626
            benchfile = open(".perf_history", "at", buffering=1)
 
3627
            self.add_cleanup(benchfile.close)
3444
3628
        else:
3445
3629
            test_suite_factory = None
3446
3630
            benchfile = None
3447
 
        try:
3448
 
            selftest_kwargs = {"verbose": verbose,
3449
 
                              "pattern": pattern,
3450
 
                              "stop_on_failure": one,
3451
 
                              "transport": transport,
3452
 
                              "test_suite_factory": test_suite_factory,
3453
 
                              "lsprof_timed": lsprof_timed,
3454
 
                              "bench_history": benchfile,
3455
 
                              "matching_tests_first": first,
3456
 
                              "list_only": list_only,
3457
 
                              "random_seed": randomize,
3458
 
                              "exclude_pattern": exclude,
3459
 
                              "strict": strict,
3460
 
                              "load_list": load_list,
3461
 
                              "debug_flags": debugflag,
3462
 
                              "starting_with": starting_with
3463
 
                              }
3464
 
            selftest_kwargs.update(self.additional_selftest_args)
3465
 
            result = selftest(**selftest_kwargs)
3466
 
        finally:
3467
 
            if benchfile is not None:
3468
 
                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)
3469
3650
        return int(not result)
3470
3651
 
3471
3652
 
3472
3653
class cmd_version(Command):
3473
 
    """Show version of bzr."""
 
3654
    __doc__ = """Show version of bzr."""
3474
3655
 
3475
3656
    encoding_type = 'replace'
3476
3657
    takes_options = [
3487
3668
 
3488
3669
 
3489
3670
class cmd_rocks(Command):
3490
 
    """Statement of optimism."""
 
3671
    __doc__ = """Statement of optimism."""
3491
3672
 
3492
3673
    hidden = True
3493
3674
 
3494
3675
    @display_command
3495
3676
    def run(self):
3496
 
        print "It sure does!"
 
3677
        self.outf.write("It sure does!\n")
3497
3678
 
3498
3679
 
3499
3680
class cmd_find_merge_base(Command):
3500
 
    """Find and print a base revision for merging two branches."""
 
3681
    __doc__ = """Find and print a base revision for merging two branches."""
3501
3682
    # TODO: Options to specify revisions on either side, as if
3502
3683
    #       merging only part of the history.
3503
3684
    takes_args = ['branch', 'other']
3510
3691
        branch1 = Branch.open_containing(branch)[0]
3511
3692
        branch2 = Branch.open_containing(other)[0]
3512
3693
        branch1.lock_read()
3513
 
        try:
3514
 
            branch2.lock_read()
3515
 
            try:
3516
 
                last1 = ensure_null(branch1.last_revision())
3517
 
                last2 = ensure_null(branch2.last_revision())
3518
 
 
3519
 
                graph = branch1.repository.get_graph(branch2.repository)
3520
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3521
 
 
3522
 
                print 'merge base is revision %s' % base_rev_id
3523
 
            finally:
3524
 
                branch2.unlock()
3525
 
        finally:
3526
 
            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)
3527
3704
 
3528
3705
 
3529
3706
class cmd_merge(Command):
3530
 
    """Perform a three-way merge.
 
3707
    __doc__ = """Perform a three-way merge.
3531
3708
 
3532
3709
    The source of the merge can be specified either in the form of a branch,
3533
3710
    or in the form of a path to a file containing a merge directive generated
3562
3739
    committed to record the result of the merge.
3563
3740
 
3564
3741
    merge refuses to run if there are any uncommitted changes, unless
3565
 
    --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.
3566
3748
 
3567
3749
    To select only some changes to merge, use "merge -i", which will prompt
3568
3750
    you to apply each diff hunk and file change, similar to "shelve".
3580
3762
 
3581
3763
            bzr merge -r 81..82 ../bzr.dev
3582
3764
 
3583
 
        To apply a merge directive contained in /tmp/merge:
 
3765
        To apply a merge directive contained in /tmp/merge::
3584
3766
 
3585
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'
3586
3775
    """
3587
3776
 
3588
3777
    encoding_type = 'exact'
3633
3822
        verified = 'inapplicable'
3634
3823
        tree = WorkingTree.open_containing(directory)[0]
3635
3824
 
3636
 
        # die as quickly as possible if there are uncommitted changes
3637
3825
        try:
3638
3826
            basis_tree = tree.revision_tree(tree.last_revision())
3639
3827
        except errors.NoSuchRevision:
3640
3828
            basis_tree = tree.basis_tree()
 
3829
 
 
3830
        # die as quickly as possible if there are uncommitted changes
3641
3831
        if not force:
3642
 
            if tree.has_changes(basis_tree):
 
3832
            if tree.has_changes():
3643
3833
                raise errors.UncommittedChanges(tree)
3644
3834
 
3645
3835
        view_info = _get_view_info_for_change_reporter(tree)
3646
3836
        change_reporter = delta._ChangeReporter(
3647
3837
            unversioned_filter=tree.is_ignored, view_info=view_info)
3648
 
        cleanups = []
3649
 
        try:
3650
 
            pb = ui.ui_factory.nested_progress_bar()
3651
 
            cleanups.append(pb.finished)
3652
 
            tree.lock_write()
3653
 
            cleanups.append(tree.unlock)
3654
 
            if location is not None:
3655
 
                try:
3656
 
                    mergeable = bundle.read_mergeable_from_url(location,
3657
 
                        possible_transports=possible_transports)
3658
 
                except errors.NotABundle:
3659
 
                    mergeable = None
3660
 
                else:
3661
 
                    if uncommitted:
3662
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3663
 
                            ' with bundles or merge directives.')
3664
 
 
3665
 
                    if revision is not None:
3666
 
                        raise errors.BzrCommandError(
3667
 
                            'Cannot use -r with merge directives or bundles')
3668
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3669
 
                       mergeable, pb)
3670
 
 
3671
 
            if merger is None and uncommitted:
3672
 
                if revision is not None and len(revision) > 0:
3673
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3674
 
                        ' --revision at the same time.')
3675
 
                merger = self.get_merger_from_uncommitted(tree, location, pb,
3676
 
                                                          cleanups)
3677
 
                allow_pending = False
3678
 
 
3679
 
            if merger is None:
3680
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3681
 
                    location, revision, remember, possible_transports, pb)
3682
 
 
3683
 
            merger.merge_type = merge_type
3684
 
            merger.reprocess = reprocess
3685
 
            merger.show_base = show_base
3686
 
            self.sanity_check_merger(merger)
3687
 
            if (merger.base_rev_id == merger.other_rev_id and
3688
 
                merger.other_rev_id is not None):
3689
 
                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)
3690
3885
                return 0
3691
 
            if pull:
3692
 
                if merger.interesting_files is not None:
3693
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3694
 
                if (merger.base_rev_id == tree.last_revision()):
3695
 
                    result = tree.pull(merger.other_branch, False,
3696
 
                                       merger.other_rev_id)
3697
 
                    result.report(self.outf)
3698
 
                    return 0
3699
 
            merger.check_basis(False)
3700
 
            if preview:
3701
 
                return self._do_preview(merger, cleanups)
3702
 
            elif interactive:
3703
 
                return self._do_interactive(merger, cleanups)
3704
 
            else:
3705
 
                return self._do_merge(merger, change_reporter, allow_pending,
3706
 
                                      verified)
3707
 
        finally:
3708
 
            for cleanup in reversed(cleanups):
3709
 
                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)
3710
3897
 
3711
 
    def _get_preview(self, merger, cleanups):
 
3898
    def _get_preview(self, merger):
3712
3899
        tree_merger = merger.make_merger()
3713
3900
        tt = tree_merger.make_preview_transform()
3714
 
        cleanups.append(tt.finalize)
 
3901
        self.add_cleanup(tt.finalize)
3715
3902
        result_tree = tt.get_preview_tree()
3716
3903
        return result_tree
3717
3904
 
3718
 
    def _do_preview(self, merger, cleanups):
 
3905
    def _do_preview(self, merger):
3719
3906
        from bzrlib.diff import show_diff_trees
3720
 
        result_tree = self._get_preview(merger, cleanups)
 
3907
        result_tree = self._get_preview(merger)
3721
3908
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3722
3909
                        old_label='', new_label='')
3723
3910
 
3733
3920
        else:
3734
3921
            return 0
3735
3922
 
3736
 
    def _do_interactive(self, merger, cleanups):
 
3923
    def _do_interactive(self, merger):
3737
3924
        """Perform an interactive merge.
3738
3925
 
3739
3926
        This works by generating a preview tree of the merge, then using
3741
3928
        and the preview tree.
3742
3929
        """
3743
3930
        from bzrlib import shelf_ui
3744
 
        result_tree = self._get_preview(merger, cleanups)
 
3931
        result_tree = self._get_preview(merger)
3745
3932
        writer = bzrlib.option.diff_writer_registry.get()
3746
3933
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3747
3934
                                   reporter=shelf_ui.ApplyReporter(),
3748
3935
                                   diff_writer=writer(sys.stdout))
3749
 
        shelver.run()
 
3936
        try:
 
3937
            shelver.run()
 
3938
        finally:
 
3939
            shelver.finalize()
3750
3940
 
3751
3941
    def sanity_check_merger(self, merger):
3752
3942
        if (merger.show_base and
3812
4002
            allow_pending = True
3813
4003
        return merger, allow_pending
3814
4004
 
3815
 
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
4005
    def get_merger_from_uncommitted(self, tree, location, pb):
3816
4006
        """Get a merger for uncommitted changes.
3817
4007
 
3818
4008
        :param tree: The tree the merger should apply to.
3819
4009
        :param location: The location containing uncommitted changes.
3820
4010
        :param pb: The progress bar to use for showing progress.
3821
 
        :param cleanups: A list of operations to perform to clean up the
3822
 
            temporary directories, unfinalized objects, etc.
3823
4011
        """
3824
4012
        location = self._select_branch_location(tree, location)[0]
3825
4013
        other_tree, other_path = WorkingTree.open_containing(location)
3877
4065
 
3878
4066
 
3879
4067
class cmd_remerge(Command):
3880
 
    """Redo a merge.
 
4068
    __doc__ = """Redo a merge.
3881
4069
 
3882
4070
    Use this if you want to try a different merge technique while resolving
3883
4071
    conflicts.  Some merge techniques are better than others, and remerge
3908
4096
 
3909
4097
    def run(self, file_list=None, merge_type=None, show_base=False,
3910
4098
            reprocess=False):
 
4099
        from bzrlib.conflicts import restore
3911
4100
        if merge_type is None:
3912
4101
            merge_type = _mod_merge.Merge3Merger
3913
4102
        tree, file_list = tree_files(file_list)
3914
4103
        tree.lock_write()
3915
 
        try:
3916
 
            parents = tree.get_parent_ids()
3917
 
            if len(parents) != 2:
3918
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3919
 
                                             " merges.  Not cherrypicking or"
3920
 
                                             " multi-merges.")
3921
 
            repository = tree.branch.repository
3922
 
            interesting_ids = None
3923
 
            new_conflicts = []
3924
 
            conflicts = tree.conflicts()
3925
 
            if file_list is not None:
3926
 
                interesting_ids = set()
3927
 
                for filename in file_list:
3928
 
                    file_id = tree.path2id(filename)
3929
 
                    if file_id is None:
3930
 
                        raise errors.NotVersionedError(filename)
3931
 
                    interesting_ids.add(file_id)
3932
 
                    if tree.kind(file_id) != "directory":
3933
 
                        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
3934
4123
 
3935
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3936
 
                        interesting_ids.add(ie.file_id)
3937
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3938
 
            else:
3939
 
                # Remerge only supports resolving contents conflicts
3940
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3941
 
                restore_files = [c.path for c in conflicts
3942
 
                                 if c.typestring in allowed_conflicts]
3943
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3944
 
            tree.set_conflicts(ConflictList(new_conflicts))
3945
 
            if file_list is not None:
3946
 
                restore_files = file_list
3947
 
            for filename in restore_files:
3948
 
                try:
3949
 
                    restore(tree.abspath(filename))
3950
 
                except errors.NotConflicted:
3951
 
                    pass
3952
 
            # Disable pending merges, because the file texts we are remerging
3953
 
            # have not had those merges performed.  If we use the wrong parents
3954
 
            # list, we imply that the working tree text has seen and rejected
3955
 
            # all the changes from the other tree, when in fact those changes
3956
 
            # have not yet been seen.
3957
 
            pb = ui.ui_factory.nested_progress_bar()
3958
 
            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:
3959
4137
            try:
3960
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3961
 
                                                             tree, parents[1])
3962
 
                merger.interesting_ids = interesting_ids
3963
 
                merger.merge_type = merge_type
3964
 
                merger.show_base = show_base
3965
 
                merger.reprocess = reprocess
3966
 
                conflicts = merger.do_merge()
3967
 
            finally:
3968
 
                tree.set_parent_ids(parents)
3969
 
                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()
3970
4154
        finally:
3971
 
            tree.unlock()
 
4155
            tree.set_parent_ids(parents)
3972
4156
        if conflicts > 0:
3973
4157
            return 1
3974
4158
        else:
3976
4160
 
3977
4161
 
3978
4162
class cmd_revert(Command):
3979
 
    """Revert files to a previous revision.
 
4163
    __doc__ = """Revert files to a previous revision.
3980
4164
 
3981
4165
    Giving a list of files will revert only those files.  Otherwise, all files
3982
4166
    will be reverted.  If the revision is not specified with '--revision', the
3996
4180
    name.  If you name a directory, all the contents of that directory will be
3997
4181
    reverted.
3998
4182
 
3999
 
    Any files that have been newly added since that revision will be deleted,
4000
 
    with a backup kept if appropriate.  Directories containing unknown files
4001
 
    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.
4002
4187
 
4003
 
    The working tree contains a list of pending merged revisions, which will
4004
 
    be included as parents in the next commit.  Normally, revert clears that
4005
 
    list as well as reverting the files.  If any files are specified, revert
4006
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
4007
 
    revert ." in the tree root to revert all files but keep the merge record,
4008
 
    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
4009
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.
4010
4206
    """
4011
4207
 
4012
4208
    _see_also = ['cat', 'export']
4021
4217
    def run(self, revision=None, no_backup=False, file_list=None,
4022
4218
            forget_merges=None):
4023
4219
        tree, file_list = tree_files(file_list)
4024
 
        tree.lock_write()
4025
 
        try:
4026
 
            if forget_merges:
4027
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
4028
 
            else:
4029
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
4030
 
        finally:
4031
 
            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)
4032
4226
 
4033
4227
    @staticmethod
4034
4228
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4035
4229
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4036
 
        pb = ui.ui_factory.nested_progress_bar()
4037
 
        try:
4038
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
4039
 
                report_changes=True)
4040
 
        finally:
4041
 
            pb.finished()
 
4230
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4231
            report_changes=True)
4042
4232
 
4043
4233
 
4044
4234
class cmd_assert_fail(Command):
4045
 
    """Test reporting of assertion failures"""
 
4235
    __doc__ = """Test reporting of assertion failures"""
4046
4236
    # intended just for use in testing
4047
4237
 
4048
4238
    hidden = True
4052
4242
 
4053
4243
 
4054
4244
class cmd_help(Command):
4055
 
    """Show help on a command or other topic.
 
4245
    __doc__ = """Show help on a command or other topic.
4056
4246
    """
4057
4247
 
4058
4248
    _see_also = ['topics']
4071
4261
 
4072
4262
 
4073
4263
class cmd_shell_complete(Command):
4074
 
    """Show appropriate completions for context.
 
4264
    __doc__ = """Show appropriate completions for context.
4075
4265
 
4076
4266
    For a list of all available commands, say 'bzr shell-complete'.
4077
4267
    """
4086
4276
 
4087
4277
 
4088
4278
class cmd_missing(Command):
4089
 
    """Show unmerged/unpulled revisions between two branches.
 
4279
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4090
4280
 
4091
4281
    OTHER_BRANCH may be local or remote.
4092
4282
 
4093
4283
    To filter on a range of revisions, you can use the command -r begin..end
4094
4284
    -r revision requests a specific revision, -r ..end or -r begin.. are
4095
4285
    also valid.
 
4286
            
 
4287
    :Exit values:
 
4288
        1 - some missing revisions
 
4289
        0 - no missing revisions
4096
4290
 
4097
4291
    :Examples:
4098
4292
 
4166
4360
            restrict = 'remote'
4167
4361
 
4168
4362
        local_branch = Branch.open_containing(u".")[0]
 
4363
        local_branch.lock_read()
 
4364
        self.add_cleanup(local_branch.unlock)
 
4365
 
4169
4366
        parent = local_branch.get_parent()
4170
4367
        if other_branch is None:
4171
4368
            other_branch = parent
4180
4377
        remote_branch = Branch.open(other_branch)
4181
4378
        if remote_branch.base == local_branch.base:
4182
4379
            remote_branch = local_branch
 
4380
        else:
 
4381
            remote_branch.lock_read()
 
4382
            self.add_cleanup(remote_branch.unlock)
4183
4383
 
4184
4384
        local_revid_range = _revision_range_to_revid_range(
4185
4385
            _get_revision_range(my_revision, local_branch,
4189
4389
            _get_revision_range(revision,
4190
4390
                remote_branch, self.name()))
4191
4391
 
4192
 
        local_branch.lock_read()
4193
 
        try:
4194
 
            remote_branch.lock_read()
4195
 
            try:
4196
 
                local_extra, remote_extra = find_unmerged(
4197
 
                    local_branch, remote_branch, restrict,
4198
 
                    backward=not reverse,
4199
 
                    include_merges=include_merges,
4200
 
                    local_revid_range=local_revid_range,
4201
 
                    remote_revid_range=remote_revid_range)
4202
 
 
4203
 
                if log_format is None:
4204
 
                    registry = log.log_formatter_registry
4205
 
                    log_format = registry.get_default(local_branch)
4206
 
                lf = log_format(to_file=self.outf,
4207
 
                                show_ids=show_ids,
4208
 
                                show_timezone='original')
4209
 
 
4210
 
                status_code = 0
4211
 
                if local_extra and not theirs_only:
4212
 
                    message("You have %d extra revision(s):\n" %
4213
 
                        len(local_extra))
4214
 
                    for revision in iter_log_revisions(local_extra,
4215
 
                                        local_branch.repository,
4216
 
                                        verbose):
4217
 
                        lf.log_revision(revision)
4218
 
                    printed_local = True
4219
 
                    status_code = 1
4220
 
                else:
4221
 
                    printed_local = False
4222
 
 
4223
 
                if remote_extra and not mine_only:
4224
 
                    if printed_local is True:
4225
 
                        message("\n\n\n")
4226
 
                    message("You are missing %d revision(s):\n" %
4227
 
                        len(remote_extra))
4228
 
                    for revision in iter_log_revisions(remote_extra,
4229
 
                                        remote_branch.repository,
4230
 
                                        verbose):
4231
 
                        lf.log_revision(revision)
4232
 
                    status_code = 1
4233
 
 
4234
 
                if mine_only and not local_extra:
4235
 
                    # We checked local, and found nothing extra
4236
 
                    message('This branch is up to date.\n')
4237
 
                elif theirs_only and not remote_extra:
4238
 
                    # We checked remote, and found nothing extra
4239
 
                    message('Other branch is up to date.\n')
4240
 
                elif not (mine_only or theirs_only or local_extra or
4241
 
                          remote_extra):
4242
 
                    # We checked both branches, and neither one had extra
4243
 
                    # revisions
4244
 
                    message("Branches are up to date.\n")
4245
 
            finally:
4246
 
                remote_branch.unlock()
4247
 
        finally:
4248
 
            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()
4249
4442
        if not status_code and parent is None and other_branch is not None:
4250
4443
            local_branch.lock_write()
4251
 
            try:
4252
 
                # handle race conditions - a parent might be set while we run.
4253
 
                if local_branch.get_parent() is None:
4254
 
                    local_branch.set_parent(remote_branch.base)
4255
 
            finally:
4256
 
                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)
4257
4448
        return status_code
4258
4449
 
4259
4450
 
4260
4451
class cmd_pack(Command):
4261
 
    """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
    """
4262
4469
 
4263
4470
    _see_also = ['repositories']
4264
4471
    takes_args = ['branch_or_repo?']
 
4472
    takes_options = [
 
4473
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4474
        ]
4265
4475
 
4266
 
    def run(self, branch_or_repo='.'):
 
4476
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4267
4477
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4268
4478
        try:
4269
4479
            branch = dir.open_branch()
4270
4480
            repository = branch.repository
4271
4481
        except errors.NotBranchError:
4272
4482
            repository = dir.open_repository()
4273
 
        repository.pack()
 
4483
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4274
4484
 
4275
4485
 
4276
4486
class cmd_plugins(Command):
4277
 
    """List the installed plugins.
 
4487
    __doc__ = """List the installed plugins.
4278
4488
 
4279
4489
    This command displays the list of installed plugins including
4280
4490
    version of plugin and a short description of each.
4287
4497
    adding new commands, providing additional network transports and
4288
4498
    customizing log output.
4289
4499
 
4290
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4291
 
    information on plugins including where to find them and how to
4292
 
    install them. Instructions are also provided there on how to
4293
 
    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.
4294
4504
    """
4295
4505
    takes_options = ['verbose']
4296
4506
 
4311
4521
                doc = '(no description)'
4312
4522
            result.append((name_ver, doc, plugin.path()))
4313
4523
        for name_ver, doc, path in sorted(result):
4314
 
            print name_ver
4315
 
            print '   ', doc
 
4524
            self.outf.write("%s\n" % name_ver)
 
4525
            self.outf.write("   %s\n" % doc)
4316
4526
            if verbose:
4317
 
                print '   ', path
4318
 
            print
 
4527
                self.outf.write("   %s\n" % path)
 
4528
            self.outf.write("\n")
4319
4529
 
4320
4530
 
4321
4531
class cmd_testament(Command):
4322
 
    """Show testament (signing-form) of a revision."""
 
4532
    __doc__ = """Show testament (signing-form) of a revision."""
4323
4533
    takes_options = [
4324
4534
            'revision',
4325
4535
            Option('long', help='Produce long-format testament.'),
4338
4548
        else:
4339
4549
            b = Branch.open(branch)
4340
4550
        b.lock_read()
4341
 
        try:
4342
 
            if revision is None:
4343
 
                rev_id = b.last_revision()
4344
 
            else:
4345
 
                rev_id = revision[0].as_revision_id(b)
4346
 
            t = testament_class.from_revision(b.repository, rev_id)
4347
 
            if long:
4348
 
                sys.stdout.writelines(t.as_text_lines())
4349
 
            else:
4350
 
                sys.stdout.write(t.as_short_text())
4351
 
        finally:
4352
 
            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())
4353
4561
 
4354
4562
 
4355
4563
class cmd_annotate(Command):
4356
 
    """Show the origin of each line in a file.
 
4564
    __doc__ = """Show the origin of each line in a file.
4357
4565
 
4358
4566
    This prints out the given file with an annotation on the left side
4359
4567
    indicating which revision, author and date introduced the change.
4381
4589
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4382
4590
        if wt is not None:
4383
4591
            wt.lock_read()
 
4592
            self.add_cleanup(wt.unlock)
4384
4593
        else:
4385
4594
            branch.lock_read()
4386
 
        try:
4387
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4388
 
            if wt is not None:
4389
 
                file_id = wt.path2id(relpath)
4390
 
            else:
4391
 
                file_id = tree.path2id(relpath)
4392
 
            if file_id is None:
4393
 
                raise errors.NotVersionedError(filename)
4394
 
            file_version = tree.inventory[file_id].revision
4395
 
            if wt is not None and revision is None:
4396
 
                # If there is a tree and we're not annotating historical
4397
 
                # versions, annotate the working tree's content.
4398
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4399
 
                    show_ids=show_ids)
4400
 
            else:
4401
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4402
 
                              show_ids=show_ids)
4403
 
        finally:
4404
 
            if wt is not None:
4405
 
                wt.unlock()
4406
 
            else:
4407
 
                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)
4408
4614
 
4409
4615
 
4410
4616
class cmd_re_sign(Command):
4411
 
    """Create a digital signature for an existing revision."""
 
4617
    __doc__ = """Create a digital signature for an existing revision."""
4412
4618
    # TODO be able to replace existing ones.
4413
4619
 
4414
4620
    hidden = True # is this right ?
4422
4628
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4423
4629
        b = WorkingTree.open_containing(u'.')[0].branch
4424
4630
        b.lock_write()
4425
 
        try:
4426
 
            return self._run(b, revision_id_list, revision)
4427
 
        finally:
4428
 
            b.unlock()
 
4631
        self.add_cleanup(b.unlock)
 
4632
        return self._run(b, revision_id_list, revision)
4429
4633
 
4430
4634
    def _run(self, b, revision_id_list, revision):
4431
4635
        import bzrlib.gpg as gpg
4476
4680
 
4477
4681
 
4478
4682
class cmd_bind(Command):
4479
 
    """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.
4480
4685
 
4481
4686
    Once converted into a checkout, commits must succeed on the master branch
4482
4687
    before they will be applied to the local branch.
4483
4688
 
4484
4689
    Bound branches use the nickname of its master branch unless it is set
4485
 
    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
4486
4691
    that of the master.
4487
4692
    """
4488
4693
 
4500
4705
                    'This format does not remember old locations.')
4501
4706
            else:
4502
4707
                if location is None:
4503
 
                    raise errors.BzrCommandError('No location supplied and no '
4504
 
                        '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')
4505
4713
        b_other = Branch.open(location)
4506
4714
        try:
4507
4715
            b.bind(b_other)
4513
4721
 
4514
4722
 
4515
4723
class cmd_unbind(Command):
4516
 
    """Convert the current checkout into a regular branch.
 
4724
    __doc__ = """Convert the current checkout into a regular branch.
4517
4725
 
4518
4726
    After unbinding, the local branch is considered independent and subsequent
4519
4727
    commits will be local only.
4530
4738
 
4531
4739
 
4532
4740
class cmd_uncommit(Command):
4533
 
    """Remove the last committed revision.
 
4741
    __doc__ = """Remove the last committed revision.
4534
4742
 
4535
4743
    --verbose will print out what is being removed.
4536
4744
    --dry-run will go through all the motions, but not actually
4577
4785
 
4578
4786
        if tree is not None:
4579
4787
            tree.lock_write()
 
4788
            self.add_cleanup(tree.unlock)
4580
4789
        else:
4581
4790
            b.lock_write()
4582
 
        try:
4583
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4584
 
                             local=local)
4585
 
        finally:
4586
 
            if tree is not None:
4587
 
                tree.unlock()
4588
 
            else:
4589
 
                b.unlock()
 
4791
            self.add_cleanup(b.unlock)
 
4792
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4590
4793
 
4591
4794
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4592
4795
        from bzrlib.log import log_formatter, show_log
4624
4827
                 end_revision=last_revno)
4625
4828
 
4626
4829
        if dry_run:
4627
 
            print 'Dry-run, pretending to remove the above revisions.'
4628
 
            if not force:
4629
 
                val = raw_input('Press <enter> to continue')
 
4830
            self.outf.write('Dry-run, pretending to remove'
 
4831
                            ' the above revisions.\n')
4630
4832
        else:
4631
 
            print 'The above revision(s) will be removed.'
4632
 
            if not force:
4633
 
                val = raw_input('Are you sure [y/N]? ')
4634
 
                if val.lower() not in ('y', 'yes'):
4635
 
                    print 'Canceled'
4636
 
                    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
4637
4839
 
4638
4840
        mutter('Uncommitting from {%s} to {%s}',
4639
4841
               last_rev_id, rev_id)
4640
4842
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4641
4843
                 revno=revno, local=local)
4642
 
        note('You can restore the old tip by running:\n'
4643
 
             '  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)
4644
4846
 
4645
4847
 
4646
4848
class cmd_break_lock(Command):
4647
 
    """Break a dead lock on a repository, branch or working directory.
 
4849
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4648
4850
 
4649
4851
    CAUTION: Locks should only be broken when you are sure that the process
4650
4852
    holding the lock has been stopped.
4651
4853
 
4652
 
    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.
4653
4856
 
4654
4857
    :Examples:
4655
4858
        bzr break-lock
 
4859
        bzr break-lock bzr+ssh://example.com/bzr/foo
4656
4860
    """
4657
4861
    takes_args = ['location?']
4658
4862
 
4667
4871
 
4668
4872
 
4669
4873
class cmd_wait_until_signalled(Command):
4670
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4874
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4671
4875
 
4672
4876
    This just prints a line to signal when it is ready, then blocks on stdin.
4673
4877
    """
4681
4885
 
4682
4886
 
4683
4887
class cmd_serve(Command):
4684
 
    """Run the bzr server."""
 
4888
    __doc__ = """Run the bzr server."""
4685
4889
 
4686
4890
    aliases = ['server']
4687
4891
 
4688
4892
    takes_options = [
4689
4893
        Option('inet',
4690
4894
               help='Serve on stdin/out for use from inetd or sshd.'),
4691
 
        RegistryOption('protocol', 
4692
 
               help="Protocol to serve.", 
 
4895
        RegistryOption('protocol',
 
4896
               help="Protocol to serve.",
4693
4897
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4694
4898
               value_switches=True),
4695
4899
        Option('port',
4704
4908
        Option('allow-writes',
4705
4909
               help='By default the server is a readonly server.  Supplying '
4706
4910
                    '--allow-writes enables write access to the contents of '
4707
 
                    '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.'
4708
4916
                ),
4709
4917
        ]
4710
4918
 
4743
4951
 
4744
4952
 
4745
4953
class cmd_join(Command):
4746
 
    """Combine a tree into its containing tree.
 
4954
    __doc__ = """Combine a tree into its containing tree.
4747
4955
 
4748
4956
    This command requires the target tree to be in a rich-root format.
4749
4957
 
4789
4997
 
4790
4998
 
4791
4999
class cmd_split(Command):
4792
 
    """Split a subdirectory of a tree into a separate tree.
 
5000
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4793
5001
 
4794
5002
    This command will produce a target tree in a format that supports
4795
5003
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4815
5023
 
4816
5024
 
4817
5025
class cmd_merge_directive(Command):
4818
 
    """Generate a merge directive for auto-merge tools.
 
5026
    __doc__ = """Generate a merge directive for auto-merge tools.
4819
5027
 
4820
5028
    A directive requests a merge to be performed, and also provides all the
4821
5029
    information necessary to do so.  This means it must either include a
4914
5122
 
4915
5123
 
4916
5124
class cmd_send(Command):
4917
 
    """Mail or create a merge-directive for submitting changes.
 
5125
    __doc__ = """Mail or create a merge-directive for submitting changes.
4918
5126
 
4919
5127
    A merge directive provides many things needed for requesting merges:
4920
5128
 
4926
5134
      directly from the merge directive, without retrieving data from a
4927
5135
      branch.
4928
5136
 
4929
 
    If --no-bundle is specified, then public_branch is needed (and must be
4930
 
    up-to-date), so that the receiver can perform the merge using the
4931
 
    public_branch.  The public_branch is always included if known, so that
4932
 
    people can check it later.
4933
 
 
4934
 
    The submit branch defaults to the parent, but can be overridden.  Both
4935
 
    submit branch and public branch will be remembered if supplied.
4936
 
 
4937
 
    If a public_branch is known for the submit_branch, that public submit
4938
 
    branch is used in the merge instructions.  This means that a local mirror
4939
 
    can be used as your actual submit branch, once you have set public_branch
4940
 
    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.
4941
5163
 
4942
5164
    Mail is sent using your preferred mail program.  This should be transparent
4943
5165
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
4945
5167
 
4946
5168
    To use a specific mail program, set the mail_client configuration option.
4947
5169
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4948
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
4949
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4950
 
    "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.
4951
5174
 
4952
5175
    If mail is being sent, a to address is required.  This can be supplied
4953
5176
    either on the commandline, by setting the submit_to configuration
4962
5185
 
4963
5186
    The merge directives created by bzr send may be applied using bzr merge or
4964
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.
4965
5192
    """
4966
5193
 
4967
5194
    encoding_type = 'exact'
4983
5210
               short_name='f',
4984
5211
               type=unicode),
4985
5212
        Option('output', short_name='o',
4986
 
               help='Write merge directive to this file; '
 
5213
               help='Write merge directive to this file or directory; '
4987
5214
                    'use - for stdout.',
4988
5215
               type=unicode),
4989
5216
        Option('strict',
5012
5239
 
5013
5240
 
5014
5241
class cmd_bundle_revisions(cmd_send):
5015
 
    """Create a merge-directive for submitting changes.
 
5242
    __doc__ = """Create a merge-directive for submitting changes.
5016
5243
 
5017
5244
    A merge directive provides many things needed for requesting merges:
5018
5245
 
5085
5312
 
5086
5313
 
5087
5314
class cmd_tag(Command):
5088
 
    """Create, remove or modify a tag naming a revision.
 
5315
    __doc__ = """Create, remove or modify a tag naming a revision.
5089
5316
 
5090
5317
    Tags give human-meaningful names to revisions.  Commands that take a -r
5091
5318
    (--revision) option can be given -rtag:X, where X is any previously
5099
5326
 
5100
5327
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5101
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.
5102
5334
    """
5103
5335
 
5104
5336
    _see_also = ['commit', 'tags']
5105
 
    takes_args = ['tag_name']
 
5337
    takes_args = ['tag_name?']
5106
5338
    takes_options = [
5107
5339
        Option('delete',
5108
5340
            help='Delete this tag rather than placing it.',
5118
5350
        'revision',
5119
5351
        ]
5120
5352
 
5121
 
    def run(self, tag_name,
 
5353
    def run(self, tag_name=None,
5122
5354
            delete=None,
5123
5355
            directory='.',
5124
5356
            force=None,
5126
5358
            ):
5127
5359
        branch, relpath = Branch.open_containing(directory)
5128
5360
        branch.lock_write()
5129
 
        try:
5130
 
            if delete:
5131
 
                branch.tags.delete_tag(tag_name)
5132
 
                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)
5133
5374
            else:
5134
 
                if revision:
5135
 
                    if len(revision) != 1:
5136
 
                        raise errors.BzrCommandError(
5137
 
                            "Tags can only be placed on a single revision, "
5138
 
                            "not on a range")
5139
 
                    revision_id = revision[0].as_revision_id(branch)
5140
 
                else:
5141
 
                    revision_id = branch.last_revision()
5142
 
                if (not force) and branch.tags.has_tag(tag_name):
5143
 
                    raise errors.TagAlreadyExists(tag_name)
5144
 
                branch.tags.set_tag(tag_name, revision_id)
5145
 
                self.outf.write('Created tag %s.\n' % tag_name)
5146
 
        finally:
5147
 
            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)
5148
5385
 
5149
5386
 
5150
5387
class cmd_tags(Command):
5151
 
    """List tags.
 
5388
    __doc__ = """List tags.
5152
5389
 
5153
5390
    This command shows a table of tag names and the revisions they reference.
5154
5391
    """
5183
5420
            return
5184
5421
 
5185
5422
        branch.lock_read()
5186
 
        try:
5187
 
            if revision:
5188
 
                graph = branch.repository.get_graph()
5189
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5190
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5191
 
                # only show revisions between revid1 and revid2 (inclusive)
5192
 
                tags = [(tag, revid) for tag, revid in tags if
5193
 
                    graph.is_between(revid, revid1, revid2)]
5194
 
            if sort == 'alpha':
5195
 
                tags.sort()
5196
 
            elif sort == 'time':
5197
 
                timestamps = {}
5198
 
                for tag, revid in tags:
5199
 
                    try:
5200
 
                        revobj = branch.repository.get_revision(revid)
5201
 
                    except errors.NoSuchRevision:
5202
 
                        timestamp = sys.maxint # place them at the end
5203
 
                    else:
5204
 
                        timestamp = revobj.timestamp
5205
 
                    timestamps[revid] = timestamp
5206
 
                tags.sort(key=lambda x: timestamps[x[1]])
5207
 
            if not show_ids:
5208
 
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5209
 
                for index, (tag, revid) in enumerate(tags):
5210
 
                    try:
5211
 
                        revno = branch.revision_id_to_dotted_revno(revid)
5212
 
                        if isinstance(revno, tuple):
5213
 
                            revno = '.'.join(map(str, revno))
5214
 
                    except errors.NoSuchRevision:
5215
 
                        # Bad tag data/merges can lead to tagged revisions
5216
 
                        # which are not in this branch. Fail gracefully ...
5217
 
                        revno = '?'
5218
 
                    tags[index] = (tag, revno)
5219
 
        finally:
5220
 
            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()
5221
5457
        for tag, revspec in tags:
5222
5458
            self.outf.write('%-20s %s\n' % (tag, revspec))
5223
5459
 
5224
5460
 
5225
5461
class cmd_reconfigure(Command):
5226
 
    """Reconfigure the type of a bzr directory.
 
5462
    __doc__ = """Reconfigure the type of a bzr directory.
5227
5463
 
5228
5464
    A target configuration must be specified.
5229
5465
 
5314
5550
 
5315
5551
 
5316
5552
class cmd_switch(Command):
5317
 
    """Set the branch of a checkout and update.
 
5553
    __doc__ = """Set the branch of a checkout and update.
5318
5554
 
5319
5555
    For lightweight checkouts, this changes the branch being referenced.
5320
5556
    For heavyweight checkouts, this checks that there are no local commits
5332
5568
    /path/to/newbranch.
5333
5569
 
5334
5570
    Bound branches use the nickname of its master branch unless it is set
5335
 
    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
5336
5572
    that of the master.
5337
5573
    """
5338
5574
 
5339
 
    takes_args = ['to_location']
 
5575
    takes_args = ['to_location?']
5340
5576
    takes_options = [Option('force',
5341
5577
                        help='Switch even if local commits will be lost.'),
 
5578
                     'revision',
5342
5579
                     Option('create-branch', short_name='b',
5343
5580
                        help='Create the target branch from this one before'
5344
5581
                             ' switching to it.'),
5345
 
                     ]
 
5582
                    ]
5346
5583
 
5347
 
    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):
5348
5586
        from bzrlib import switch
5349
5587
        tree_location = '.'
 
5588
        revision = _get_one_revision('switch', revision)
5350
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 = '.'
5351
5595
        try:
5352
5596
            branch = control_dir.open_branch()
5353
5597
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5358
5602
            if branch is None:
5359
5603
                raise errors.BzrCommandError('cannot create branch without'
5360
5604
                                             ' source branch')
 
5605
            to_location = directory_service.directories.dereference(
 
5606
                              to_location)
5361
5607
            if '/' not in to_location and '\\' not in to_location:
5362
5608
                # This path is meant to be relative to the existing branch
5363
5609
                this_url = self._get_branch_location(control_dir)
5365
5611
            to_branch = branch.bzrdir.sprout(to_location,
5366
5612
                                 possible_transports=[branch.bzrdir.root_transport],
5367
5613
                                 source_branch=branch).open_branch()
5368
 
            # try:
5369
 
            #     from_branch = control_dir.open_branch()
5370
 
            # except errors.NotBranchError:
5371
 
            #     raise BzrCommandError('Cannot create a branch from this'
5372
 
            #         ' location when we cannot open this branch')
5373
 
            # from_branch.bzrdir.sprout(
5374
 
            pass
5375
5614
        else:
5376
5615
            try:
5377
5616
                to_branch = Branch.open(to_location)
5379
5618
                this_url = self._get_branch_location(control_dir)
5380
5619
                to_branch = Branch.open(
5381
5620
                    urlutils.join(this_url, '..', to_location))
5382
 
        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)
5383
5624
        if had_explicit_nick:
5384
5625
            branch = control_dir.open_branch() #get the new branch!
5385
5626
            branch.nick = to_branch.nick
5405
5646
 
5406
5647
 
5407
5648
class cmd_view(Command):
5408
 
    """Manage filtered views.
 
5649
    __doc__ = """Manage filtered views.
5409
5650
 
5410
5651
    Views provide a mask over the tree so that users can focus on
5411
5652
    a subset of a tree when doing their work. After creating a view,
5559
5800
 
5560
5801
 
5561
5802
class cmd_hooks(Command):
5562
 
    """Show hooks."""
 
5803
    __doc__ = """Show hooks."""
5563
5804
 
5564
5805
    hidden = True
5565
5806
 
5578
5819
                    self.outf.write("    <no hooks installed>\n")
5579
5820
 
5580
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
 
5581
5847
class cmd_shelve(Command):
5582
 
    """Temporarily set aside some changes from the current tree.
 
5848
    __doc__ = """Temporarily set aside some changes from the current tree.
5583
5849
 
5584
5850
    Shelve allows you to temporarily put changes you've made "on the shelf",
5585
5851
    ie. out of the way, until a later time when you can bring them back from
5627
5893
        if writer is None:
5628
5894
            writer = bzrlib.option.diff_writer_registry.get()
5629
5895
        try:
5630
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5631
 
                              message, destroy=destroy).run()
 
5896
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5897
                file_list, message, destroy=destroy)
 
5898
            try:
 
5899
                shelver.run()
 
5900
            finally:
 
5901
                shelver.finalize()
5632
5902
        except errors.UserAbort:
5633
5903
            return 0
5634
5904
 
5635
5905
    def run_for_list(self):
5636
5906
        tree = WorkingTree.open_containing('.')[0]
5637
5907
        tree.lock_read()
5638
 
        try:
5639
 
            manager = tree.get_shelf_manager()
5640
 
            shelves = manager.active_shelves()
5641
 
            if len(shelves) == 0:
5642
 
                note('No shelved changes.')
5643
 
                return 0
5644
 
            for shelf_id in reversed(shelves):
5645
 
                message = manager.get_metadata(shelf_id).get('message')
5646
 
                if message is None:
5647
 
                    message = '<no message>'
5648
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5649
 
            return 1
5650
 
        finally:
5651
 
            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
5652
5920
 
5653
5921
 
5654
5922
class cmd_unshelve(Command):
5655
 
    """Restore shelved changes.
 
5923
    __doc__ = """Restore shelved changes.
5656
5924
 
5657
5925
    By default, the most recently shelved changes are restored. However if you
5658
5926
    specify a shelf by id those changes will be restored instead.  This works
5666
5934
            enum_switch=False, value_switches=True,
5667
5935
            apply="Apply changes and remove from the shelf.",
5668
5936
            dry_run="Show changes, but do not apply or remove them.",
5669
 
            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.",
5670
5941
        )
5671
5942
    ]
5672
5943
    _see_also = ['shelve']
5673
5944
 
5674
5945
    def run(self, shelf_id=None, action='apply'):
5675
5946
        from bzrlib.shelf_ui import Unshelver
5676
 
        Unshelver.from_args(shelf_id, action).run()
 
5947
        unshelver = Unshelver.from_args(shelf_id, action)
 
5948
        try:
 
5949
            unshelver.run()
 
5950
        finally:
 
5951
            unshelver.tree.unlock()
5677
5952
 
5678
5953
 
5679
5954
class cmd_clean_tree(Command):
5680
 
    """Remove unwanted files from working tree.
 
5955
    __doc__ = """Remove unwanted files from working tree.
5681
5956
 
5682
5957
    By default, only unknown files, not ignored files, are deleted.  Versioned
5683
5958
    files are never deleted.
5711
5986
 
5712
5987
 
5713
5988
class cmd_reference(Command):
5714
 
    """list, view and set branch locations for nested trees.
 
5989
    __doc__ = """list, view and set branch locations for nested trees.
5715
5990
 
5716
5991
    If no arguments are provided, lists the branch locations for nested trees.
5717
5992
    If one argument is provided, display the branch location for that tree.
5757
6032
            self.outf.write('%s %s\n' % (path, location))
5758
6033
 
5759
6034
 
5760
 
# these get imported and then picked up by the scan for cmd_*
5761
 
# TODO: Some more consistent way to split command definitions across files;
5762
 
# we do need to load at least some information about them to know of
5763
 
# aliases.  ideally we would avoid loading the implementation until the
5764
 
# details were needed.
5765
 
from bzrlib.cmd_version_info import cmd_version_info
5766
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5767
 
from bzrlib.bundle.commands import (
5768
 
    cmd_bundle_info,
5769
 
    )
5770
 
from bzrlib.foreign import cmd_dpush
5771
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5772
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5773
 
        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)