~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-07-27 06:28:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4587.
  • Revision ID: mbp@sourcefrog.net-20090727062835-o66p8it658tq1sma
Add CountedLock.get_physical_lock_status

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
34
 
    directory_service,
35
34
    delta,
36
35
    config,
37
36
    errors,
44
43
    reconfigure,
45
44
    rename_map,
46
45
    revision as _mod_revision,
47
 
    static_tuple,
48
46
    symbol_versioning,
49
 
    timestamp,
50
47
    transport,
51
48
    ui,
52
49
    urlutils,
54
51
    )
55
52
from bzrlib.branch import Branch
56
53
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
55
from bzrlib.smtp_connection import SMTPConnection
60
56
from bzrlib.workingtree import WorkingTree
61
57
""")
62
58
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
59
from bzrlib.commands import Command, display_command
68
60
from bzrlib.option import (
69
61
    ListOption,
70
62
    Option,
128
120
 
129
121
 
130
122
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
 
    """
140
123
    if branch is None:
141
124
        branch = tree.branch
142
125
    if revisions is None:
239
222
# opens the branch?)
240
223
 
241
224
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
225
    """Display status summary.
243
226
 
244
227
    This reports on versioned and unknown files, reporting them
245
228
    grouped by state.  Possible states are:
265
248
    unknown
266
249
        Not versioned and not matching an ignore pattern.
267
250
 
268
 
    Additionally for directories, symlinks and files with an executable
269
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
270
 
    or '*' respectively.
271
 
 
272
251
    To see ignored files use 'bzr ignored'.  For details on the
273
252
    changes to file texts, use 'bzr diff'.
274
253
 
332
311
 
333
312
 
334
313
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
 
314
    """Write out metadata for a revision.
336
315
 
337
316
    The revision to print can either be specified by a specific
338
317
    revision identifier, or you can use --revision.
344
323
    # cat-revision is more for frontends so should be exact
345
324
    encoding = 'strict'
346
325
 
347
 
    def print_revision(self, revisions, revid):
348
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
 
        record = stream.next()
350
 
        if record.storage_kind == 'absent':
351
 
            raise errors.NoSuchRevision(revisions, revid)
352
 
        revtext = record.get_bytes_as('fulltext')
353
 
        self.outf.write(revtext.decode('utf-8'))
354
 
 
355
326
    @display_command
356
327
    def run(self, revision_id=None, revision=None):
357
328
        if revision_id is not None and revision is not None:
362
333
                                         ' --revision or a revision_id')
363
334
        b = WorkingTree.open_containing(u'.')[0].branch
364
335
 
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')
 
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'))
369
352
 
370
 
        b.repository.lock_read()
371
 
        try:
372
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
373
 
            if revision_id is not None:
374
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
375
 
                try:
376
 
                    self.print_revision(revisions, revision_id)
377
 
                except errors.NoSuchRevision:
378
 
                    msg = "The repository %s contains no revision %s." % (
379
 
                        b.repository.base, revision_id)
380
 
                    raise errors.BzrCommandError(msg)
381
 
            elif revision is not None:
382
 
                for rev in revision:
383
 
                    if rev is None:
384
 
                        raise errors.BzrCommandError(
385
 
                            'You cannot specify a NULL revision.')
386
 
                    rev_id = rev.as_revision_id(b)
387
 
                    self.print_revision(revisions, rev_id)
388
 
        finally:
389
 
            b.repository.unlock()
390
 
        
391
353
 
392
354
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
355
    """Dump the contents of a btree index file to stdout.
394
356
 
395
357
    PATH is a btree index file, it can be any URL. This includes things like
396
358
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
422
        for node in bt.iter_all_entries():
461
423
            # Node is made up of:
462
424
            # (index, key, value, [references])
463
 
            try:
464
 
                refs = node[3]
465
 
            except IndexError:
466
 
                refs_as_tuples = None
467
 
            else:
468
 
                refs_as_tuples = static_tuple.as_tuples(refs)
469
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
 
            self.outf.write('%s\n' % (as_tuple,))
 
425
            self.outf.write('%s\n' % (node[1:],))
471
426
 
472
427
 
473
428
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
429
    """Remove the working tree from a given branch/checkout.
475
430
 
476
431
    Since a lightweight checkout is little more than a working tree
477
432
    this will refuse to run against one.
479
434
    To re-create the working tree, use "bzr checkout".
480
435
    """
481
436
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
437
    takes_args = ['location?']
483
438
    takes_options = [
484
439
        Option('force',
485
440
               help='Remove the working tree even if it has '
486
441
                    'uncommitted changes.'),
487
442
        ]
488
443
 
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()
 
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()
512
466
 
513
467
 
514
468
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
469
    """Show current revision number.
516
470
 
517
471
    This is equal to the number of revisions on this branch.
518
472
    """
531
485
                wt.lock_read()
532
486
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
487
                raise errors.NoWorkingTree(location)
534
 
            self.add_cleanup(wt.unlock)
535
 
            revid = wt.last_revision()
536
488
            try:
537
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
538
 
            except errors.NoSuchRevision:
539
 
                revno_t = ('???',)
540
 
            revno = ".".join(str(n) for n in revno_t)
 
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()
541
497
        else:
542
498
            b = Branch.open_containing(location)[0]
543
499
            b.lock_read()
544
 
            self.add_cleanup(b.unlock)
545
 
            revno = b.revno()
546
 
        self.cleanup_now()
 
500
            try:
 
501
                revno = b.revno()
 
502
            finally:
 
503
                b.unlock()
 
504
 
547
505
        self.outf.write(str(revno) + '\n')
548
506
 
549
507
 
550
508
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
509
    """Show revision number and revision id for a given revision identifier.
552
510
    """
553
511
    hidden = True
554
512
    takes_args = ['revision_info*']
571
529
            wt = WorkingTree.open_containing(directory)[0]
572
530
            b = wt.branch
573
531
            wt.lock_read()
574
 
            self.add_cleanup(wt.unlock)
575
532
        except (errors.NoWorkingTree, errors.NotLocalUrl):
576
533
            wt = None
577
534
            b = Branch.open_containing(directory)[0]
578
535
            b.lock_read()
579
 
            self.add_cleanup(b.unlock)
580
 
        revision_ids = []
581
 
        if revision is not None:
582
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
583
 
        if revision_info_list is not None:
584
 
            for rev_str in revision_info_list:
585
 
                rev_spec = RevisionSpec.from_string(rev_str)
586
 
                revision_ids.append(rev_spec.as_revision_id(b))
587
 
        # No arguments supplied, default to the last revision
588
 
        if len(revision_ids) == 0:
589
 
            if tree:
590
 
                if wt is None:
591
 
                    raise errors.NoWorkingTree(directory)
592
 
                revision_ids.append(wt.last_revision())
 
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()
593
566
            else:
594
 
                revision_ids.append(b.last_revision())
595
 
 
596
 
        revinfos = []
597
 
        maxlen = 0
598
 
        for revision_id in revision_ids:
599
 
            try:
600
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
601
 
                revno = '.'.join(str(i) for i in dotted_revno)
602
 
            except errors.NoSuchRevision:
603
 
                revno = '???'
604
 
            maxlen = max(maxlen, len(revno))
605
 
            revinfos.append([revno, revision_id])
606
 
 
607
 
        self.cleanup_now()
 
567
                wt.unlock()
 
568
 
608
569
        for ri in revinfos:
609
570
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
610
571
 
611
572
 
612
573
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
574
    """Add specified files or directories.
614
575
 
615
576
    In non-recursive mode, all the named items are added, regardless
616
577
    of whether they were previously ignored.  A warning is given if
642
603
    branches that will be merged later (without showing the two different
643
604
    adds as a conflict). It is also useful when merging another project
644
605
    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.
648
606
    """
649
607
    takes_args = ['file*']
650
608
    takes_options = [
658
616
               help='Lookup file ids from this tree.'),
659
617
        ]
660
618
    encoding_type = 'replace'
661
 
    _see_also = ['remove', 'ignore']
 
619
    _see_also = ['remove']
662
620
 
663
621
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
664
622
            file_ids_from=None):
682
640
 
683
641
        if base_tree:
684
642
            base_tree.lock_read()
685
 
            self.add_cleanup(base_tree.unlock)
686
 
        tree, file_list = tree_files_for_add(file_list)
687
 
        added, ignored = tree.smart_add(file_list, not
688
 
            no_recurse, action=action, save=not dry_run)
689
 
        self.cleanup_now()
 
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()
690
651
        if len(ignored) > 0:
691
652
            if verbose:
692
653
                for glob in sorted(ignored.keys()):
693
654
                    for path in ignored[glob]:
694
655
                        self.outf.write("ignored %s matching \"%s\"\n"
695
656
                                        % (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")
696
665
 
697
666
 
698
667
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
668
    """Create a new versioned directory.
700
669
 
701
670
    This is equivalent to creating the directory and then adding it.
702
671
    """
706
675
 
707
676
    def run(self, dir_list):
708
677
        for d in dir_list:
 
678
            os.mkdir(d)
709
679
            wt, dd = WorkingTree.open_containing(d)
710
 
            base = os.path.dirname(dd)
711
 
            id = wt.path2id(base)
712
 
            if id != None:
713
 
                os.mkdir(d)
714
 
                wt.add([dd])
715
 
                self.outf.write('added %s\n' % d)
716
 
            else:
717
 
                raise errors.NotVersionedError(path=base)
 
680
            wt.add([dd])
 
681
            self.outf.write('added %s\n' % d)
718
682
 
719
683
 
720
684
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
685
    """Show path of a file relative to root"""
722
686
 
723
687
    takes_args = ['filename']
724
688
    hidden = True
733
697
 
734
698
 
735
699
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
700
    """Show inventory of the current working copy or a revision.
737
701
 
738
702
    It is possible to limit the output to a particular entry
739
703
    type using the --kind option.  For example: --kind file.
761
725
        revision = _get_one_revision('inventory', revision)
762
726
        work_tree, file_list = tree_files(file_list)
763
727
        work_tree.lock_read()
764
 
        self.add_cleanup(work_tree.unlock)
765
 
        if revision is not None:
766
 
            tree = revision.as_tree(work_tree.branch)
767
 
 
768
 
            extra_trees = [work_tree]
769
 
            tree.lock_read()
770
 
            self.add_cleanup(tree.unlock)
771
 
        else:
772
 
            tree = work_tree
773
 
            extra_trees = []
774
 
 
775
 
        if file_list is not None:
776
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
777
 
                                      require_versioned=True)
778
 
            # find_ids_across_trees may include some paths that don't
779
 
            # exist in 'tree'.
780
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
 
                             for file_id in file_ids if file_id in tree)
782
 
        else:
783
 
            entries = tree.inventory.entries()
784
 
 
785
 
        self.cleanup_now()
 
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
 
786
752
        for path, entry in entries:
787
753
            if kind and kind != entry.kind:
788
754
                continue
794
760
 
795
761
 
796
762
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
763
    """Move or rename a file.
798
764
 
799
765
    :Usage:
800
766
        bzr mv OLDNAME NEWNAME
834
800
            raise errors.BzrCommandError("missing file argument")
835
801
        tree, rel_names = tree_files(names_list, canonicalize=False)
836
802
        tree.lock_tree_write()
837
 
        self.add_cleanup(tree.unlock)
838
 
        self._run(tree, names_list, rel_names, after)
 
803
        try:
 
804
            self._run(tree, names_list, rel_names, after)
 
805
        finally:
 
806
            tree.unlock()
839
807
 
840
808
    def run_auto(self, names_list, after, dry_run):
841
809
        if names_list is not None and len(names_list) > 1:
846
814
                                         ' --auto.')
847
815
        work_tree, file_list = tree_files(names_list, default_branch='.')
848
816
        work_tree.lock_tree_write()
849
 
        self.add_cleanup(work_tree.unlock)
850
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
817
        try:
 
818
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
819
        finally:
 
820
            work_tree.unlock()
851
821
 
852
822
    def _run(self, tree, names_list, rel_names, after):
853
823
        into_existing = osutils.isdir(names_list[-1])
874
844
            # All entries reference existing inventory items, so fix them up
875
845
            # for cicp file-systems.
876
846
            rel_names = tree.get_canonical_inventory_paths(rel_names)
877
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
878
 
                if not is_quiet():
879
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
847
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
848
                self.outf.write("%s => %s\n" % pair)
880
849
        else:
881
850
            if len(names_list) != 2:
882
851
                raise errors.BzrCommandError('to mv multiple files the'
926
895
            dest = osutils.pathjoin(dest_parent, dest_tail)
927
896
            mutter("attempting to move %s => %s", src, dest)
928
897
            tree.rename_one(src, dest, after=after)
929
 
            if not is_quiet():
930
 
                self.outf.write("%s => %s\n" % (src, dest))
 
898
            self.outf.write("%s => %s\n" % (src, dest))
931
899
 
932
900
 
933
901
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
902
    """Turn this branch into a mirror of another branch.
935
903
 
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.
 
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.
940
907
 
941
908
    If branches have diverged, you can use 'bzr merge' to integrate the changes
942
909
    from one into the other.  Once one branch has merged, the other should
943
910
    be able to pull it again.
944
911
 
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.
 
912
    If you want to forget your local changes and just update your branch to
 
913
    match the remote one, use pull --overwrite.
948
914
 
949
915
    If there is no default location set, the first pull will set it.  After
950
916
    that, you can omit the location to use the default.  To change the
986
952
        try:
987
953
            tree_to = WorkingTree.open_containing(directory)[0]
988
954
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
955
        except errors.NoWorkingTree:
992
956
            tree_to = None
993
957
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
996
 
 
 
958
        
997
959
        if local and not branch_to.get_bound_location():
998
960
            raise errors.LocalRequiresBoundBranch()
999
961
 
1029
991
        else:
1030
992
            branch_from = Branch.open(location,
1031
993
                possible_transports=possible_transports)
1032
 
            branch_from.lock_read()
1033
 
            self.add_cleanup(branch_from.unlock)
1034
994
 
1035
995
            if branch_to.get_parent() is None or remember:
1036
996
                branch_to.set_parent(branch_from.base)
1037
997
 
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)
 
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()
1058
1028
 
1059
1029
 
1060
1030
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
 
1031
    """Update a mirror of this branch.
1062
1032
 
1063
1033
    The target branch will not have its working tree populated because this
1064
1034
    is both expensive, and is not supported on remote file systems.
1125
1095
        # Get the source branch
1126
1096
        (tree, br_from,
1127
1097
         _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
1128
1101
        # Get the tip's revision_id
1129
1102
        revision = _get_one_revision('push', revision)
1130
1103
        if revision is not None:
1131
1104
            revision_id = revision.in_history(br_from).rev_id
1132
1105
        else:
1133
1106
            revision_id = None
1134
 
        if tree is not None and revision_id is None:
1135
 
            tree.check_changed_or_out_of_date(
1136
 
                strict, 'push_strict',
1137
 
                more_error='Use --no-strict to force the push.',
1138
 
                more_warning='Uncommitted changes will not be pushed.')
 
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
 
1139
1119
        # Get the stacked_on branch, if any
1140
1120
        if stacked_on is not None:
1141
1121
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1153
 
1174
1154
 
1175
1155
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1156
    """Create a new branch that is a copy of an existing branch.
1177
1157
 
1178
1158
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1159
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1192
1172
        help='Hard-link working tree files where possible.'),
1193
1173
        Option('no-tree',
1194
1174
            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."),
1198
1175
        Option('stacked',
1199
1176
            help='Create a stacked branch referring to the source branch. '
1200
1177
                'The new branch will depend on the availability of the source '
1206
1183
                    ' directory exists, but does not already'
1207
1184
                    ' have a control directory.  This flag will'
1208
1185
                    ' allow branch to proceed.'),
1209
 
        Option('bind',
1210
 
            help="Bind new branch to from location."),
1211
1186
        ]
1212
1187
    aliases = ['get', 'clone']
1213
1188
 
1214
1189
    def run(self, from_location, to_location=None, revision=None,
1215
1190
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
1217
 
        from bzrlib import switch as _mod_switch
 
1191
            use_existing_dir=False):
1218
1192
        from bzrlib.tag import _merge_tags_if_possible
 
1193
 
1219
1194
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
1195
            from_location)
 
1196
        if (accelerator_tree is not None and
 
1197
            accelerator_tree.supports_content_filtering()):
 
1198
            accelerator_tree = None
1221
1199
        revision = _get_one_revision('branch', revision)
1222
1200
        br_from.lock_read()
1223
 
        self.add_cleanup(br_from.unlock)
1224
 
        if revision is not None:
1225
 
            revision_id = revision.as_revision_id(br_from)
1226
 
        else:
1227
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1228
 
            # None or perhaps NULL_REVISION to mean copy nothing
1229
 
            # RBC 20060209
1230
 
            revision_id = br_from.last_revision()
1231
 
        if to_location is None:
1232
 
            to_location = urlutils.derive_to_location(from_location)
1233
 
        to_transport = transport.get_transport(to_location)
1234
1201
        try:
1235
 
            to_transport.mkdir('.')
1236
 
        except errors.FileExists:
1237
 
            if not use_existing_dir:
1238
 
                raise errors.BzrCommandError('Target directory "%s" '
1239
 
                    'already exists.' % to_location)
 
1202
            if revision is not None:
 
1203
                revision_id = revision.as_revision_id(br_from)
1240
1204
            else:
1241
 
                try:
1242
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1243
 
                except errors.NotBranchError:
1244
 
                    pass
 
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)
1245
1218
                else:
1246
 
                    raise errors.AlreadyBranchError(to_location)
1247
 
        except errors.NoSuchFile:
1248
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1249
 
                                         % to_location)
1250
 
        try:
1251
 
            # preserve whatever source format we have.
1252
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1253
 
                                        possible_transports=[to_transport],
1254
 
                                        accelerator_tree=accelerator_tree,
1255
 
                                        hardlink=hardlink, stacked=stacked,
1256
 
                                        force_new_repo=standalone,
1257
 
                                        create_tree_if_local=not no_tree,
1258
 
                                        source_branch=br_from)
1259
 
            branch = dir.open_branch()
1260
 
        except errors.NoSuchRevision:
1261
 
            to_transport.delete_tree('.')
1262
 
            msg = "The branch %s has no revision %s." % (from_location,
1263
 
                revision)
1264
 
            raise errors.BzrCommandError(msg)
1265
 
        _merge_tags_if_possible(br_from, branch)
1266
 
        # If the source branch is stacked, the new branch may
1267
 
        # be stacked whether we asked for that explicitly or not.
1268
 
        # We therefore need a try/except here and not just 'if stacked:'
1269
 
        try:
1270
 
            note('Created new stacked branch referring to %s.' %
1271
 
                branch.get_stacked_on_url())
1272
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1273
 
            errors.UnstackableRepositoryFormat), e:
1274
 
            note('Branched %d revision(s).' % branch.revno())
1275
 
        if bind:
1276
 
            # Bind to the parent
1277
 
            parent_branch = Branch.open(from_location)
1278
 
            branch.bind(parent_branch)
1279
 
            note('New branch bound to %s' % from_location)
1280
 
        if switch:
1281
 
            # Switch to the new branch
1282
 
            wt, _ = WorkingTree.open_containing('.')
1283
 
            _mod_switch.switch(wt.bzrdir, branch)
1284
 
            note('Switched to branch: %s',
1285
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
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()
1286
1255
 
1287
1256
 
1288
1257
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1258
    """Create a new checkout of an existing branch.
1290
1259
 
1291
1260
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1261
    the branch found in '.'. This is useful if you have removed the working tree
1355
1324
 
1356
1325
 
1357
1326
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1327
    """Show list of renamed files.
1359
1328
    """
1360
1329
    # TODO: Option to show renames between two historical versions.
1361
1330
 
1367
1336
    def run(self, dir=u'.'):
1368
1337
        tree = WorkingTree.open_containing(dir)[0]
1369
1338
        tree.lock_read()
1370
 
        self.add_cleanup(tree.unlock)
1371
 
        new_inv = tree.inventory
1372
 
        old_tree = tree.basis_tree()
1373
 
        old_tree.lock_read()
1374
 
        self.add_cleanup(old_tree.unlock)
1375
 
        old_inv = old_tree.inventory
1376
 
        renames = []
1377
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1378
 
        for f, paths, c, v, p, n, k, e in iterator:
1379
 
            if paths[0] == paths[1]:
1380
 
                continue
1381
 
            if None in (paths):
1382
 
                continue
1383
 
            renames.append(paths)
1384
 
        renames.sort()
1385
 
        for old_name, new_name in renames:
1386
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
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()
1387
1360
 
1388
1361
 
1389
1362
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1363
    """Update a tree to have the latest code committed to its branch.
1391
1364
 
1392
1365
    This will perform a merge into the working tree, and may generate
1393
1366
    conflicts. If you have any local changes, you will still
1395
1368
 
1396
1369
    If you want to discard your local changes, you can just do a
1397
1370
    'bzr revert' instead of 'bzr commit' after the update.
1398
 
 
1399
 
    If the tree's branch is bound to a master branch, it will also update
1400
 
    the branch from the master.
1401
1371
    """
1402
1372
 
1403
1373
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1374
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
1406
1375
    aliases = ['up']
1407
1376
 
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")
 
1377
    def run(self, dir='.'):
1412
1378
        tree = WorkingTree.open_containing(dir)[0]
1413
 
        branch = tree.branch
1414
1379
        possible_transports = []
1415
 
        master = branch.get_master_branch(
 
1380
        master = tree.branch.get_master_branch(
1416
1381
            possible_transports=possible_transports)
1417
1382
        if master is not None:
1418
1383
            tree.lock_write()
1419
 
            branch_location = master.base
1420
1384
        else:
1421
1385
            tree.lock_tree_write()
1422
 
            branch_location = tree.branch.base
1423
 
        self.add_cleanup(tree.unlock)
1424
 
        # get rid of the final '/' and be ready for display
1425
 
        branch_location = urlutils.unescape_for_display(
1426
 
            branch_location.rstrip('/'),
1427
 
            self.outf.encoding)
1428
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1429
 
        if master is None:
1430
 
            old_tip = None
1431
 
        else:
1432
 
            # may need to fetch data into a heavyweight checkout
1433
 
            # XXX: this may take some time, maybe we should display a
1434
 
            # message
1435
 
            old_tip = branch.update(possible_transports)
1436
 
        if revision is not None:
1437
 
            revision_id = revision[0].as_revision_id(branch)
1438
 
        else:
1439
 
            revision_id = branch.last_revision()
1440
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1442
 
            note("Tree is up to date at revision %s of branch %s" %
1443
 
                ('.'.join(map(str, revno)), branch_location))
1444
 
            return 0
1445
 
        view_info = _get_view_info_for_change_reporter(tree)
1446
 
        change_reporter = delta._ChangeReporter(
1447
 
            unversioned_filter=tree.is_ignored,
1448
 
            view_info=view_info)
1449
1386
        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)
1450
1398
            conflicts = tree.update(
1451
 
                change_reporter,
1452
 
                possible_transports=possible_transports,
1453
 
                revision=revision_id,
1454
 
                old_tip=old_tip)
1455
 
        except errors.NoSuchRevision, e:
1456
 
            raise errors.BzrCommandError(
1457
 
                                  "branch has no revision %s\n"
1458
 
                                  "bzr update --revision only works"
1459
 
                                  " for a revision in the branch history"
1460
 
                                  % (e.revision))
1461
 
        revno = tree.branch.revision_id_to_dotted_revno(
1462
 
            _mod_revision.ensure_null(tree.last_revision()))
1463
 
        note('Updated to revision %s of branch %s' %
1464
 
             ('.'.join(map(str, revno)), branch_location))
1465
 
        parent_ids = tree.get_parent_ids()
1466
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1467
 
            note('Your local commits will now show as pending merges with '
1468
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1469
 
        if conflicts != 0:
1470
 
            return 1
1471
 
        else:
1472
 
            return 0
 
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()
1473
1413
 
1474
1414
 
1475
1415
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1416
    """Show information about a working tree, branch or repository.
1477
1417
 
1478
1418
    This command will show all known locations and formats associated to the
1479
1419
    tree, branch or repository.
1517
1457
 
1518
1458
 
1519
1459
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1460
    """Remove files or directories.
1521
1461
 
1522
1462
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1463
    them if they can easily be recovered using revert. If no options or
1532
1472
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
1473
            safe='Only delete files if they can be'
1534
1474
                 ' safely recovered (default).',
1535
 
            keep='Delete from bzr but leave the working copy.',
 
1475
            keep="Don't delete any files.",
1536
1476
            force='Delete all the specified files, even if they can not be '
1537
1477
                'recovered and even if they are non-empty directories.')]
1538
1478
    aliases = ['rm', 'del']
1546
1486
            file_list = [f for f in file_list]
1547
1487
 
1548
1488
        tree.lock_write()
1549
 
        self.add_cleanup(tree.unlock)
1550
 
        # Heuristics should probably all move into tree.remove_smart or
1551
 
        # some such?
1552
 
        if new:
1553
 
            added = tree.changes_from(tree.basis_tree(),
1554
 
                specific_files=file_list).added
1555
 
            file_list = sorted([f[0] for f in added], reverse=True)
1556
 
            if len(file_list) == 0:
1557
 
                raise errors.BzrCommandError('No matching files.')
1558
 
        elif file_list is None:
1559
 
            # missing files show up in iter_changes(basis) as
1560
 
            # versioned-with-no-kind.
1561
 
            missing = []
1562
 
            for change in tree.iter_changes(tree.basis_tree()):
1563
 
                # Find paths in the working tree that have no kind:
1564
 
                if change[1][1] is not None and change[6][1] is None:
1565
 
                    missing.append(change[1][1])
1566
 
            file_list = sorted(missing, reverse=True)
1567
 
            file_deletion_strategy = 'keep'
1568
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
 
            keep_files=file_deletion_strategy=='keep',
1570
 
            force=file_deletion_strategy=='force')
 
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()
1571
1513
 
1572
1514
 
1573
1515
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1516
    """Print file_id of a particular file or directory.
1575
1517
 
1576
1518
    The file_id is assigned when the file is first added and remains the
1577
1519
    same through all revisions where the file exists, even when it is
1593
1535
 
1594
1536
 
1595
1537
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1538
    """Print path of file_ids to a file or directory.
1597
1539
 
1598
1540
    This prints one line for each directory down to the target,
1599
1541
    starting at the branch root.
1615
1557
 
1616
1558
 
1617
1559
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1560
    """Reconcile bzr metadata in a branch.
1619
1561
 
1620
1562
    This can correct data mismatches that may have been caused by
1621
1563
    previous ghost operations or bzr upgrades. You should only
1643
1585
 
1644
1586
 
1645
1587
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1588
    """Display the list of revision ids on a branch."""
1647
1589
 
1648
1590
    _see_also = ['log']
1649
1591
    takes_args = ['location?']
1659
1601
 
1660
1602
 
1661
1603
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1604
    """List all revisions merged into this branch."""
1663
1605
 
1664
1606
    _see_also = ['log', 'revision-history']
1665
1607
    takes_args = ['location?']
1684
1626
 
1685
1627
 
1686
1628
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1629
    """Make a directory into a versioned branch.
1688
1630
 
1689
1631
    Use this to create an empty branch, or before importing an
1690
1632
    existing project.
1718
1660
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1719
1661
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1720
1662
                value_switches=True,
1721
 
                title="Branch format",
 
1663
                title="Branch Format",
1722
1664
                ),
1723
1665
         Option('append-revisions-only',
1724
1666
                help='Never change revnos or the existing log.'
1793
1735
 
1794
1736
 
1795
1737
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1738
    """Create a shared repository to hold branches.
1797
1739
 
1798
1740
    New branches created under the repository directory will store their
1799
 
    revisions in the repository, not in the branch directory.  For branches
1800
 
    with shared history, this reduces the amount of storage needed and 
1801
 
    speeds up the creation of new branches.
 
1741
    revisions in the repository, not in the branch directory.
1802
1742
 
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.
 
1743
    If the --no-trees option is used then the branches in the repository
 
1744
    will not have working trees by default.
1809
1745
 
1810
1746
    :Examples:
1811
 
        Create a shared repository holding just branches::
 
1747
        Create a shared repositories holding just branches::
1812
1748
 
1813
1749
            bzr init-repo --no-trees repo
1814
1750
            bzr init repo/trunk
1853
1789
 
1854
1790
 
1855
1791
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1792
    """Show differences in the working tree, between revisions or branches.
1857
1793
 
1858
1794
    If no arguments are given, all changes for the current tree are listed.
1859
1795
    If files are given, only the changes in those files are listed.
1880
1816
 
1881
1817
            bzr diff -r1
1882
1818
 
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
 
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
1904
1826
 
1905
1827
        Show just the differences for file NEWS::
1906
1828
 
1945
1867
            help='Use this command to compare files.',
1946
1868
            type=unicode,
1947
1869
            ),
1948
 
        RegistryOption('format',
1949
 
            help='Diff format to use.',
1950
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
1952
1870
        ]
1953
1871
    aliases = ['di', 'dif']
1954
1872
    encoding_type = 'exact'
1955
1873
 
1956
1874
    @display_command
1957
1875
    def run(self, revision=None, file_list=None, diff_options=None,
1958
 
            prefix=None, old=None, new=None, using=None, format=None):
1959
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1960
 
            show_diff_trees)
 
1876
            prefix=None, old=None, new=None, using=None):
 
1877
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1961
1878
 
1962
1879
        if (prefix is None) or (prefix == '0'):
1963
1880
            # diff -p0 format
1977
1894
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1895
                                         ' one or two revision specifiers')
1979
1896
 
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)
 
1897
        old_tree, new_tree, specific_files, extra_trees = \
 
1898
                _get_trees_to_diff(file_list, revision, old, new,
 
1899
                apply_view=True)
1988
1900
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1989
1901
                               specific_files=specific_files,
1990
1902
                               external_diff_options=diff_options,
1991
1903
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
1993
 
                               format_cls=format)
 
1904
                               extra_trees=extra_trees, using=using)
1994
1905
 
1995
1906
 
1996
1907
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1908
    """List files deleted in the working tree.
1998
1909
    """
1999
1910
    # TODO: Show files deleted since a previous revision, or
2000
1911
    # between two revisions.
2009
1920
    def run(self, show_ids=False):
2010
1921
        tree = WorkingTree.open_containing(u'.')[0]
2011
1922
        tree.lock_read()
2012
 
        self.add_cleanup(tree.unlock)
2013
 
        old = tree.basis_tree()
2014
 
        old.lock_read()
2015
 
        self.add_cleanup(old.unlock)
2016
 
        for path, ie in old.inventory.iter_entries():
2017
 
            if not tree.has_id(ie.file_id):
2018
 
                self.outf.write(path)
2019
 
                if show_ids:
2020
 
                    self.outf.write(' ')
2021
 
                    self.outf.write(ie.file_id)
2022
 
                self.outf.write('\n')
 
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()
2023
1938
 
2024
1939
 
2025
1940
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
1941
    """List files modified in working tree.
2027
1942
    """
2028
1943
 
2029
1944
    hidden = True
2046
1961
 
2047
1962
 
2048
1963
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
1964
    """List files added in working tree.
2050
1965
    """
2051
1966
 
2052
1967
    hidden = True
2061
1976
    def run(self, null=False):
2062
1977
        wt = WorkingTree.open_containing(u'.')[0]
2063
1978
        wt.lock_read()
2064
 
        self.add_cleanup(wt.unlock)
2065
 
        basis = wt.basis_tree()
2066
 
        basis.lock_read()
2067
 
        self.add_cleanup(basis.unlock)
2068
 
        basis_inv = basis.inventory
2069
 
        inv = wt.inventory
2070
 
        for file_id in inv:
2071
 
            if file_id in basis_inv:
2072
 
                continue
2073
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2074
 
                continue
2075
 
            path = inv.id2path(file_id)
2076
 
            if not os.access(osutils.abspath(path), os.F_OK):
2077
 
                continue
2078
 
            if null:
2079
 
                self.outf.write(path + '\0')
2080
 
            else:
2081
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
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()
2082
2001
 
2083
2002
 
2084
2003
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
2004
    """Show the tree root directory.
2086
2005
 
2087
2006
    The root is the nearest enclosing directory with a .bzr control
2088
2007
    directory."""
2112
2031
 
2113
2032
 
2114
2033
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2034
    """Show historical log for a branch or subset of a branch.
2116
2035
 
2117
2036
    log is bzr's default tool for exploring the history of a branch.
2118
2037
    The branch to use is taken from the first parameter. If no parameters
2229
2148
    :Tips & tricks:
2230
2149
 
2231
2150
      GUI tools and IDEs are often better at exploring history than command
2232
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2233
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2234
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2235
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
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.
2236
2158
 
2237
2159
      You may find it useful to add the aliases below to ``bazaar.conf``::
2238
2160
 
2299
2221
                   help='Show changes made in each revision as a patch.'),
2300
2222
            Option('include-merges',
2301
2223
                   help='Show merged revisions like --levels 0 does.'),
2302
 
            Option('exclude-common-ancestry',
2303
 
                   help='Display only the revisions that are not part'
2304
 
                   ' of both ancestries (require -rX..Y)'
2305
 
                   )
2306
2224
            ]
2307
2225
    encoding_type = 'replace'
2308
2226
 
2318
2236
            message=None,
2319
2237
            limit=None,
2320
2238
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
 
2239
            include_merges=False):
2324
2240
        from bzrlib.log import (
2325
2241
            Logger,
2326
2242
            make_log_request_dict,
2327
2243
            _get_info_for_log_files,
2328
2244
            )
2329
2245
        direction = (forward and 'forward') or 'reverse'
2330
 
        if (exclude_common_ancestry
2331
 
            and (revision is None or len(revision) != 2)):
2332
 
            raise errors.BzrCommandError(
2333
 
                '--exclude-common-ancestry requires -r with two revisions')
2334
2246
        if include_merges:
2335
2247
            if levels is None:
2336
2248
                levels = 0
2351
2263
        filter_by_dir = False
2352
2264
        if file_list:
2353
2265
            # find the file ids to log and check for directory filtering
2354
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2355
 
                revision, file_list)
2356
 
            self.add_cleanup(b.unlock)
 
2266
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2267
                file_list)
2357
2268
            for relpath, file_id, kind in file_info_list:
2358
2269
                if file_id is None:
2359
2270
                    raise errors.BzrCommandError(
2377
2288
                location = '.'
2378
2289
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
2290
            b = dir.open_branch()
2380
 
            b.lock_read()
2381
 
            self.add_cleanup(b.unlock)
2382
2291
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
2292
 
2384
2293
        # Decide on the type of delta & diff filtering to use
2394
2303
        else:
2395
2304
            diff_type = 'full'
2396
2305
 
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)
 
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()
2436
2344
 
2437
2345
 
2438
2346
def _get_revision_range(revisionspec_list, branch, command_name):
2456
2364
            raise errors.BzrCommandError(
2457
2365
                "bzr %s doesn't accept two revisions in different"
2458
2366
                " branches." % command_name)
2459
 
        if start_spec.spec is None:
2460
 
            # Avoid loading all the history.
2461
 
            rev1 = RevisionInfo(branch, None, None)
2462
 
        else:
2463
 
            rev1 = start_spec.in_history(branch)
 
2367
        rev1 = start_spec.in_history(branch)
2464
2368
        # Avoid loading all of history when we know a missing
2465
2369
        # end of range means the last revision ...
2466
2370
        if end_spec.spec is None:
2495
2399
 
2496
2400
 
2497
2401
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2402
    """Return revision-ids which affected a particular file.
2499
2403
 
2500
2404
    A more user-friendly interface is "bzr log FILE".
2501
2405
    """
2506
2410
    @display_command
2507
2411
    def run(self, filename):
2508
2412
        tree, relpath = WorkingTree.open_containing(filename)
 
2413
        b = tree.branch
2509
2414
        file_id = tree.path2id(relpath)
2510
 
        b = tree.branch
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:
 
2415
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2515
2416
            self.outf.write("%6d %s\n" % (revno, what))
2516
2417
 
2517
2418
 
2518
2419
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2420
    """List files in a tree.
2520
2421
    """
2521
2422
 
2522
2423
    _see_also = ['status', 'cat']
2570
2471
        if from_root:
2571
2472
            if relpath:
2572
2473
                prefix = relpath + '/'
2573
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2474
        elif fs_path != '.':
2574
2475
            prefix = fs_path + '/'
2575
2476
 
2576
2477
        if revision is not None or tree is None:
2585
2486
                note("Ignoring files outside view. View is %s" % view_str)
2586
2487
 
2587
2488
        tree.lock_read()
2588
 
        self.add_cleanup(tree.unlock)
2589
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2590
 
            from_dir=relpath, recursive=recursive):
2591
 
            # Apply additional masking
2592
 
            if not all and not selection[fc]:
2593
 
                continue
2594
 
            if kind is not None and fkind != kind:
2595
 
                continue
2596
 
            if apply_view:
2597
 
                try:
2598
 
                    if relpath:
2599
 
                        fullpath = osutils.pathjoin(relpath, fp)
2600
 
                    else:
2601
 
                        fullpath = fp
2602
 
                    views.check_path_in_view(tree, fullpath)
2603
 
                except errors.FileOutsideView:
2604
 
                    continue
 
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
2605
2506
 
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:
 
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)
2632
2517
                    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()
2633
2536
 
2634
2537
 
2635
2538
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2539
    """List unknown files.
2637
2540
    """
2638
2541
 
2639
2542
    hidden = True
2646
2549
 
2647
2550
 
2648
2551
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2552
    """Ignore specified files or patterns.
2650
2553
 
2651
2554
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2555
 
2653
 
    If a .bzrignore file does not exist, the ignore command
2654
 
    will create one and add the specified files or patterns to the newly
2655
 
    created file. The ignore command will also automatically add the 
2656
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2657
 
    the use of the ignore command will require an explicit add command.
2658
 
 
2659
2556
    To remove patterns from the ignore list, edit the .bzrignore file.
2660
2557
    After adding, editing or deleting that file either indirectly by
2661
2558
    using this command or directly by using an editor, be sure to commit
2662
2559
    it.
2663
 
    
2664
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2665
 
    the global ignore file can be found in the application data directory as
2666
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2667
 
    Global ignores are not touched by this command. The global ignore file
2668
 
    can be edited directly using an editor.
2669
 
 
2670
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
 
    precedence over regular ignores.  Such exceptions are used to specify
2672
 
    files that should be versioned which would otherwise be ignored.
2673
 
    
2674
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
 
    precedence over the '!' exception patterns.
2676
2560
 
2677
2561
    Note: ignore patterns containing shell wildcards must be quoted from
2678
2562
    the shell on Unix.
2682
2566
 
2683
2567
            bzr ignore ./Makefile
2684
2568
 
2685
 
        Ignore .class files in all directories...::
 
2569
        Ignore class files in all directories::
2686
2570
 
2687
2571
            bzr ignore "*.class"
2688
2572
 
2689
 
        ...but do not ignore "special.class"::
2690
 
 
2691
 
            bzr ignore "!special.class"
2692
 
 
2693
2573
        Ignore .o files under the lib directory::
2694
2574
 
2695
2575
            bzr ignore "lib/**/*.o"
2701
2581
        Ignore everything but the "debian" toplevel directory::
2702
2582
 
2703
2583
            bzr ignore "RE:(?!debian/).*"
2704
 
        
2705
 
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
2707
 
        
2708
 
            bzr ignore "*"
2709
 
            bzr ignore "!./local"
2710
 
            bzr ignore "!!*~"
2711
2584
    """
2712
2585
 
2713
2586
    _see_also = ['status', 'ignored', 'patterns']
2714
2587
    takes_args = ['name_pattern*']
2715
2588
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2589
        Option('old-default-rules',
 
2590
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2591
        ]
2719
2592
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2593
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2594
        from bzrlib import ignores
2722
 
        if default_rules is not None:
2723
 
            # dump the default rules and exit
2724
 
            for pattern in ignores.USER_DEFAULTS:
2725
 
                self.outf.write("%s\n" % pattern)
 
2595
        if old_default_rules is not None:
 
2596
            # dump the rules and exit
 
2597
            for pattern in ignores.OLD_DEFAULTS:
 
2598
                print pattern
2726
2599
            return
2727
2600
        if not name_pattern_list:
2728
2601
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
 
2602
                                  "NAME_PATTERN or --old-default-rules")
2730
2603
        name_pattern_list = [globbing.normalize_pattern(p)
2731
2604
                             for p in name_pattern_list]
2732
2605
        for name_pattern in name_pattern_list:
2744
2617
            if id is not None:
2745
2618
                filename = entry[0]
2746
2619
                if ignored.match(filename):
2747
 
                    matches.append(filename)
 
2620
                    matches.append(filename.encode('utf-8'))
2748
2621
        tree.unlock()
2749
2622
        if len(matches) > 0:
2750
 
            self.outf.write("Warning: the following files are version controlled and"
2751
 
                  " match your ignore pattern:\n%s"
2752
 
                  "\nThese files will continue to be version controlled"
2753
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
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),)
2754
2627
 
2755
2628
 
2756
2629
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2630
    """List ignored files and the patterns that matched them.
2758
2631
 
2759
2632
    List all the ignored files and the ignore pattern that caused the file to
2760
2633
    be ignored.
2771
2644
    def run(self):
2772
2645
        tree = WorkingTree.open_containing(u'.')[0]
2773
2646
        tree.lock_read()
2774
 
        self.add_cleanup(tree.unlock)
2775
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2776
 
            if file_class != 'I':
2777
 
                continue
2778
 
            ## XXX: Slightly inefficient since this was already calculated
2779
 
            pat = tree.is_ignored(path)
2780
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
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()
2781
2656
 
2782
2657
 
2783
2658
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2659
    """Lookup the revision-id from a revision-number
2785
2660
 
2786
2661
    :Examples:
2787
2662
        bzr lookup-revision 33
2794
2669
        try:
2795
2670
            revno = int(revno)
2796
2671
        except ValueError:
2797
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
 
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2800
 
        self.outf.write("%s\n" % revid)
 
2672
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2673
 
 
2674
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2801
2675
 
2802
2676
 
2803
2677
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2678
    """Export current or past revision to a destination directory or archive.
2805
2679
 
2806
2680
    If no revision is specified this exports the last committed revision.
2807
2681
 
2839
2713
        Option('root',
2840
2714
               type=str,
2841
2715
               help="Name of the root directory inside the exported file."),
2842
 
        Option('per-file-timestamps',
2843
 
               help='Set modification time of files to that of the last '
2844
 
                    'revision in which it was changed.'),
2845
2716
        ]
2846
2717
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2718
        root=None, filters=False):
2848
2719
        from bzrlib.export import export
2849
2720
 
2850
2721
        if branch_or_subdir is None:
2857
2728
 
2858
2729
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2859
2730
        try:
2860
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2861
 
                   per_file_timestamps=per_file_timestamps)
 
2731
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2862
2732
        except errors.NoSuchExportFormat, e:
2863
2733
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2864
2734
 
2865
2735
 
2866
2736
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2737
    """Write the contents of a file as of a given revision to standard output.
2868
2738
 
2869
2739
    If no revision is nominated, the last revision is used.
2870
2740
 
2891
2761
        tree, branch, relpath = \
2892
2762
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
2763
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
2895
 
        return self._run(tree, branch, relpath, filename, revision,
2896
 
                         name_from_revision, filters)
 
2764
        try:
 
2765
            return self._run(tree, branch, relpath, filename, revision,
 
2766
                             name_from_revision, filters)
 
2767
        finally:
 
2768
            branch.unlock()
2897
2769
 
2898
2770
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2899
2771
        filtered):
2900
2772
        if tree is None:
2901
2773
            tree = b.basis_tree()
2902
2774
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
2905
2775
 
2906
2776
        old_file_id = rev_tree.path2id(relpath)
2907
2777
 
2942
2812
            chunks = content.splitlines(True)
2943
2813
            content = filtered_output_bytes(chunks, filters,
2944
2814
                ContentFilterContext(relpath, rev_tree))
2945
 
            self.cleanup_now()
2946
2815
            self.outf.writelines(content)
2947
2816
        else:
2948
 
            self.cleanup_now()
2949
2817
            self.outf.write(content)
2950
2818
 
2951
2819
 
2952
2820
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2821
    """Show the offset in seconds from GMT to local time."""
2954
2822
    hidden = True
2955
2823
    @display_command
2956
2824
    def run(self):
2957
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2825
        print osutils.local_time_offset()
2958
2826
 
2959
2827
 
2960
2828
 
2961
2829
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
 
2830
    """Commit changes into a new revision.
2963
2831
 
2964
2832
    An explanatory message needs to be given for each commit. This is
2965
2833
    often done by using the --message option (getting the message from the
3058
2926
             Option('strict',
3059
2927
                    help="Refuse to commit if there are unknown "
3060
2928
                    "files in the working tree."),
3061
 
             Option('commit-time', type=str,
3062
 
                    help="Manually set a commit time using commit date "
3063
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3064
2929
             ListOption('fixes', type=str,
3065
2930
                    help="Mark a bug as being fixed by this revision "
3066
2931
                         "(see \"bzr help bugs\")."),
3073
2938
                         "the master branch until a normal commit "
3074
2939
                         "is performed."
3075
2940
                    ),
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.'),
 
2941
              Option('show-diff',
 
2942
                     help='When no message is supplied, show the diff along'
 
2943
                     ' with the status summary in the message editor.'),
3079
2944
             ]
3080
2945
    aliases = ['ci', 'checkin']
3081
2946
 
3100
2965
 
3101
2966
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
2967
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2968
            author=None, show_diff=False, exclude=None):
3104
2969
        from bzrlib.errors import (
3105
2970
            PointlessCommit,
3106
2971
            ConflictsInTree,
3112
2977
            make_commit_message_template_encoded
3113
2978
        )
3114
2979
 
3115
 
        commit_stamp = offset = None
3116
 
        if commit_time is not None:
3117
 
            try:
3118
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3119
 
            except ValueError, e:
3120
 
                raise errors.BzrCommandError(
3121
 
                    "Could not parse --commit-time: " + str(e))
3122
 
 
3123
2980
        # TODO: Need a blackbox test for invoking the external editor; may be
3124
2981
        # slightly problematic to run this cross-platform.
3125
2982
 
3145
3002
        if local and not tree.branch.get_bound_location():
3146
3003
            raise errors.LocalRequiresBoundBranch()
3147
3004
 
3148
 
        if message is not None:
3149
 
            try:
3150
 
                file_exists = osutils.lexists(message)
3151
 
            except UnicodeError:
3152
 
                # The commit message contains unicode characters that can't be
3153
 
                # represented in the filesystem encoding, so that can't be a
3154
 
                # file.
3155
 
                file_exists = False
3156
 
            if file_exists:
3157
 
                warning_msg = (
3158
 
                    'The commit message is a file name: "%(f)s".\n'
3159
 
                    '(use --file "%(f)s" to take commit message from that file)'
3160
 
                    % { 'f': message })
3161
 
                ui.ui_factory.show_warning(warning_msg)
3162
 
            if '\r' in message:
3163
 
                message = message.replace('\r\n', '\n')
3164
 
                message = message.replace('\r', '\n')
3165
 
            if file:
3166
 
                raise errors.BzrCommandError(
3167
 
                    "please specify either --message or --file")
3168
 
 
3169
3005
        def get_message(commit_obj):
3170
3006
            """Callback to get commit message"""
3171
 
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
3174
 
            elif message is not None:
3175
 
                my_message = message
3176
 
            else:
3177
 
                # No message supplied: make one up.
3178
 
                # text is the status of the tree
3179
 
                text = make_commit_message_template_encoded(tree,
 
3007
            my_message = message
 
3008
            if my_message is None and not file:
 
3009
                t = make_commit_message_template_encoded(tree,
3180
3010
                        selected_list, diff=show_diff,
3181
3011
                        output_encoding=osutils.get_user_encoding())
3182
 
                # start_message is the template generated from hooks
3183
 
                # XXX: Warning - looks like hooks return unicode,
3184
 
                # make_commit_message_template_encoded returns user encoding.
3185
 
                # We probably want to be using edit_commit_message instead to
3186
 
                # avoid this.
3187
3012
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
 
3013
                my_message = edit_commit_message_encoded(t,
3189
3014
                    start_message=start_message)
3190
3015
                if my_message is None:
3191
3016
                    raise errors.BzrCommandError("please specify a commit"
3192
3017
                        " 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()
3193
3024
            if my_message == "":
3194
3025
                raise errors.BzrCommandError("empty commit message specified")
3195
3026
            return my_message
3196
3027
 
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
3201
3028
        try:
3202
3029
            tree.commit(message_callback=get_message,
3203
3030
                        specific_files=selected_list,
3204
3031
                        allow_pointless=unchanged, strict=strict, local=local,
3205
3032
                        reporter=None, verbose=verbose, revprops=properties,
3206
 
                        authors=author, timestamp=commit_stamp,
3207
 
                        timezone=offset,
 
3033
                        authors=author,
3208
3034
                        exclude=safe_relpath_files(tree, exclude))
3209
3035
        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
3210
3038
            raise errors.BzrCommandError("No changes to commit."
3211
3039
                              " Use --unchanged to commit anyhow.")
3212
3040
        except ConflictsInTree:
3217
3045
            raise errors.BzrCommandError("Commit refused because there are"
3218
3046
                              " unknown files in the working tree.")
3219
3047
        except errors.BoundBranchOutOfDate, e:
3220
 
            e.extra_help = ("\n"
3221
 
                'To commit to master branch, run update and then commit.\n'
3222
 
                'You can also pass --local to commit to continue working '
3223
 
                'disconnected.')
3224
 
            raise
 
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.')
3225
3052
 
3226
3053
 
3227
3054
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3055
    """Validate working tree structure, branch consistency and repository history.
3229
3056
 
3230
3057
    This command checks various invariants about branch and repository storage
3231
3058
    to detect data corruption or bzr bugs.
3295
3122
 
3296
3123
 
3297
3124
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
3125
    """Upgrade branch storage to current format.
3299
3126
 
3300
3127
    The check command or bzr developers may sometimes advise you to run
3301
3128
    this command. When the default format has changed you may also be warned
3319
3146
 
3320
3147
 
3321
3148
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
 
3149
    """Show or set bzr user id.
3323
3150
 
3324
3151
    :Examples:
3325
3152
        Show the email of the current user::
3369
3196
 
3370
3197
 
3371
3198
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
3199
    """Print or set the branch nickname.
3373
3200
 
3374
3201
    If unset, the tree root directory name is used as the nickname.
3375
3202
    To print the current nickname, execute with no argument.
3389
3216
 
3390
3217
    @display_command
3391
3218
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
3219
        print branch.nick
3393
3220
 
3394
3221
 
3395
3222
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
3223
    """Set/unset and display aliases.
3397
3224
 
3398
3225
    :Examples:
3399
3226
        Show the current aliases::
3463
3290
 
3464
3291
 
3465
3292
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
 
3293
    """Run internal test suite.
3467
3294
 
3468
3295
    If arguments are given, they are regular expressions that say which tests
3469
3296
    should run.  Tests matching any expression are run, and other tests are
3496
3323
    Tests that need working space on disk use a common temporary directory,
3497
3324
    typically inside $TMPDIR or /tmp.
3498
3325
 
3499
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
 
    into a pdb postmortem session.
3501
 
 
3502
3326
    :Examples:
3503
3327
        Run only tests relating to 'ignore'::
3504
3328
 
3513
3337
    def get_transport_type(typestring):
3514
3338
        """Parse and return a transport specifier."""
3515
3339
        if typestring == "sftp":
3516
 
            from bzrlib.tests import stub_sftp
3517
 
            return stub_sftp.SFTPAbsoluteServer
 
3340
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3341
            return SFTPAbsoluteServer
3518
3342
        if typestring == "memory":
3519
 
            from bzrlib.tests import test_server
3520
 
            return memory.MemoryServer
 
3343
            from bzrlib.transport.memory import MemoryServer
 
3344
            return MemoryServer
3521
3345
        if typestring == "fakenfs":
3522
 
            from bzrlib.tests import test_server
3523
 
            return test_server.FakeNFSServer
 
3346
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3347
            return FakeNFSServer
3524
3348
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
3349
            (typestring)
3526
3350
        raise errors.BzrCommandError(msg)
3541
3365
                     Option('lsprof-timed',
3542
3366
                            help='Generate lsprof output for benchmarked'
3543
3367
                                 ' sections of code.'),
3544
 
                     Option('lsprof-tests',
3545
 
                            help='Generate lsprof output for each test.'),
3546
3368
                     Option('cache-dir', type=str,
3547
3369
                            help='Cache intermediate benchmark output in this '
3548
3370
                                 'directory.'),
3589
3411
            first=False, list_only=False,
3590
3412
            randomize=None, exclude=None, strict=False,
3591
3413
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
 
            parallel=None, lsprof_tests=False):
 
3414
            parallel=None):
3593
3415
        from bzrlib.tests import selftest
3594
3416
        import bzrlib.benchmarks as benchmarks
3595
3417
        from bzrlib.benchmarks import tree_creator
3610
3432
                raise errors.BzrCommandError("subunit not available. subunit "
3611
3433
                    "needs to be installed to use --subunit.")
3612
3434
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
 
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3616
 
                import msvcrt
3617
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
3435
        if parallel:
3619
3436
            self.additional_selftest_args.setdefault(
3620
3437
                'suite_decorators', []).append(parallel)
3624
3441
            verbose = not is_quiet()
3625
3442
            # TODO: should possibly lock the history file...
3626
3443
            benchfile = open(".perf_history", "at", buffering=1)
3627
 
            self.add_cleanup(benchfile.close)
3628
3444
        else:
3629
3445
            test_suite_factory = None
3630
3446
            benchfile = None
3631
 
        selftest_kwargs = {"verbose": verbose,
3632
 
                          "pattern": pattern,
3633
 
                          "stop_on_failure": one,
3634
 
                          "transport": transport,
3635
 
                          "test_suite_factory": test_suite_factory,
3636
 
                          "lsprof_timed": lsprof_timed,
3637
 
                          "lsprof_tests": lsprof_tests,
3638
 
                          "bench_history": benchfile,
3639
 
                          "matching_tests_first": first,
3640
 
                          "list_only": list_only,
3641
 
                          "random_seed": randomize,
3642
 
                          "exclude_pattern": exclude,
3643
 
                          "strict": strict,
3644
 
                          "load_list": load_list,
3645
 
                          "debug_flags": debugflag,
3646
 
                          "starting_with": starting_with
3647
 
                          }
3648
 
        selftest_kwargs.update(self.additional_selftest_args)
3649
 
        result = selftest(**selftest_kwargs)
 
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()
3650
3469
        return int(not result)
3651
3470
 
3652
3471
 
3653
3472
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3473
    """Show version of bzr."""
3655
3474
 
3656
3475
    encoding_type = 'replace'
3657
3476
    takes_options = [
3668
3487
 
3669
3488
 
3670
3489
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3490
    """Statement of optimism."""
3672
3491
 
3673
3492
    hidden = True
3674
3493
 
3675
3494
    @display_command
3676
3495
    def run(self):
3677
 
        self.outf.write("It sure does!\n")
 
3496
        print "It sure does!"
3678
3497
 
3679
3498
 
3680
3499
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3500
    """Find and print a base revision for merging two branches."""
3682
3501
    # TODO: Options to specify revisions on either side, as if
3683
3502
    #       merging only part of the history.
3684
3503
    takes_args = ['branch', 'other']
3691
3510
        branch1 = Branch.open_containing(branch)[0]
3692
3511
        branch2 = Branch.open_containing(other)[0]
3693
3512
        branch1.lock_read()
3694
 
        self.add_cleanup(branch1.unlock)
3695
 
        branch2.lock_read()
3696
 
        self.add_cleanup(branch2.unlock)
3697
 
        last1 = ensure_null(branch1.last_revision())
3698
 
        last2 = ensure_null(branch2.last_revision())
3699
 
 
3700
 
        graph = branch1.repository.get_graph(branch2.repository)
3701
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3702
 
 
3703
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
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()
3704
3527
 
3705
3528
 
3706
3529
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
 
3530
    """Perform a three-way merge.
3708
3531
 
3709
3532
    The source of the merge can be specified either in the form of a branch,
3710
3533
    or in the form of a path to a file containing a merge directive generated
3739
3562
    committed to record the result of the merge.
3740
3563
 
3741
3564
    merge refuses to run if there are any uncommitted changes, unless
3742
 
    --force is given. The --force option can also be used to create a
3743
 
    merge revision which has more than two parents.
3744
 
 
3745
 
    If one would like to merge changes from the working tree of the other
3746
 
    branch without merging any committed revisions, the --uncommitted option
3747
 
    can be given.
 
3565
    --force is given.
3748
3566
 
3749
3567
    To select only some changes to merge, use "merge -i", which will prompt
3750
3568
    you to apply each diff hunk and file change, similar to "shelve".
3762
3580
 
3763
3581
            bzr merge -r 81..82 ../bzr.dev
3764
3582
 
3765
 
        To apply a merge directive contained in /tmp/merge::
 
3583
        To apply a merge directive contained in /tmp/merge:
3766
3584
 
3767
3585
            bzr merge /tmp/merge
3768
 
 
3769
 
        To create a merge revision with three parents from two branches
3770
 
        feature1a and feature1b:
3771
 
 
3772
 
            bzr merge ../feature1a
3773
 
            bzr merge ../feature1b --force
3774
 
            bzr commit -m 'revision with three parents'
3775
3586
    """
3776
3587
 
3777
3588
    encoding_type = 'exact'
3822
3633
        verified = 'inapplicable'
3823
3634
        tree = WorkingTree.open_containing(directory)[0]
3824
3635
 
 
3636
        # die as quickly as possible if there are uncommitted changes
3825
3637
        try:
3826
3638
            basis_tree = tree.revision_tree(tree.last_revision())
3827
3639
        except errors.NoSuchRevision:
3828
3640
            basis_tree = tree.basis_tree()
3829
 
 
3830
 
        # die as quickly as possible if there are uncommitted changes
3831
3641
        if not force:
3832
 
            if tree.has_changes():
 
3642
            if tree.has_changes(basis_tree):
3833
3643
                raise errors.UncommittedChanges(tree)
3834
3644
 
3835
3645
        view_info = _get_view_info_for_change_reporter(tree)
3836
3646
        change_reporter = delta._ChangeReporter(
3837
3647
            unversioned_filter=tree.is_ignored, view_info=view_info)
3838
 
        pb = ui.ui_factory.nested_progress_bar()
3839
 
        self.add_cleanup(pb.finished)
3840
 
        tree.lock_write()
3841
 
        self.add_cleanup(tree.unlock)
3842
 
        if location is not None:
3843
 
            try:
3844
 
                mergeable = bundle.read_mergeable_from_url(location,
3845
 
                    possible_transports=possible_transports)
3846
 
            except errors.NotABundle:
3847
 
                mergeable = None
 
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.')
 
3690
                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)
3848
3704
            else:
3849
 
                if uncommitted:
3850
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3851
 
                        ' with bundles or merge directives.')
3852
 
 
3853
 
                if revision is not None:
3854
 
                    raise errors.BzrCommandError(
3855
 
                        'Cannot use -r with merge directives or bundles')
3856
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3857
 
                   mergeable, None)
3858
 
 
3859
 
        if merger is None and uncommitted:
3860
 
            if revision is not None and len(revision) > 0:
3861
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3862
 
                    ' --revision at the same time.')
3863
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3864
 
            allow_pending = False
3865
 
 
3866
 
        if merger is None:
3867
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3868
 
                location, revision, remember, possible_transports, None)
3869
 
 
3870
 
        merger.merge_type = merge_type
3871
 
        merger.reprocess = reprocess
3872
 
        merger.show_base = show_base
3873
 
        self.sanity_check_merger(merger)
3874
 
        if (merger.base_rev_id == merger.other_rev_id and
3875
 
            merger.other_rev_id is not None):
3876
 
            note('Nothing to do.')
3877
 
            return 0
3878
 
        if pull:
3879
 
            if merger.interesting_files is not None:
3880
 
                raise errors.BzrCommandError('Cannot pull individual files')
3881
 
            if (merger.base_rev_id == tree.last_revision()):
3882
 
                result = tree.pull(merger.other_branch, False,
3883
 
                                   merger.other_rev_id)
3884
 
                result.report(self.outf)
3885
 
                return 0
3886
 
        if merger.this_basis is None:
3887
 
            raise errors.BzrCommandError(
3888
 
                "This branch has no commits."
3889
 
                " (perhaps you would prefer 'bzr pull')")
3890
 
        if preview:
3891
 
            return self._do_preview(merger)
3892
 
        elif interactive:
3893
 
            return self._do_interactive(merger)
3894
 
        else:
3895
 
            return self._do_merge(merger, change_reporter, allow_pending,
3896
 
                                  verified)
3897
 
 
3898
 
    def _get_preview(self, merger):
 
3705
                return self._do_merge(merger, change_reporter, allow_pending,
 
3706
                                      verified)
 
3707
        finally:
 
3708
            for cleanup in reversed(cleanups):
 
3709
                cleanup()
 
3710
 
 
3711
    def _get_preview(self, merger, cleanups):
3899
3712
        tree_merger = merger.make_merger()
3900
3713
        tt = tree_merger.make_preview_transform()
3901
 
        self.add_cleanup(tt.finalize)
 
3714
        cleanups.append(tt.finalize)
3902
3715
        result_tree = tt.get_preview_tree()
3903
3716
        return result_tree
3904
3717
 
3905
 
    def _do_preview(self, merger):
 
3718
    def _do_preview(self, merger, cleanups):
3906
3719
        from bzrlib.diff import show_diff_trees
3907
 
        result_tree = self._get_preview(merger)
 
3720
        result_tree = self._get_preview(merger, cleanups)
3908
3721
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
3722
                        old_label='', new_label='')
3910
3723
 
3920
3733
        else:
3921
3734
            return 0
3922
3735
 
3923
 
    def _do_interactive(self, merger):
 
3736
    def _do_interactive(self, merger, cleanups):
3924
3737
        """Perform an interactive merge.
3925
3738
 
3926
3739
        This works by generating a preview tree of the merge, then using
3928
3741
        and the preview tree.
3929
3742
        """
3930
3743
        from bzrlib import shelf_ui
3931
 
        result_tree = self._get_preview(merger)
 
3744
        result_tree = self._get_preview(merger, cleanups)
3932
3745
        writer = bzrlib.option.diff_writer_registry.get()
3933
3746
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3934
3747
                                   reporter=shelf_ui.ApplyReporter(),
3935
3748
                                   diff_writer=writer(sys.stdout))
3936
 
        try:
3937
 
            shelver.run()
3938
 
        finally:
3939
 
            shelver.finalize()
 
3749
        shelver.run()
3940
3750
 
3941
3751
    def sanity_check_merger(self, merger):
3942
3752
        if (merger.show_base and
4002
3812
            allow_pending = True
4003
3813
        return merger, allow_pending
4004
3814
 
4005
 
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3815
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
4006
3816
        """Get a merger for uncommitted changes.
4007
3817
 
4008
3818
        :param tree: The tree the merger should apply to.
4009
3819
        :param location: The location containing uncommitted changes.
4010
3820
        :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.
4011
3823
        """
4012
3824
        location = self._select_branch_location(tree, location)[0]
4013
3825
        other_tree, other_path = WorkingTree.open_containing(location)
4065
3877
 
4066
3878
 
4067
3879
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
3880
    """Redo a merge.
4069
3881
 
4070
3882
    Use this if you want to try a different merge technique while resolving
4071
3883
    conflicts.  Some merge techniques are better than others, and remerge
4096
3908
 
4097
3909
    def run(self, file_list=None, merge_type=None, show_base=False,
4098
3910
            reprocess=False):
4099
 
        from bzrlib.conflicts import restore
4100
3911
        if merge_type is None:
4101
3912
            merge_type = _mod_merge.Merge3Merger
4102
3913
        tree, file_list = tree_files(file_list)
4103
3914
        tree.lock_write()
4104
 
        self.add_cleanup(tree.unlock)
4105
 
        parents = tree.get_parent_ids()
4106
 
        if len(parents) != 2:
4107
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4108
 
                                         " merges.  Not cherrypicking or"
4109
 
                                         " multi-merges.")
4110
 
        repository = tree.branch.repository
4111
 
        interesting_ids = None
4112
 
        new_conflicts = []
4113
 
        conflicts = tree.conflicts()
4114
 
        if file_list is not None:
4115
 
            interesting_ids = set()
4116
 
            for filename in file_list:
4117
 
                file_id = tree.path2id(filename)
4118
 
                if file_id is None:
4119
 
                    raise errors.NotVersionedError(filename)
4120
 
                interesting_ids.add(file_id)
4121
 
                if tree.kind(file_id) != "directory":
4122
 
                    continue
 
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
4123
3934
 
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:
 
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])
4137
3959
            try:
4138
 
                restore(tree.abspath(filename))
4139
 
            except errors.NotConflicted:
4140
 
                pass
4141
 
        # Disable pending merges, because the file texts we are remerging
4142
 
        # have not had those merges performed.  If we use the wrong parents
4143
 
        # list, we imply that the working tree text has seen and rejected
4144
 
        # all the changes from the other tree, when in fact those changes
4145
 
        # have not yet been seen.
4146
 
        tree.set_parent_ids(parents[:1])
4147
 
        try:
4148
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4149
 
            merger.interesting_ids = interesting_ids
4150
 
            merger.merge_type = merge_type
4151
 
            merger.show_base = show_base
4152
 
            merger.reprocess = reprocess
4153
 
            conflicts = merger.do_merge()
 
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()
4154
3970
        finally:
4155
 
            tree.set_parent_ids(parents)
 
3971
            tree.unlock()
4156
3972
        if conflicts > 0:
4157
3973
            return 1
4158
3974
        else:
4160
3976
 
4161
3977
 
4162
3978
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
3979
    """Revert files to a previous revision.
4164
3980
 
4165
3981
    Giving a list of files will revert only those files.  Otherwise, all files
4166
3982
    will be reverted.  If the revision is not specified with '--revision', the
4180
3996
    name.  If you name a directory, all the contents of that directory will be
4181
3997
    reverted.
4182
3998
 
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.
 
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.
4187
4002
 
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
 
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
4195
4009
    reverting any files.
4196
 
 
4197
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4198
 
    changes from a branch in a single revision.  To do this, perform the merge
4199
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4200
 
    the content of the tree as it was, but it will clear the list of pending
4201
 
    merges.  The next commit will then contain all of the changes that are
4202
 
    present in the other branch, but without any other parent revisions.
4203
 
    Because this technique forgets where these changes originated, it may
4204
 
    cause additional conflicts on later merges involving the same source and
4205
 
    target branches.
4206
4010
    """
4207
4011
 
4208
4012
    _see_also = ['cat', 'export']
4217
4021
    def run(self, revision=None, no_backup=False, file_list=None,
4218
4022
            forget_merges=None):
4219
4023
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
4221
 
        self.add_cleanup(tree.unlock)
4222
 
        if forget_merges:
4223
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4224
 
        else:
4225
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
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()
4226
4032
 
4227
4033
    @staticmethod
4228
4034
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4229
4035
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4230
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4231
 
            report_changes=True)
 
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()
4232
4042
 
4233
4043
 
4234
4044
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
4045
    """Test reporting of assertion failures"""
4236
4046
    # intended just for use in testing
4237
4047
 
4238
4048
    hidden = True
4242
4052
 
4243
4053
 
4244
4054
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
4055
    """Show help on a command or other topic.
4246
4056
    """
4247
4057
 
4248
4058
    _see_also = ['topics']
4261
4071
 
4262
4072
 
4263
4073
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
4074
    """Show appropriate completions for context.
4265
4075
 
4266
4076
    For a list of all available commands, say 'bzr shell-complete'.
4267
4077
    """
4276
4086
 
4277
4087
 
4278
4088
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4089
    """Show unmerged/unpulled revisions between two branches.
4280
4090
 
4281
4091
    OTHER_BRANCH may be local or remote.
4282
4092
 
4283
4093
    To filter on a range of revisions, you can use the command -r begin..end
4284
4094
    -r revision requests a specific revision, -r ..end or -r begin.. are
4285
4095
    also valid.
4286
 
            
4287
 
    :Exit values:
4288
 
        1 - some missing revisions
4289
 
        0 - no missing revisions
4290
4096
 
4291
4097
    :Examples:
4292
4098
 
4360
4166
            restrict = 'remote'
4361
4167
 
4362
4168
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
4169
        parent = local_branch.get_parent()
4367
4170
        if other_branch is None:
4368
4171
            other_branch = parent
4377
4180
        remote_branch = Branch.open(other_branch)
4378
4181
        if remote_branch.base == local_branch.base:
4379
4182
            remote_branch = local_branch
4380
 
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
4383
4183
 
4384
4184
        local_revid_range = _revision_range_to_revid_range(
4385
4185
            _get_revision_range(my_revision, local_branch,
4389
4189
            _get_revision_range(revision,
4390
4190
                remote_branch, self.name()))
4391
4191
 
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()
 
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()
4442
4249
        if not status_code and parent is None and other_branch is not None:
4443
4250
            local_branch.lock_write()
4444
 
            self.add_cleanup(local_branch.unlock)
4445
 
            # handle race conditions - a parent might be set while we run.
4446
 
            if local_branch.get_parent() is None:
4447
 
                local_branch.set_parent(remote_branch.base)
 
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()
4448
4257
        return status_code
4449
4258
 
4450
4259
 
4451
4260
class cmd_pack(Command):
4452
 
    __doc__ = """Compress the data within a repository.
4453
 
 
4454
 
    This operation compresses the data within a bazaar repository. As
4455
 
    bazaar supports automatic packing of repository, this operation is
4456
 
    normally not required to be done manually.
4457
 
 
4458
 
    During the pack operation, bazaar takes a backup of existing repository
4459
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4460
 
    automatically when it is safe to do so. To save disk space by removing
4461
 
    the backed up pack files, the --clean-obsolete-packs option may be
4462
 
    used.
4463
 
 
4464
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4465
 
    during or immediately after repacking, you may be left with a state
4466
 
    where the deletion has been written to disk but the new packs have not
4467
 
    been. In this case the repository may be unusable.
4468
 
    """
 
4261
    """Compress the data within a repository."""
4469
4262
 
4470
4263
    _see_also = ['repositories']
4471
4264
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
4265
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4266
    def run(self, branch_or_repo='.'):
4477
4267
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
4268
        try:
4479
4269
            branch = dir.open_branch()
4480
4270
            repository = branch.repository
4481
4271
        except errors.NotBranchError:
4482
4272
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4273
        repository.pack()
4484
4274
 
4485
4275
 
4486
4276
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
 
4277
    """List the installed plugins.
4488
4278
 
4489
4279
    This command displays the list of installed plugins including
4490
4280
    version of plugin and a short description of each.
4497
4287
    adding new commands, providing additional network transports and
4498
4288
    customizing log output.
4499
4289
 
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.
 
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.
4504
4294
    """
4505
4295
    takes_options = ['verbose']
4506
4296
 
4521
4311
                doc = '(no description)'
4522
4312
            result.append((name_ver, doc, plugin.path()))
4523
4313
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
 
4314
            print name_ver
 
4315
            print '   ', doc
4526
4316
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
4317
                print '   ', path
 
4318
            print
4529
4319
 
4530
4320
 
4531
4321
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4322
    """Show testament (signing-form) of a revision."""
4533
4323
    takes_options = [
4534
4324
            'revision',
4535
4325
            Option('long', help='Produce long-format testament.'),
4548
4338
        else:
4549
4339
            b = Branch.open(branch)
4550
4340
        b.lock_read()
4551
 
        self.add_cleanup(b.unlock)
4552
 
        if revision is None:
4553
 
            rev_id = b.last_revision()
4554
 
        else:
4555
 
            rev_id = revision[0].as_revision_id(b)
4556
 
        t = testament_class.from_revision(b.repository, rev_id)
4557
 
        if long:
4558
 
            sys.stdout.writelines(t.as_text_lines())
4559
 
        else:
4560
 
            sys.stdout.write(t.as_short_text())
 
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()
4561
4353
 
4562
4354
 
4563
4355
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4356
    """Show the origin of each line in a file.
4565
4357
 
4566
4358
    This prints out the given file with an annotation on the left side
4567
4359
    indicating which revision, author and date introduced the change.
4589
4381
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4590
4382
        if wt is not None:
4591
4383
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
4593
4384
        else:
4594
4385
            branch.lock_read()
4595
 
            self.add_cleanup(branch.unlock)
4596
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4597
 
        tree.lock_read()
4598
 
        self.add_cleanup(tree.unlock)
4599
 
        if wt is not None:
4600
 
            file_id = wt.path2id(relpath)
4601
 
        else:
4602
 
            file_id = tree.path2id(relpath)
4603
 
        if file_id is None:
4604
 
            raise errors.NotVersionedError(filename)
4605
 
        file_version = tree.inventory[file_id].revision
4606
 
        if wt is not None and revision is None:
4607
 
            # If there is a tree and we're not annotating historical
4608
 
            # versions, annotate the working tree's content.
4609
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4610
 
                show_ids=show_ids)
4611
 
        else:
4612
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
 
                          show_ids=show_ids)
 
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()
4614
4408
 
4615
4409
 
4616
4410
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4411
    """Create a digital signature for an existing revision."""
4618
4412
    # TODO be able to replace existing ones.
4619
4413
 
4620
4414
    hidden = True # is this right ?
4628
4422
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4629
4423
        b = WorkingTree.open_containing(u'.')[0].branch
4630
4424
        b.lock_write()
4631
 
        self.add_cleanup(b.unlock)
4632
 
        return self._run(b, revision_id_list, revision)
 
4425
        try:
 
4426
            return self._run(b, revision_id_list, revision)
 
4427
        finally:
 
4428
            b.unlock()
4633
4429
 
4634
4430
    def _run(self, b, revision_id_list, revision):
4635
4431
        import bzrlib.gpg as gpg
4680
4476
 
4681
4477
 
4682
4478
class cmd_bind(Command):
4683
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4684
 
    If no branch is supplied, rebind to the last bound location.
 
4479
    """Convert the current branch into a checkout of the supplied branch.
4685
4480
 
4686
4481
    Once converted into a checkout, commits must succeed on the master branch
4687
4482
    before they will be applied to the local branch.
4688
4483
 
4689
4484
    Bound branches use the nickname of its master branch unless it is set
4690
 
    locally, in which case binding will update the local nickname to be
 
4485
    locally, in which case binding will update the the local nickname to be
4691
4486
    that of the master.
4692
4487
    """
4693
4488
 
4705
4500
                    'This format does not remember old locations.')
4706
4501
            else:
4707
4502
                if location is None:
4708
 
                    if b.get_bound_location() is not None:
4709
 
                        raise errors.BzrCommandError('Branch is already bound')
4710
 
                    else:
4711
 
                        raise errors.BzrCommandError('No location supplied '
4712
 
                            'and no previous location known')
 
4503
                    raise errors.BzrCommandError('No location supplied and no '
 
4504
                        'previous location known')
4713
4505
        b_other = Branch.open(location)
4714
4506
        try:
4715
4507
            b.bind(b_other)
4721
4513
 
4722
4514
 
4723
4515
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4516
    """Convert the current checkout into a regular branch.
4725
4517
 
4726
4518
    After unbinding, the local branch is considered independent and subsequent
4727
4519
    commits will be local only.
4738
4530
 
4739
4531
 
4740
4532
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4533
    """Remove the last committed revision.
4742
4534
 
4743
4535
    --verbose will print out what is being removed.
4744
4536
    --dry-run will go through all the motions, but not actually
4785
4577
 
4786
4578
        if tree is not None:
4787
4579
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
4789
4580
        else:
4790
4581
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
4792
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
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()
4793
4590
 
4794
4591
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4795
4592
        from bzrlib.log import log_formatter, show_log
4827
4624
                 end_revision=last_revno)
4828
4625
 
4829
4626
        if dry_run:
4830
 
            self.outf.write('Dry-run, pretending to remove'
4831
 
                            ' the above revisions.\n')
 
4627
            print 'Dry-run, pretending to remove the above revisions.'
 
4628
            if not force:
 
4629
                val = raw_input('Press <enter> to continue')
4832
4630
        else:
4833
 
            self.outf.write('The above revision(s) will be removed.\n')
4834
 
 
4835
 
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
4838
 
                return 0
 
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
4839
4637
 
4840
4638
        mutter('Uncommitting from {%s} to {%s}',
4841
4639
               last_rev_id, rev_id)
4842
4640
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4843
4641
                 revno=revno, local=local)
4844
 
        self.outf.write('You can restore the old tip by running:\n'
4845
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4642
        note('You can restore the old tip by running:\n'
 
4643
             '  bzr pull . -r revid:%s', last_rev_id)
4846
4644
 
4847
4645
 
4848
4646
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4647
    """Break a dead lock on a repository, branch or working directory.
4850
4648
 
4851
4649
    CAUTION: Locks should only be broken when you are sure that the process
4852
4650
    holding the lock has been stopped.
4853
4651
 
4854
 
    You can get information on what locks are open via the 'bzr info
4855
 
    [location]' command.
 
4652
    You can get information on what locks are open via the 'bzr info' command.
4856
4653
 
4857
4654
    :Examples:
4858
4655
        bzr break-lock
4859
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4860
4656
    """
4861
4657
    takes_args = ['location?']
4862
4658
 
4871
4667
 
4872
4668
 
4873
4669
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4670
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4671
 
4876
4672
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4673
    """
4885
4681
 
4886
4682
 
4887
4683
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4684
    """Run the bzr server."""
4889
4685
 
4890
4686
    aliases = ['server']
4891
4687
 
4892
4688
    takes_options = [
4893
4689
        Option('inet',
4894
4690
               help='Serve on stdin/out for use from inetd or sshd.'),
4895
 
        RegistryOption('protocol',
4896
 
               help="Protocol to serve.",
 
4691
        RegistryOption('protocol', 
 
4692
               help="Protocol to serve.", 
4897
4693
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4898
4694
               value_switches=True),
4899
4695
        Option('port',
4908
4704
        Option('allow-writes',
4909
4705
               help='By default the server is a readonly server.  Supplying '
4910
4706
                    '--allow-writes enables write access to the contents of '
4911
 
                    'the served directory and below.  Note that ``bzr serve`` '
4912
 
                    'does not perform authentication, so unless some form of '
4913
 
                    'external authentication is arranged supplying this '
4914
 
                    'option leads to global uncontrolled write access to your '
4915
 
                    'file system.'
 
4707
                    'the served directory and below.'
4916
4708
                ),
4917
4709
        ]
4918
4710
 
4951
4743
 
4952
4744
 
4953
4745
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
 
4746
    """Combine a tree into its containing tree.
4955
4747
 
4956
4748
    This command requires the target tree to be in a rich-root format.
4957
4749
 
4997
4789
 
4998
4790
 
4999
4791
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4792
    """Split a subdirectory of a tree into a separate tree.
5001
4793
 
5002
4794
    This command will produce a target tree in a format that supports
5003
4795
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5023
4815
 
5024
4816
 
5025
4817
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4818
    """Generate a merge directive for auto-merge tools.
5027
4819
 
5028
4820
    A directive requests a merge to be performed, and also provides all the
5029
4821
    information necessary to do so.  This means it must either include a
5122
4914
 
5123
4915
 
5124
4916
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4917
    """Mail or create a merge-directive for submitting changes.
5126
4918
 
5127
4919
    A merge directive provides many things needed for requesting merges:
5128
4920
 
5134
4926
      directly from the merge directive, without retrieving data from a
5135
4927
      branch.
5136
4928
 
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.
 
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.
5163
4941
 
5164
4942
    Mail is sent using your preferred mail program.  This should be transparent
5165
4943
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5167
4945
 
5168
4946
    To use a specific mail program, set the mail_client configuration option.
5169
4947
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5170
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5171
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5172
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5173
 
    supported clients.
 
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.
5174
4951
 
5175
4952
    If mail is being sent, a to address is required.  This can be supplied
5176
4953
    either on the commandline, by setting the submit_to configuration
5185
4962
 
5186
4963
    The merge directives created by bzr send may be applied using bzr merge or
5187
4964
    bzr pull by specifying a file containing a merge directive as the location.
5188
 
 
5189
 
    bzr send makes extensive use of public locations to map local locations into
5190
 
    URLs that can be used by other people.  See `bzr help configuration` to
5191
 
    set them, and use `bzr info` to display them.
5192
4965
    """
5193
4966
 
5194
4967
    encoding_type = 'exact'
5210
4983
               short_name='f',
5211
4984
               type=unicode),
5212
4985
        Option('output', short_name='o',
5213
 
               help='Write merge directive to this file or directory; '
 
4986
               help='Write merge directive to this file; '
5214
4987
                    'use - for stdout.',
5215
4988
               type=unicode),
5216
4989
        Option('strict',
5239
5012
 
5240
5013
 
5241
5014
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5015
    """Create a merge-directive for submitting changes.
5243
5016
 
5244
5017
    A merge directive provides many things needed for requesting merges:
5245
5018
 
5312
5085
 
5313
5086
 
5314
5087
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5088
    """Create, remove or modify a tag naming a revision.
5316
5089
 
5317
5090
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
5091
    (--revision) option can be given -rtag:X, where X is any previously
5326
5099
 
5327
5100
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5328
5101
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5329
 
 
5330
 
    If no tag name is specified it will be determined through the 
5331
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5332
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5333
 
    details.
5334
5102
    """
5335
5103
 
5336
5104
    _see_also = ['commit', 'tags']
5337
 
    takes_args = ['tag_name?']
 
5105
    takes_args = ['tag_name']
5338
5106
    takes_options = [
5339
5107
        Option('delete',
5340
5108
            help='Delete this tag rather than placing it.',
5350
5118
        'revision',
5351
5119
        ]
5352
5120
 
5353
 
    def run(self, tag_name=None,
 
5121
    def run(self, tag_name,
5354
5122
            delete=None,
5355
5123
            directory='.',
5356
5124
            force=None,
5358
5126
            ):
5359
5127
        branch, relpath = Branch.open_containing(directory)
5360
5128
        branch.lock_write()
5361
 
        self.add_cleanup(branch.unlock)
5362
 
        if delete:
5363
 
            if tag_name is None:
5364
 
                raise errors.BzrCommandError("No tag specified to delete.")
5365
 
            branch.tags.delete_tag(tag_name)
5366
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5367
 
        else:
5368
 
            if revision:
5369
 
                if len(revision) != 1:
5370
 
                    raise errors.BzrCommandError(
5371
 
                        "Tags can only be placed on a single revision, "
5372
 
                        "not on a range")
5373
 
                revision_id = revision[0].as_revision_id(branch)
 
5129
        try:
 
5130
            if delete:
 
5131
                branch.tags.delete_tag(tag_name)
 
5132
                self.outf.write('Deleted tag %s.\n' % tag_name)
5374
5133
            else:
5375
 
                revision_id = branch.last_revision()
5376
 
            if tag_name is None:
5377
 
                tag_name = branch.automatic_tag_name(revision_id)
5378
 
                if tag_name is None:
5379
 
                    raise errors.BzrCommandError(
5380
 
                        "Please specify a tag name.")
5381
 
            if (not force) and branch.tags.has_tag(tag_name):
5382
 
                raise errors.TagAlreadyExists(tag_name)
5383
 
            branch.tags.set_tag(tag_name, revision_id)
5384
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
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()
5385
5148
 
5386
5149
 
5387
5150
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
5151
    """List tags.
5389
5152
 
5390
5153
    This command shows a table of tag names and the revisions they reference.
5391
5154
    """
5420
5183
            return
5421
5184
 
5422
5185
        branch.lock_read()
5423
 
        self.add_cleanup(branch.unlock)
5424
 
        if revision:
5425
 
            graph = branch.repository.get_graph()
5426
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5427
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5428
 
            # only show revisions between revid1 and revid2 (inclusive)
5429
 
            tags = [(tag, revid) for tag, revid in tags if
5430
 
                graph.is_between(revid, revid1, revid2)]
5431
 
        if sort == 'alpha':
5432
 
            tags.sort()
5433
 
        elif sort == 'time':
5434
 
            timestamps = {}
5435
 
            for tag, revid in tags:
5436
 
                try:
5437
 
                    revobj = branch.repository.get_revision(revid)
5438
 
                except errors.NoSuchRevision:
5439
 
                    timestamp = sys.maxint # place them at the end
5440
 
                else:
5441
 
                    timestamp = revobj.timestamp
5442
 
                timestamps[revid] = timestamp
5443
 
            tags.sort(key=lambda x: timestamps[x[1]])
5444
 
        if not show_ids:
5445
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
 
            for index, (tag, revid) in enumerate(tags):
5447
 
                try:
5448
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5449
 
                    if isinstance(revno, tuple):
5450
 
                        revno = '.'.join(map(str, revno))
5451
 
                except errors.NoSuchRevision:
5452
 
                    # Bad tag data/merges can lead to tagged revisions
5453
 
                    # which are not in this branch. Fail gracefully ...
5454
 
                    revno = '?'
5455
 
                tags[index] = (tag, revno)
5456
 
        self.cleanup_now()
 
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()
5457
5221
        for tag, revspec in tags:
5458
5222
            self.outf.write('%-20s %s\n' % (tag, revspec))
5459
5223
 
5460
5224
 
5461
5225
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5226
    """Reconfigure the type of a bzr directory.
5463
5227
 
5464
5228
    A target configuration must be specified.
5465
5229
 
5550
5314
 
5551
5315
 
5552
5316
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
 
5317
    """Set the branch of a checkout and update.
5554
5318
 
5555
5319
    For lightweight checkouts, this changes the branch being referenced.
5556
5320
    For heavyweight checkouts, this checks that there are no local commits
5568
5332
    /path/to/newbranch.
5569
5333
 
5570
5334
    Bound branches use the nickname of its master branch unless it is set
5571
 
    locally, in which case switching will update the local nickname to be
 
5335
    locally, in which case switching will update the the local nickname to be
5572
5336
    that of the master.
5573
5337
    """
5574
5338
 
5575
 
    takes_args = ['to_location?']
 
5339
    takes_args = ['to_location']
5576
5340
    takes_options = [Option('force',
5577
5341
                        help='Switch even if local commits will be lost.'),
5578
 
                     'revision',
5579
5342
                     Option('create-branch', short_name='b',
5580
5343
                        help='Create the target branch from this one before'
5581
5344
                             ' switching to it.'),
5582
 
                    ]
 
5345
                     ]
5583
5346
 
5584
 
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5347
    def run(self, to_location, force=False, create_branch=False):
5586
5348
        from bzrlib import switch
5587
5349
        tree_location = '.'
5588
 
        revision = _get_one_revision('switch', revision)
5589
5350
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
 
        if to_location is None:
5591
 
            if revision is None:
5592
 
                raise errors.BzrCommandError('You must supply either a'
5593
 
                                             ' revision or a location')
5594
 
            to_location = '.'
5595
5351
        try:
5596
5352
            branch = control_dir.open_branch()
5597
5353
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5602
5358
            if branch is None:
5603
5359
                raise errors.BzrCommandError('cannot create branch without'
5604
5360
                                             ' source branch')
5605
 
            to_location = directory_service.directories.dereference(
5606
 
                              to_location)
5607
5361
            if '/' not in to_location and '\\' not in to_location:
5608
5362
                # This path is meant to be relative to the existing branch
5609
5363
                this_url = self._get_branch_location(control_dir)
5611
5365
            to_branch = branch.bzrdir.sprout(to_location,
5612
5366
                                 possible_transports=[branch.bzrdir.root_transport],
5613
5367
                                 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
5614
5375
        else:
5615
5376
            try:
5616
5377
                to_branch = Branch.open(to_location)
5618
5379
                this_url = self._get_branch_location(control_dir)
5619
5380
                to_branch = Branch.open(
5620
5381
                    urlutils.join(this_url, '..', to_location))
5621
 
        if revision is not None:
5622
 
            revision = revision.as_revision_id(to_branch)
5623
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5382
        switch.switch(control_dir, to_branch, force)
5624
5383
        if had_explicit_nick:
5625
5384
            branch = control_dir.open_branch() #get the new branch!
5626
5385
            branch.nick = to_branch.nick
5646
5405
 
5647
5406
 
5648
5407
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5408
    """Manage filtered views.
5650
5409
 
5651
5410
    Views provide a mask over the tree so that users can focus on
5652
5411
    a subset of a tree when doing their work. After creating a view,
5800
5559
 
5801
5560
 
5802
5561
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5562
    """Show hooks."""
5804
5563
 
5805
5564
    hidden = True
5806
5565
 
5819
5578
                    self.outf.write("    <no hooks installed>\n")
5820
5579
 
5821
5580
 
5822
 
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
5824
 
 
5825
 
    This will remove the branch from the specified location but 
5826
 
    will keep any working tree or repository in place.
5827
 
 
5828
 
    :Examples:
5829
 
 
5830
 
      Remove the branch at repo/trunk::
5831
 
 
5832
 
        bzr remove-branch repo/trunk
5833
 
 
5834
 
    """
5835
 
 
5836
 
    takes_args = ["location?"]
5837
 
 
5838
 
    aliases = ["rmbranch"]
5839
 
 
5840
 
    def run(self, location=None):
5841
 
        if location is None:
5842
 
            location = "."
5843
 
        branch = Branch.open_containing(location)[0]
5844
 
        branch.bzrdir.destroy_branch()
5845
 
        
5846
 
 
5847
5581
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5582
    """Temporarily set aside some changes from the current tree.
5849
5583
 
5850
5584
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5585
    ie. out of the way, until a later time when you can bring them back from
5893
5627
        if writer is None:
5894
5628
            writer = bzrlib.option.diff_writer_registry.get()
5895
5629
        try:
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()
 
5630
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5631
                              message, destroy=destroy).run()
5902
5632
        except errors.UserAbort:
5903
5633
            return 0
5904
5634
 
5905
5635
    def run_for_list(self):
5906
5636
        tree = WorkingTree.open_containing('.')[0]
5907
5637
        tree.lock_read()
5908
 
        self.add_cleanup(tree.unlock)
5909
 
        manager = tree.get_shelf_manager()
5910
 
        shelves = manager.active_shelves()
5911
 
        if len(shelves) == 0:
5912
 
            note('No shelved changes.')
5913
 
            return 0
5914
 
        for shelf_id in reversed(shelves):
5915
 
            message = manager.get_metadata(shelf_id).get('message')
5916
 
            if message is None:
5917
 
                message = '<no message>'
5918
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5919
 
        return 1
 
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()
5920
5652
 
5921
5653
 
5922
5654
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5655
    """Restore shelved changes.
5924
5656
 
5925
5657
    By default, the most recently shelved changes are restored. However if you
5926
5658
    specify a shelf by id those changes will be restored instead.  This works
5934
5666
            enum_switch=False, value_switches=True,
5935
5667
            apply="Apply changes and remove from the shelf.",
5936
5668
            dry_run="Show changes, but do not apply or remove them.",
5937
 
            preview="Instead of unshelving the changes, show the diff that "
5938
 
                    "would result from unshelving.",
5939
 
            delete_only="Delete changes without applying them.",
5940
 
            keep="Apply changes but don't delete them.",
 
5669
            delete_only="Delete changes without applying them."
5941
5670
        )
5942
5671
    ]
5943
5672
    _see_also = ['shelve']
5944
5673
 
5945
5674
    def run(self, shelf_id=None, action='apply'):
5946
5675
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
5948
 
        try:
5949
 
            unshelver.run()
5950
 
        finally:
5951
 
            unshelver.tree.unlock()
 
5676
        Unshelver.from_args(shelf_id, action).run()
5952
5677
 
5953
5678
 
5954
5679
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
 
5680
    """Remove unwanted files from working tree.
5956
5681
 
5957
5682
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
5683
    files are never deleted.
5986
5711
 
5987
5712
 
5988
5713
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5714
    """list, view and set branch locations for nested trees.
5990
5715
 
5991
5716
    If no arguments are provided, lists the branch locations for nested trees.
5992
5717
    If one argument is provided, display the branch location for that tree.
6032
5757
            self.outf.write('%s %s\n' % (path, location))
6033
5758
 
6034
5759
 
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)
 
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