~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-07-22 18:18:34 UTC
  • mfrom: (4537.2.1 1.18-absent-content)
  • Revision ID: pqm@pqm.ubuntu.com-20090722181834-2geyfaa06s9himqg
(jam) Add AbsentContentFactory.get_bytes_as,
        which just raises a better error.

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
    """
528
482
        if tree:
529
483
            try:
530
484
                wt = WorkingTree.open_containing(location)[0]
531
 
                self.add_cleanup(wt.lock_read().unlock)
 
485
                wt.lock_read()
532
486
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
487
                raise errors.NoWorkingTree(location)
534
 
            revid = wt.last_revision()
535
488
            try:
536
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
537
 
            except errors.NoSuchRevision:
538
 
                revno_t = ('???',)
539
 
            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()
540
497
        else:
541
498
            b = Branch.open_containing(location)[0]
542
 
            self.add_cleanup(b.lock_read().unlock)
543
 
            revno = b.revno()
544
 
        self.cleanup_now()
 
499
            b.lock_read()
 
500
            try:
 
501
                revno = b.revno()
 
502
            finally:
 
503
                b.unlock()
 
504
 
545
505
        self.outf.write(str(revno) + '\n')
546
506
 
547
507
 
548
508
class cmd_revision_info(Command):
549
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
509
    """Show revision number and revision id for a given revision identifier.
550
510
    """
551
511
    hidden = True
552
512
    takes_args = ['revision_info*']
568
528
        try:
569
529
            wt = WorkingTree.open_containing(directory)[0]
570
530
            b = wt.branch
571
 
            self.add_cleanup(wt.lock_read().unlock)
 
531
            wt.lock_read()
572
532
        except (errors.NoWorkingTree, errors.NotLocalUrl):
573
533
            wt = None
574
534
            b = Branch.open_containing(directory)[0]
575
 
            self.add_cleanup(b.lock_read().unlock)
576
 
        revision_ids = []
577
 
        if revision is not None:
578
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
579
 
        if revision_info_list is not None:
580
 
            for rev_str in revision_info_list:
581
 
                rev_spec = RevisionSpec.from_string(rev_str)
582
 
                revision_ids.append(rev_spec.as_revision_id(b))
583
 
        # No arguments supplied, default to the last revision
584
 
        if len(revision_ids) == 0:
585
 
            if tree:
586
 
                if wt is None:
587
 
                    raise errors.NoWorkingTree(directory)
588
 
                revision_ids.append(wt.last_revision())
 
535
            b.lock_read()
 
536
        try:
 
537
            revision_ids = []
 
538
            if revision is not None:
 
539
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
540
            if revision_info_list is not None:
 
541
                for rev_str in revision_info_list:
 
542
                    rev_spec = RevisionSpec.from_string(rev_str)
 
543
                    revision_ids.append(rev_spec.as_revision_id(b))
 
544
            # No arguments supplied, default to the last revision
 
545
            if len(revision_ids) == 0:
 
546
                if tree:
 
547
                    if wt is None:
 
548
                        raise errors.NoWorkingTree(directory)
 
549
                    revision_ids.append(wt.last_revision())
 
550
                else:
 
551
                    revision_ids.append(b.last_revision())
 
552
 
 
553
            revinfos = []
 
554
            maxlen = 0
 
555
            for revision_id in revision_ids:
 
556
                try:
 
557
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
558
                    revno = '.'.join(str(i) for i in dotted_revno)
 
559
                except errors.NoSuchRevision:
 
560
                    revno = '???'
 
561
                maxlen = max(maxlen, len(revno))
 
562
                revinfos.append([revno, revision_id])
 
563
        finally:
 
564
            if wt is None:
 
565
                b.unlock()
589
566
            else:
590
 
                revision_ids.append(b.last_revision())
591
 
 
592
 
        revinfos = []
593
 
        maxlen = 0
594
 
        for revision_id in revision_ids:
595
 
            try:
596
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
597
 
                revno = '.'.join(str(i) for i in dotted_revno)
598
 
            except errors.NoSuchRevision:
599
 
                revno = '???'
600
 
            maxlen = max(maxlen, len(revno))
601
 
            revinfos.append([revno, revision_id])
602
 
 
603
 
        self.cleanup_now()
 
567
                wt.unlock()
 
568
 
604
569
        for ri in revinfos:
605
570
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
606
571
 
607
572
 
608
573
class cmd_add(Command):
609
 
    __doc__ = """Add specified files or directories.
 
574
    """Add specified files or directories.
610
575
 
611
576
    In non-recursive mode, all the named items are added, regardless
612
577
    of whether they were previously ignored.  A warning is given if
638
603
    branches that will be merged later (without showing the two different
639
604
    adds as a conflict). It is also useful when merging another project
640
605
    into a subdirectory of this one.
641
 
    
642
 
    Any files matching patterns in the ignore list will not be added
643
 
    unless they are explicitly mentioned.
644
606
    """
645
607
    takes_args = ['file*']
646
608
    takes_options = [
654
616
               help='Lookup file ids from this tree.'),
655
617
        ]
656
618
    encoding_type = 'replace'
657
 
    _see_also = ['remove', 'ignore']
 
619
    _see_also = ['remove']
658
620
 
659
621
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
660
622
            file_ids_from=None):
677
639
                should_print=(not is_quiet()))
678
640
 
679
641
        if base_tree:
680
 
            self.add_cleanup(base_tree.lock_read().unlock)
681
 
        tree, file_list = tree_files_for_add(file_list)
682
 
        added, ignored = tree.smart_add(file_list, not
683
 
            no_recurse, action=action, save=not dry_run)
684
 
        self.cleanup_now()
 
642
            base_tree.lock_read()
 
643
        try:
 
644
            file_list = self._maybe_expand_globs(file_list)
 
645
            tree, file_list = tree_files_for_add(file_list)
 
646
            added, ignored = tree.smart_add(file_list, not
 
647
                no_recurse, action=action, save=not dry_run)
 
648
        finally:
 
649
            if base_tree is not None:
 
650
                base_tree.unlock()
685
651
        if len(ignored) > 0:
686
652
            if verbose:
687
653
                for glob in sorted(ignored.keys()):
688
654
                    for path in ignored[glob]:
689
655
                        self.outf.write("ignored %s matching \"%s\"\n"
690
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")
691
665
 
692
666
 
693
667
class cmd_mkdir(Command):
694
 
    __doc__ = """Create a new versioned directory.
 
668
    """Create a new versioned directory.
695
669
 
696
670
    This is equivalent to creating the directory and then adding it.
697
671
    """
701
675
 
702
676
    def run(self, dir_list):
703
677
        for d in dir_list:
 
678
            os.mkdir(d)
704
679
            wt, dd = WorkingTree.open_containing(d)
705
 
            base = os.path.dirname(dd)
706
 
            id = wt.path2id(base)
707
 
            if id != None:
708
 
                os.mkdir(d)
709
 
                wt.add([dd])
710
 
                self.outf.write('added %s\n' % d)
711
 
            else:
712
 
                raise errors.NotVersionedError(path=base)
 
680
            wt.add([dd])
 
681
            self.outf.write('added %s\n' % d)
713
682
 
714
683
 
715
684
class cmd_relpath(Command):
716
 
    __doc__ = """Show path of a file relative to root"""
 
685
    """Show path of a file relative to root"""
717
686
 
718
687
    takes_args = ['filename']
719
688
    hidden = True
728
697
 
729
698
 
730
699
class cmd_inventory(Command):
731
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
700
    """Show inventory of the current working copy or a revision.
732
701
 
733
702
    It is possible to limit the output to a particular entry
734
703
    type using the --kind option.  For example: --kind file.
755
724
 
756
725
        revision = _get_one_revision('inventory', revision)
757
726
        work_tree, file_list = tree_files(file_list)
758
 
        self.add_cleanup(work_tree.lock_read().unlock)
759
 
        if revision is not None:
760
 
            tree = revision.as_tree(work_tree.branch)
761
 
 
762
 
            extra_trees = [work_tree]
763
 
            self.add_cleanup(tree.lock_read().unlock)
764
 
        else:
765
 
            tree = work_tree
766
 
            extra_trees = []
767
 
 
768
 
        if file_list is not None:
769
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
770
 
                                      require_versioned=True)
771
 
            # find_ids_across_trees may include some paths that don't
772
 
            # exist in 'tree'.
773
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
774
 
                             for file_id in file_ids if file_id in tree)
775
 
        else:
776
 
            entries = tree.inventory.entries()
777
 
 
778
 
        self.cleanup_now()
 
727
        work_tree.lock_read()
 
728
        try:
 
729
            if revision is not None:
 
730
                tree = revision.as_tree(work_tree.branch)
 
731
 
 
732
                extra_trees = [work_tree]
 
733
                tree.lock_read()
 
734
            else:
 
735
                tree = work_tree
 
736
                extra_trees = []
 
737
 
 
738
            if file_list is not None:
 
739
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
740
                                          require_versioned=True)
 
741
                # find_ids_across_trees may include some paths that don't
 
742
                # exist in 'tree'.
 
743
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
744
                                 for file_id in file_ids if file_id in tree)
 
745
            else:
 
746
                entries = tree.inventory.entries()
 
747
        finally:
 
748
            tree.unlock()
 
749
            if tree is not work_tree:
 
750
                work_tree.unlock()
 
751
 
779
752
        for path, entry in entries:
780
753
            if kind and kind != entry.kind:
781
754
                continue
787
760
 
788
761
 
789
762
class cmd_mv(Command):
790
 
    __doc__ = """Move or rename a file.
 
763
    """Move or rename a file.
791
764
 
792
765
    :Usage:
793
766
        bzr mv OLDNAME NEWNAME
826
799
        if len(names_list) < 2:
827
800
            raise errors.BzrCommandError("missing file argument")
828
801
        tree, rel_names = tree_files(names_list, canonicalize=False)
829
 
        self.add_cleanup(tree.lock_tree_write().unlock)
830
 
        self._run(tree, names_list, rel_names, after)
 
802
        tree.lock_tree_write()
 
803
        try:
 
804
            self._run(tree, names_list, rel_names, after)
 
805
        finally:
 
806
            tree.unlock()
831
807
 
832
808
    def run_auto(self, names_list, after, dry_run):
833
809
        if names_list is not None and len(names_list) > 1:
837
813
            raise errors.BzrCommandError('--after cannot be specified with'
838
814
                                         ' --auto.')
839
815
        work_tree, file_list = tree_files(names_list, default_branch='.')
840
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
841
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
816
        work_tree.lock_tree_write()
 
817
        try:
 
818
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
819
        finally:
 
820
            work_tree.unlock()
842
821
 
843
822
    def _run(self, tree, names_list, rel_names, after):
844
823
        into_existing = osutils.isdir(names_list[-1])
865
844
            # All entries reference existing inventory items, so fix them up
866
845
            # for cicp file-systems.
867
846
            rel_names = tree.get_canonical_inventory_paths(rel_names)
868
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
869
 
                if not is_quiet():
870
 
                    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)
871
849
        else:
872
850
            if len(names_list) != 2:
873
851
                raise errors.BzrCommandError('to mv multiple files the'
917
895
            dest = osutils.pathjoin(dest_parent, dest_tail)
918
896
            mutter("attempting to move %s => %s", src, dest)
919
897
            tree.rename_one(src, dest, after=after)
920
 
            if not is_quiet():
921
 
                self.outf.write("%s => %s\n" % (src, dest))
 
898
            self.outf.write("%s => %s\n" % (src, dest))
922
899
 
923
900
 
924
901
class cmd_pull(Command):
925
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
902
    """Turn this branch into a mirror of another branch.
926
903
 
927
 
    By default, this command only works on branches that have not diverged.
928
 
    Branches are considered diverged if the destination branch's most recent 
929
 
    commit is one that has not been merged (directly or indirectly) into the 
930
 
    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.
931
907
 
932
908
    If branches have diverged, you can use 'bzr merge' to integrate the changes
933
909
    from one into the other.  Once one branch has merged, the other should
934
910
    be able to pull it again.
935
911
 
936
 
    If you want to replace your local changes and just want your branch to
937
 
    match the remote one, use pull --overwrite. This will work even if the two
938
 
    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.
939
914
 
940
915
    If there is no default location set, the first pull will set it.  After
941
916
    that, you can omit the location to use the default.  To change the
977
952
        try:
978
953
            tree_to = WorkingTree.open_containing(directory)[0]
979
954
            branch_to = tree_to.branch
980
 
            self.add_cleanup(tree_to.lock_write().unlock)
981
955
        except errors.NoWorkingTree:
982
956
            tree_to = None
983
957
            branch_to = Branch.open_containing(directory)[0]
984
 
            self.add_cleanup(branch_to.lock_write().unlock)
985
 
 
 
958
        
986
959
        if local and not branch_to.get_bound_location():
987
960
            raise errors.LocalRequiresBoundBranch()
988
961
 
1018
991
        else:
1019
992
            branch_from = Branch.open(location,
1020
993
                possible_transports=possible_transports)
1021
 
            self.add_cleanup(branch_from.lock_read().unlock)
1022
994
 
1023
995
            if branch_to.get_parent() is None or remember:
1024
996
                branch_to.set_parent(branch_from.base)
1025
997
 
1026
 
        if revision is not None:
1027
 
            revision_id = revision.as_revision_id(branch_from)
1028
 
 
1029
 
        if tree_to is not None:
1030
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1031
 
            change_reporter = delta._ChangeReporter(
1032
 
                unversioned_filter=tree_to.is_ignored,
1033
 
                view_info=view_info)
1034
 
            result = tree_to.pull(
1035
 
                branch_from, overwrite, revision_id, change_reporter,
1036
 
                possible_transports=possible_transports, local=local)
1037
 
        else:
1038
 
            result = branch_to.pull(
1039
 
                branch_from, overwrite, revision_id, local=local)
1040
 
 
1041
 
        result.report(self.outf)
1042
 
        if verbose and result.old_revid != result.new_revid:
1043
 
            log.show_branch_change(
1044
 
                branch_to, self.outf, result.old_revno,
1045
 
                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()
1046
1028
 
1047
1029
 
1048
1030
class cmd_push(Command):
1049
 
    __doc__ = """Update a mirror of this branch.
 
1031
    """Update a mirror of this branch.
1050
1032
 
1051
1033
    The target branch will not have its working tree populated because this
1052
1034
    is both expensive, and is not supported on remote file systems.
1113
1095
        # Get the source branch
1114
1096
        (tree, br_from,
1115
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
1116
1101
        # Get the tip's revision_id
1117
1102
        revision = _get_one_revision('push', revision)
1118
1103
        if revision is not None:
1119
1104
            revision_id = revision.in_history(br_from).rev_id
1120
1105
        else:
1121
1106
            revision_id = None
1122
 
        if tree is not None and revision_id is None:
1123
 
            tree.check_changed_or_out_of_date(
1124
 
                strict, 'push_strict',
1125
 
                more_error='Use --no-strict to force the push.',
1126
 
                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
 
1127
1119
        # Get the stacked_on branch, if any
1128
1120
        if stacked_on is not None:
1129
1121
            stacked_on = urlutils.normalize_url(stacked_on)
1161
1153
 
1162
1154
 
1163
1155
class cmd_branch(Command):
1164
 
    __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.
1165
1157
 
1166
1158
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1167
1159
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1180
1172
        help='Hard-link working tree files where possible.'),
1181
1173
        Option('no-tree',
1182
1174
            help="Create a branch without a working-tree."),
1183
 
        Option('switch',
1184
 
            help="Switch the checkout in the current directory "
1185
 
                 "to the new branch."),
1186
1175
        Option('stacked',
1187
1176
            help='Create a stacked branch referring to the source branch. '
1188
1177
                'The new branch will depend on the availability of the source '
1194
1183
                    ' directory exists, but does not already'
1195
1184
                    ' have a control directory.  This flag will'
1196
1185
                    ' allow branch to proceed.'),
1197
 
        Option('bind',
1198
 
            help="Bind new branch to from location."),
1199
1186
        ]
1200
1187
    aliases = ['get', 'clone']
1201
1188
 
1202
1189
    def run(self, from_location, to_location=None, revision=None,
1203
1190
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1204
 
            use_existing_dir=False, switch=False, bind=False):
1205
 
        from bzrlib import switch as _mod_switch
 
1191
            use_existing_dir=False):
1206
1192
        from bzrlib.tag import _merge_tags_if_possible
 
1193
 
1207
1194
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
1195
            from_location)
 
1196
        if (accelerator_tree is not None and
 
1197
            accelerator_tree.supports_content_filtering()):
 
1198
            accelerator_tree = None
1209
1199
        revision = _get_one_revision('branch', revision)
1210
 
        self.add_cleanup(br_from.lock_read().unlock)
1211
 
        if revision is not None:
1212
 
            revision_id = revision.as_revision_id(br_from)
1213
 
        else:
1214
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1215
 
            # None or perhaps NULL_REVISION to mean copy nothing
1216
 
            # RBC 20060209
1217
 
            revision_id = br_from.last_revision()
1218
 
        if to_location is None:
1219
 
            to_location = urlutils.derive_to_location(from_location)
1220
 
        to_transport = transport.get_transport(to_location)
 
1200
        br_from.lock_read()
1221
1201
        try:
1222
 
            to_transport.mkdir('.')
1223
 
        except errors.FileExists:
1224
 
            if not use_existing_dir:
1225
 
                raise errors.BzrCommandError('Target directory "%s" '
1226
 
                    'already exists.' % to_location)
 
1202
            if revision is not None:
 
1203
                revision_id = revision.as_revision_id(br_from)
1227
1204
            else:
1228
 
                try:
1229
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1230
 
                except errors.NotBranchError:
1231
 
                    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)
1232
1218
                else:
1233
 
                    raise errors.AlreadyBranchError(to_location)
1234
 
        except errors.NoSuchFile:
1235
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1236
 
                                         % to_location)
1237
 
        try:
1238
 
            # preserve whatever source format we have.
1239
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1240
 
                                        possible_transports=[to_transport],
1241
 
                                        accelerator_tree=accelerator_tree,
1242
 
                                        hardlink=hardlink, stacked=stacked,
1243
 
                                        force_new_repo=standalone,
1244
 
                                        create_tree_if_local=not no_tree,
1245
 
                                        source_branch=br_from)
1246
 
            branch = dir.open_branch()
1247
 
        except errors.NoSuchRevision:
1248
 
            to_transport.delete_tree('.')
1249
 
            msg = "The branch %s has no revision %s." % (from_location,
1250
 
                revision)
1251
 
            raise errors.BzrCommandError(msg)
1252
 
        _merge_tags_if_possible(br_from, branch)
1253
 
        # If the source branch is stacked, the new branch may
1254
 
        # be stacked whether we asked for that explicitly or not.
1255
 
        # We therefore need a try/except here and not just 'if stacked:'
1256
 
        try:
1257
 
            note('Created new stacked branch referring to %s.' %
1258
 
                branch.get_stacked_on_url())
1259
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1260
 
            errors.UnstackableRepositoryFormat), e:
1261
 
            note('Branched %d revision(s).' % branch.revno())
1262
 
        if bind:
1263
 
            # Bind to the parent
1264
 
            parent_branch = Branch.open(from_location)
1265
 
            branch.bind(parent_branch)
1266
 
            note('New branch bound to %s' % from_location)
1267
 
        if switch:
1268
 
            # Switch to the new branch
1269
 
            wt, _ = WorkingTree.open_containing('.')
1270
 
            _mod_switch.switch(wt.bzrdir, branch)
1271
 
            note('Switched to branch: %s',
1272
 
                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()
1273
1255
 
1274
1256
 
1275
1257
class cmd_checkout(Command):
1276
 
    __doc__ = """Create a new checkout of an existing branch.
 
1258
    """Create a new checkout of an existing branch.
1277
1259
 
1278
1260
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1279
1261
    the branch found in '.'. This is useful if you have removed the working tree
1342
1324
 
1343
1325
 
1344
1326
class cmd_renames(Command):
1345
 
    __doc__ = """Show list of renamed files.
 
1327
    """Show list of renamed files.
1346
1328
    """
1347
1329
    # TODO: Option to show renames between two historical versions.
1348
1330
 
1353
1335
    @display_command
1354
1336
    def run(self, dir=u'.'):
1355
1337
        tree = WorkingTree.open_containing(dir)[0]
1356
 
        self.add_cleanup(tree.lock_read().unlock)
1357
 
        new_inv = tree.inventory
1358
 
        old_tree = tree.basis_tree()
1359
 
        self.add_cleanup(old_tree.lock_read().unlock)
1360
 
        old_inv = old_tree.inventory
1361
 
        renames = []
1362
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1363
 
        for f, paths, c, v, p, n, k, e in iterator:
1364
 
            if paths[0] == paths[1]:
1365
 
                continue
1366
 
            if None in (paths):
1367
 
                continue
1368
 
            renames.append(paths)
1369
 
        renames.sort()
1370
 
        for old_name, new_name in renames:
1371
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1338
        tree.lock_read()
 
1339
        try:
 
1340
            new_inv = tree.inventory
 
1341
            old_tree = tree.basis_tree()
 
1342
            old_tree.lock_read()
 
1343
            try:
 
1344
                old_inv = old_tree.inventory
 
1345
                renames = []
 
1346
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1347
                for f, paths, c, v, p, n, k, e in iterator:
 
1348
                    if paths[0] == paths[1]:
 
1349
                        continue
 
1350
                    if None in (paths):
 
1351
                        continue
 
1352
                    renames.append(paths)
 
1353
                renames.sort()
 
1354
                for old_name, new_name in renames:
 
1355
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1356
            finally:
 
1357
                old_tree.unlock()
 
1358
        finally:
 
1359
            tree.unlock()
1372
1360
 
1373
1361
 
1374
1362
class cmd_update(Command):
1375
 
    __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.
1376
1364
 
1377
1365
    This will perform a merge into the working tree, and may generate
1378
1366
    conflicts. If you have any local changes, you will still
1380
1368
 
1381
1369
    If you want to discard your local changes, you can just do a
1382
1370
    'bzr revert' instead of 'bzr commit' after the update.
1383
 
 
1384
 
    If the tree's branch is bound to a master branch, it will also update
1385
 
    the branch from the master.
1386
1371
    """
1387
1372
 
1388
1373
    _see_also = ['pull', 'working-trees', 'status-flags']
1389
1374
    takes_args = ['dir?']
1390
 
    takes_options = ['revision']
1391
1375
    aliases = ['up']
1392
1376
 
1393
 
    def run(self, dir='.', revision=None):
1394
 
        if revision is not None and len(revision) != 1:
1395
 
            raise errors.BzrCommandError(
1396
 
                        "bzr update --revision takes exactly one revision")
 
1377
    def run(self, dir='.'):
1397
1378
        tree = WorkingTree.open_containing(dir)[0]
1398
 
        branch = tree.branch
1399
1379
        possible_transports = []
1400
 
        master = branch.get_master_branch(
 
1380
        master = tree.branch.get_master_branch(
1401
1381
            possible_transports=possible_transports)
1402
1382
        if master is not None:
1403
 
            branch_location = master.base
1404
1383
            tree.lock_write()
1405
1384
        else:
1406
 
            branch_location = tree.branch.base
1407
1385
            tree.lock_tree_write()
1408
 
        self.add_cleanup(tree.unlock)
1409
 
        # get rid of the final '/' and be ready for display
1410
 
        branch_location = urlutils.unescape_for_display(
1411
 
            branch_location.rstrip('/'),
1412
 
            self.outf.encoding)
1413
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1414
 
        if master is None:
1415
 
            old_tip = None
1416
 
        else:
1417
 
            # may need to fetch data into a heavyweight checkout
1418
 
            # XXX: this may take some time, maybe we should display a
1419
 
            # message
1420
 
            old_tip = branch.update(possible_transports)
1421
 
        if revision is not None:
1422
 
            revision_id = revision[0].as_revision_id(branch)
1423
 
        else:
1424
 
            revision_id = branch.last_revision()
1425
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1426
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1427
 
            note("Tree is up to date at revision %s of branch %s" %
1428
 
                ('.'.join(map(str, revno)), branch_location))
1429
 
            return 0
1430
 
        view_info = _get_view_info_for_change_reporter(tree)
1431
 
        change_reporter = delta._ChangeReporter(
1432
 
            unversioned_filter=tree.is_ignored,
1433
 
            view_info=view_info)
1434
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)
1435
1398
            conflicts = tree.update(
1436
 
                change_reporter,
1437
 
                possible_transports=possible_transports,
1438
 
                revision=revision_id,
1439
 
                old_tip=old_tip)
1440
 
        except errors.NoSuchRevision, e:
1441
 
            raise errors.BzrCommandError(
1442
 
                                  "branch has no revision %s\n"
1443
 
                                  "bzr update --revision only works"
1444
 
                                  " for a revision in the branch history"
1445
 
                                  % (e.revision))
1446
 
        revno = tree.branch.revision_id_to_dotted_revno(
1447
 
            _mod_revision.ensure_null(tree.last_revision()))
1448
 
        note('Updated to revision %s of branch %s' %
1449
 
             ('.'.join(map(str, revno)), branch_location))
1450
 
        parent_ids = tree.get_parent_ids()
1451
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1452
 
            note('Your local commits will now show as pending merges with '
1453
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1454
 
        if conflicts != 0:
1455
 
            return 1
1456
 
        else:
1457
 
            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()
1458
1413
 
1459
1414
 
1460
1415
class cmd_info(Command):
1461
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1416
    """Show information about a working tree, branch or repository.
1462
1417
 
1463
1418
    This command will show all known locations and formats associated to the
1464
1419
    tree, branch or repository.
1502
1457
 
1503
1458
 
1504
1459
class cmd_remove(Command):
1505
 
    __doc__ = """Remove files or directories.
 
1460
    """Remove files or directories.
1506
1461
 
1507
1462
    This makes bzr stop tracking changes to the specified files. bzr will delete
1508
1463
    them if they can easily be recovered using revert. If no options or
1517
1472
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1518
1473
            safe='Only delete files if they can be'
1519
1474
                 ' safely recovered (default).',
1520
 
            keep='Delete from bzr but leave the working copy.',
 
1475
            keep="Don't delete any files.",
1521
1476
            force='Delete all the specified files, even if they can not be '
1522
1477
                'recovered and even if they are non-empty directories.')]
1523
1478
    aliases = ['rm', 'del']
1530
1485
        if file_list is not None:
1531
1486
            file_list = [f for f in file_list]
1532
1487
 
1533
 
        self.add_cleanup(tree.lock_write().unlock)
1534
 
        # Heuristics should probably all move into tree.remove_smart or
1535
 
        # some such?
1536
 
        if new:
1537
 
            added = tree.changes_from(tree.basis_tree(),
1538
 
                specific_files=file_list).added
1539
 
            file_list = sorted([f[0] for f in added], reverse=True)
1540
 
            if len(file_list) == 0:
1541
 
                raise errors.BzrCommandError('No matching files.')
1542
 
        elif file_list is None:
1543
 
            # missing files show up in iter_changes(basis) as
1544
 
            # versioned-with-no-kind.
1545
 
            missing = []
1546
 
            for change in tree.iter_changes(tree.basis_tree()):
1547
 
                # Find paths in the working tree that have no kind:
1548
 
                if change[1][1] is not None and change[6][1] is None:
1549
 
                    missing.append(change[1][1])
1550
 
            file_list = sorted(missing, reverse=True)
1551
 
            file_deletion_strategy = 'keep'
1552
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1553
 
            keep_files=file_deletion_strategy=='keep',
1554
 
            force=file_deletion_strategy=='force')
 
1488
        tree.lock_write()
 
1489
        try:
 
1490
            # Heuristics should probably all move into tree.remove_smart or
 
1491
            # some such?
 
1492
            if new:
 
1493
                added = tree.changes_from(tree.basis_tree(),
 
1494
                    specific_files=file_list).added
 
1495
                file_list = sorted([f[0] for f in added], reverse=True)
 
1496
                if len(file_list) == 0:
 
1497
                    raise errors.BzrCommandError('No matching files.')
 
1498
            elif file_list is None:
 
1499
                # missing files show up in iter_changes(basis) as
 
1500
                # versioned-with-no-kind.
 
1501
                missing = []
 
1502
                for change in tree.iter_changes(tree.basis_tree()):
 
1503
                    # Find paths in the working tree that have no kind:
 
1504
                    if change[1][1] is not None and change[6][1] is None:
 
1505
                        missing.append(change[1][1])
 
1506
                file_list = sorted(missing, reverse=True)
 
1507
                file_deletion_strategy = 'keep'
 
1508
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1509
                keep_files=file_deletion_strategy=='keep',
 
1510
                force=file_deletion_strategy=='force')
 
1511
        finally:
 
1512
            tree.unlock()
1555
1513
 
1556
1514
 
1557
1515
class cmd_file_id(Command):
1558
 
    __doc__ = """Print file_id of a particular file or directory.
 
1516
    """Print file_id of a particular file or directory.
1559
1517
 
1560
1518
    The file_id is assigned when the file is first added and remains the
1561
1519
    same through all revisions where the file exists, even when it is
1577
1535
 
1578
1536
 
1579
1537
class cmd_file_path(Command):
1580
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1538
    """Print path of file_ids to a file or directory.
1581
1539
 
1582
1540
    This prints one line for each directory down to the target,
1583
1541
    starting at the branch root.
1599
1557
 
1600
1558
 
1601
1559
class cmd_reconcile(Command):
1602
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1560
    """Reconcile bzr metadata in a branch.
1603
1561
 
1604
1562
    This can correct data mismatches that may have been caused by
1605
1563
    previous ghost operations or bzr upgrades. You should only
1627
1585
 
1628
1586
 
1629
1587
class cmd_revision_history(Command):
1630
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1588
    """Display the list of revision ids on a branch."""
1631
1589
 
1632
1590
    _see_also = ['log']
1633
1591
    takes_args = ['location?']
1643
1601
 
1644
1602
 
1645
1603
class cmd_ancestry(Command):
1646
 
    __doc__ = """List all revisions merged into this branch."""
 
1604
    """List all revisions merged into this branch."""
1647
1605
 
1648
1606
    _see_also = ['log', 'revision-history']
1649
1607
    takes_args = ['location?']
1668
1626
 
1669
1627
 
1670
1628
class cmd_init(Command):
1671
 
    __doc__ = """Make a directory into a versioned branch.
 
1629
    """Make a directory into a versioned branch.
1672
1630
 
1673
1631
    Use this to create an empty branch, or before importing an
1674
1632
    existing project.
1702
1660
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1703
1661
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1704
1662
                value_switches=True,
1705
 
                title="Branch format",
 
1663
                title="Branch Format",
1706
1664
                ),
1707
1665
         Option('append-revisions-only',
1708
1666
                help='Never change revnos or the existing log.'
1777
1735
 
1778
1736
 
1779
1737
class cmd_init_repository(Command):
1780
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1738
    """Create a shared repository to hold branches.
1781
1739
 
1782
1740
    New branches created under the repository directory will store their
1783
 
    revisions in the repository, not in the branch directory.  For branches
1784
 
    with shared history, this reduces the amount of storage needed and 
1785
 
    speeds up the creation of new branches.
 
1741
    revisions in the repository, not in the branch directory.
1786
1742
 
1787
 
    If the --no-trees option is given then the branches in the repository
1788
 
    will not have working trees by default.  They will still exist as 
1789
 
    directories on disk, but they will not have separate copies of the 
1790
 
    files at a certain revision.  This can be useful for repositories that
1791
 
    store branches which are interacted with through checkouts or remote
1792
 
    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.
1793
1745
 
1794
1746
    :Examples:
1795
 
        Create a shared repository holding just branches::
 
1747
        Create a shared repositories holding just branches::
1796
1748
 
1797
1749
            bzr init-repo --no-trees repo
1798
1750
            bzr init repo/trunk
1837
1789
 
1838
1790
 
1839
1791
class cmd_diff(Command):
1840
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1792
    """Show differences in the working tree, between revisions or branches.
1841
1793
 
1842
1794
    If no arguments are given, all changes for the current tree are listed.
1843
1795
    If files are given, only the changes in those files are listed.
1864
1816
 
1865
1817
            bzr diff -r1
1866
1818
 
1867
 
        Difference between revision 3 and revision 1::
1868
 
 
1869
 
            bzr diff -r1..3
1870
 
 
1871
 
        Difference between revision 3 and revision 1 for branch xxx::
1872
 
 
1873
 
            bzr diff -r1..3 xxx
1874
 
 
1875
 
        To see the changes introduced in revision X::
1876
 
        
1877
 
            bzr diff -cX
1878
 
 
1879
 
        Note that in the case of a merge, the -c option shows the changes
1880
 
        compared to the left hand parent. To see the changes against
1881
 
        another parent, use::
1882
 
 
1883
 
            bzr diff -r<chosen_parent>..X
1884
 
 
1885
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1886
 
 
1887
 
            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
1888
1826
 
1889
1827
        Show just the differences for file NEWS::
1890
1828
 
1929
1867
            help='Use this command to compare files.',
1930
1868
            type=unicode,
1931
1869
            ),
1932
 
        RegistryOption('format',
1933
 
            help='Diff format to use.',
1934
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1935
 
            value_switches=False, title='Diff format'),
1936
1870
        ]
1937
1871
    aliases = ['di', 'dif']
1938
1872
    encoding_type = 'exact'
1939
1873
 
1940
1874
    @display_command
1941
1875
    def run(self, revision=None, file_list=None, diff_options=None,
1942
 
            prefix=None, old=None, new=None, using=None, format=None):
1943
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1944
 
            show_diff_trees)
 
1876
            prefix=None, old=None, new=None, using=None):
 
1877
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1945
1878
 
1946
1879
        if (prefix is None) or (prefix == '0'):
1947
1880
            # diff -p0 format
1961
1894
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1962
1895
                                         ' one or two revision specifiers')
1963
1896
 
1964
 
        if using is not None and format is not None:
1965
 
            raise errors.BzrCommandError('--using and --format are mutually '
1966
 
                'exclusive.')
1967
 
 
1968
 
        (old_tree, new_tree,
1969
 
         old_branch, new_branch,
1970
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1971
 
            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)
1972
1900
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1973
1901
                               specific_files=specific_files,
1974
1902
                               external_diff_options=diff_options,
1975
1903
                               old_label=old_label, new_label=new_label,
1976
 
                               extra_trees=extra_trees, using=using,
1977
 
                               format_cls=format)
 
1904
                               extra_trees=extra_trees, using=using)
1978
1905
 
1979
1906
 
1980
1907
class cmd_deleted(Command):
1981
 
    __doc__ = """List files deleted in the working tree.
 
1908
    """List files deleted in the working tree.
1982
1909
    """
1983
1910
    # TODO: Show files deleted since a previous revision, or
1984
1911
    # between two revisions.
1992
1919
    @display_command
1993
1920
    def run(self, show_ids=False):
1994
1921
        tree = WorkingTree.open_containing(u'.')[0]
1995
 
        self.add_cleanup(tree.lock_read().unlock)
1996
 
        old = tree.basis_tree()
1997
 
        self.add_cleanup(old.lock_read().unlock)
1998
 
        for path, ie in old.inventory.iter_entries():
1999
 
            if not tree.has_id(ie.file_id):
2000
 
                self.outf.write(path)
2001
 
                if show_ids:
2002
 
                    self.outf.write(' ')
2003
 
                    self.outf.write(ie.file_id)
2004
 
                self.outf.write('\n')
 
1922
        tree.lock_read()
 
1923
        try:
 
1924
            old = tree.basis_tree()
 
1925
            old.lock_read()
 
1926
            try:
 
1927
                for path, ie in old.inventory.iter_entries():
 
1928
                    if not tree.has_id(ie.file_id):
 
1929
                        self.outf.write(path)
 
1930
                        if show_ids:
 
1931
                            self.outf.write(' ')
 
1932
                            self.outf.write(ie.file_id)
 
1933
                        self.outf.write('\n')
 
1934
            finally:
 
1935
                old.unlock()
 
1936
        finally:
 
1937
            tree.unlock()
2005
1938
 
2006
1939
 
2007
1940
class cmd_modified(Command):
2008
 
    __doc__ = """List files modified in working tree.
 
1941
    """List files modified in working tree.
2009
1942
    """
2010
1943
 
2011
1944
    hidden = True
2028
1961
 
2029
1962
 
2030
1963
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
1964
    """List files added in working tree.
2032
1965
    """
2033
1966
 
2034
1967
    hidden = True
2042
1975
    @display_command
2043
1976
    def run(self, null=False):
2044
1977
        wt = WorkingTree.open_containing(u'.')[0]
2045
 
        self.add_cleanup(wt.lock_read().unlock)
2046
 
        basis = wt.basis_tree()
2047
 
        self.add_cleanup(basis.lock_read().unlock)
2048
 
        basis_inv = basis.inventory
2049
 
        inv = wt.inventory
2050
 
        for file_id in inv:
2051
 
            if file_id in basis_inv:
2052
 
                continue
2053
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2054
 
                continue
2055
 
            path = inv.id2path(file_id)
2056
 
            if not os.access(osutils.abspath(path), os.F_OK):
2057
 
                continue
2058
 
            if null:
2059
 
                self.outf.write(path + '\0')
2060
 
            else:
2061
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1978
        wt.lock_read()
 
1979
        try:
 
1980
            basis = wt.basis_tree()
 
1981
            basis.lock_read()
 
1982
            try:
 
1983
                basis_inv = basis.inventory
 
1984
                inv = wt.inventory
 
1985
                for file_id in inv:
 
1986
                    if file_id in basis_inv:
 
1987
                        continue
 
1988
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1989
                        continue
 
1990
                    path = inv.id2path(file_id)
 
1991
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1992
                        continue
 
1993
                    if null:
 
1994
                        self.outf.write(path + '\0')
 
1995
                    else:
 
1996
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1997
            finally:
 
1998
                basis.unlock()
 
1999
        finally:
 
2000
            wt.unlock()
2062
2001
 
2063
2002
 
2064
2003
class cmd_root(Command):
2065
 
    __doc__ = """Show the tree root directory.
 
2004
    """Show the tree root directory.
2066
2005
 
2067
2006
    The root is the nearest enclosing directory with a .bzr control
2068
2007
    directory."""
2092
2031
 
2093
2032
 
2094
2033
class cmd_log(Command):
2095
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2034
    """Show historical log for a branch or subset of a branch.
2096
2035
 
2097
2036
    log is bzr's default tool for exploring the history of a branch.
2098
2037
    The branch to use is taken from the first parameter. If no parameters
2209
2148
    :Tips & tricks:
2210
2149
 
2211
2150
      GUI tools and IDEs are often better at exploring history than command
2212
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2213
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2214
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2215
 
      <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.
2216
2158
 
2217
2159
      You may find it useful to add the aliases below to ``bazaar.conf``::
2218
2160
 
2279
2221
                   help='Show changes made in each revision as a patch.'),
2280
2222
            Option('include-merges',
2281
2223
                   help='Show merged revisions like --levels 0 does.'),
2282
 
            Option('exclude-common-ancestry',
2283
 
                   help='Display only the revisions that are not part'
2284
 
                   ' of both ancestries (require -rX..Y)'
2285
 
                   )
2286
2224
            ]
2287
2225
    encoding_type = 'replace'
2288
2226
 
2298
2236
            message=None,
2299
2237
            limit=None,
2300
2238
            show_diff=False,
2301
 
            include_merges=False,
2302
 
            exclude_common_ancestry=False,
2303
 
            ):
 
2239
            include_merges=False):
2304
2240
        from bzrlib.log import (
2305
2241
            Logger,
2306
2242
            make_log_request_dict,
2307
2243
            _get_info_for_log_files,
2308
2244
            )
2309
2245
        direction = (forward and 'forward') or 'reverse'
2310
 
        if (exclude_common_ancestry
2311
 
            and (revision is None or len(revision) != 2)):
2312
 
            raise errors.BzrCommandError(
2313
 
                '--exclude-common-ancestry requires -r with two revisions')
2314
2246
        if include_merges:
2315
2247
            if levels is None:
2316
2248
                levels = 0
2331
2263
        filter_by_dir = False
2332
2264
        if file_list:
2333
2265
            # find the file ids to log and check for directory filtering
2334
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2335
 
                revision, file_list, self.add_cleanup)
 
2266
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2267
                file_list)
2336
2268
            for relpath, file_id, kind in file_info_list:
2337
2269
                if file_id is None:
2338
2270
                    raise errors.BzrCommandError(
2356
2288
                location = '.'
2357
2289
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
2290
            b = dir.open_branch()
2359
 
            self.add_cleanup(b.lock_read().unlock)
2360
2291
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
2292
 
2362
2293
        # Decide on the type of delta & diff filtering to use
2372
2303
        else:
2373
2304
            diff_type = 'full'
2374
2305
 
2375
 
        # Build the log formatter
2376
 
        if log_format is None:
2377
 
            log_format = log.log_formatter_registry.get_default(b)
2378
 
        # Make a non-encoding output to include the diffs - bug 328007
2379
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2380
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2381
 
                        to_exact_file=unencoded_output,
2382
 
                        show_timezone=timezone,
2383
 
                        delta_format=get_verbosity_level(),
2384
 
                        levels=levels,
2385
 
                        show_advice=levels is None)
2386
 
 
2387
 
        # Choose the algorithm for doing the logging. It's annoying
2388
 
        # having multiple code paths like this but necessary until
2389
 
        # the underlying repository format is faster at generating
2390
 
        # deltas or can provide everything we need from the indices.
2391
 
        # The default algorithm - match-using-deltas - works for
2392
 
        # multiple files and directories and is faster for small
2393
 
        # amounts of history (200 revisions say). However, it's too
2394
 
        # slow for logging a single file in a repository with deep
2395
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2396
 
        # evil when adding features", we continue to use the
2397
 
        # original algorithm - per-file-graph - for the "single
2398
 
        # file that isn't a directory without showing a delta" case.
2399
 
        partial_history = revision and b.repository._format.supports_chks
2400
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2401
 
            or delta_type or partial_history)
2402
 
 
2403
 
        # Build the LogRequest and execute it
2404
 
        if len(file_ids) == 0:
2405
 
            file_ids = None
2406
 
        rqst = make_log_request_dict(
2407
 
            direction=direction, specific_fileids=file_ids,
2408
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2409
 
            message_search=message, delta_type=delta_type,
2410
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2411
 
            exclude_common_ancestry=exclude_common_ancestry,
2412
 
            )
2413
 
        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()
2414
2344
 
2415
2345
 
2416
2346
def _get_revision_range(revisionspec_list, branch, command_name):
2434
2364
            raise errors.BzrCommandError(
2435
2365
                "bzr %s doesn't accept two revisions in different"
2436
2366
                " branches." % command_name)
2437
 
        if start_spec.spec is None:
2438
 
            # Avoid loading all the history.
2439
 
            rev1 = RevisionInfo(branch, None, None)
2440
 
        else:
2441
 
            rev1 = start_spec.in_history(branch)
 
2367
        rev1 = start_spec.in_history(branch)
2442
2368
        # Avoid loading all of history when we know a missing
2443
2369
        # end of range means the last revision ...
2444
2370
        if end_spec.spec is None:
2473
2399
 
2474
2400
 
2475
2401
class cmd_touching_revisions(Command):
2476
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2402
    """Return revision-ids which affected a particular file.
2477
2403
 
2478
2404
    A more user-friendly interface is "bzr log FILE".
2479
2405
    """
2484
2410
    @display_command
2485
2411
    def run(self, filename):
2486
2412
        tree, relpath = WorkingTree.open_containing(filename)
 
2413
        b = tree.branch
2487
2414
        file_id = tree.path2id(relpath)
2488
 
        b = tree.branch
2489
 
        self.add_cleanup(b.lock_read().unlock)
2490
 
        touching_revs = log.find_touching_revisions(b, file_id)
2491
 
        for revno, revision_id, what in touching_revs:
 
2415
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2492
2416
            self.outf.write("%6d %s\n" % (revno, what))
2493
2417
 
2494
2418
 
2495
2419
class cmd_ls(Command):
2496
 
    __doc__ = """List files in a tree.
 
2420
    """List files in a tree.
2497
2421
    """
2498
2422
 
2499
2423
    _see_also = ['status', 'cat']
2547
2471
        if from_root:
2548
2472
            if relpath:
2549
2473
                prefix = relpath + '/'
2550
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2474
        elif fs_path != '.':
2551
2475
            prefix = fs_path + '/'
2552
2476
 
2553
2477
        if revision is not None or tree is None:
2561
2485
                view_str = views.view_display_str(view_files)
2562
2486
                note("Ignoring files outside view. View is %s" % view_str)
2563
2487
 
2564
 
        self.add_cleanup(tree.lock_read().unlock)
2565
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2566
 
            from_dir=relpath, recursive=recursive):
2567
 
            # Apply additional masking
2568
 
            if not all and not selection[fc]:
2569
 
                continue
2570
 
            if kind is not None and fkind != kind:
2571
 
                continue
2572
 
            if apply_view:
2573
 
                try:
2574
 
                    if relpath:
2575
 
                        fullpath = osutils.pathjoin(relpath, fp)
2576
 
                    else:
2577
 
                        fullpath = fp
2578
 
                    views.check_path_in_view(tree, fullpath)
2579
 
                except errors.FileOutsideView:
2580
 
                    continue
 
2488
        tree.lock_read()
 
2489
        try:
 
2490
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2491
                from_dir=relpath, recursive=recursive):
 
2492
                # Apply additional masking
 
2493
                if not all and not selection[fc]:
 
2494
                    continue
 
2495
                if kind is not None and fkind != kind:
 
2496
                    continue
 
2497
                if apply_view:
 
2498
                    try:
 
2499
                        if relpath:
 
2500
                            fullpath = osutils.pathjoin(relpath, fp)
 
2501
                        else:
 
2502
                            fullpath = fp
 
2503
                        views.check_path_in_view(tree, fullpath)
 
2504
                    except errors.FileOutsideView:
 
2505
                        continue
2581
2506
 
2582
 
            # Output the entry
2583
 
            if prefix:
2584
 
                fp = osutils.pathjoin(prefix, fp)
2585
 
            kindch = entry.kind_character()
2586
 
            outstring = fp + kindch
2587
 
            ui.ui_factory.clear_term()
2588
 
            if verbose:
2589
 
                outstring = '%-8s %s' % (fc, outstring)
2590
 
                if show_ids and fid is not None:
2591
 
                    outstring = "%-50s %s" % (outstring, fid)
2592
 
                self.outf.write(outstring + '\n')
2593
 
            elif null:
2594
 
                self.outf.write(fp + '\0')
2595
 
                if show_ids:
2596
 
                    if fid is not None:
2597
 
                        self.outf.write(fid)
2598
 
                    self.outf.write('\0')
2599
 
                self.outf.flush()
2600
 
            else:
2601
 
                if show_ids:
2602
 
                    if fid is not None:
2603
 
                        my_id = fid
2604
 
                    else:
2605
 
                        my_id = ''
2606
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2607
 
                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)
2608
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()
2609
2536
 
2610
2537
 
2611
2538
class cmd_unknowns(Command):
2612
 
    __doc__ = """List unknown files.
 
2539
    """List unknown files.
2613
2540
    """
2614
2541
 
2615
2542
    hidden = True
2622
2549
 
2623
2550
 
2624
2551
class cmd_ignore(Command):
2625
 
    __doc__ = """Ignore specified files or patterns.
 
2552
    """Ignore specified files or patterns.
2626
2553
 
2627
2554
    See ``bzr help patterns`` for details on the syntax of patterns.
2628
2555
 
2629
 
    If a .bzrignore file does not exist, the ignore command
2630
 
    will create one and add the specified files or patterns to the newly
2631
 
    created file. The ignore command will also automatically add the 
2632
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2633
 
    the use of the ignore command will require an explicit add command.
2634
 
 
2635
2556
    To remove patterns from the ignore list, edit the .bzrignore file.
2636
2557
    After adding, editing or deleting that file either indirectly by
2637
2558
    using this command or directly by using an editor, be sure to commit
2638
2559
    it.
2639
 
    
2640
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
 
    the global ignore file can be found in the application data directory as
2642
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
 
    Global ignores are not touched by this command. The global ignore file
2644
 
    can be edited directly using an editor.
2645
 
 
2646
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
 
    precedence over regular ignores.  Such exceptions are used to specify
2648
 
    files that should be versioned which would otherwise be ignored.
2649
 
    
2650
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
 
    precedence over the '!' exception patterns.
2652
2560
 
2653
2561
    Note: ignore patterns containing shell wildcards must be quoted from
2654
2562
    the shell on Unix.
2658
2566
 
2659
2567
            bzr ignore ./Makefile
2660
2568
 
2661
 
        Ignore .class files in all directories...::
 
2569
        Ignore class files in all directories::
2662
2570
 
2663
2571
            bzr ignore "*.class"
2664
2572
 
2665
 
        ...but do not ignore "special.class"::
2666
 
 
2667
 
            bzr ignore "!special.class"
2668
 
 
2669
2573
        Ignore .o files under the lib directory::
2670
2574
 
2671
2575
            bzr ignore "lib/**/*.o"
2677
2581
        Ignore everything but the "debian" toplevel directory::
2678
2582
 
2679
2583
            bzr ignore "RE:(?!debian/).*"
2680
 
        
2681
 
        Ignore everything except the "local" toplevel directory,
2682
 
        but always ignore "*~" autosave files, even under local/::
2683
 
        
2684
 
            bzr ignore "*"
2685
 
            bzr ignore "!./local"
2686
 
            bzr ignore "!!*~"
2687
2584
    """
2688
2585
 
2689
2586
    _see_also = ['status', 'ignored', 'patterns']
2690
2587
    takes_args = ['name_pattern*']
2691
2588
    takes_options = [
2692
 
        Option('default-rules',
2693
 
               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.')
2694
2591
        ]
2695
2592
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2593
    def run(self, name_pattern_list=None, old_default_rules=None):
2697
2594
        from bzrlib import ignores
2698
 
        if default_rules is not None:
2699
 
            # dump the default rules and exit
2700
 
            for pattern in ignores.USER_DEFAULTS:
2701
 
                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
2702
2599
            return
2703
2600
        if not name_pattern_list:
2704
2601
            raise errors.BzrCommandError("ignore requires at least one "
2705
 
                "NAME_PATTERN or --default-rules.")
 
2602
                                  "NAME_PATTERN or --old-default-rules")
2706
2603
        name_pattern_list = [globbing.normalize_pattern(p)
2707
2604
                             for p in name_pattern_list]
2708
2605
        for name_pattern in name_pattern_list:
2720
2617
            if id is not None:
2721
2618
                filename = entry[0]
2722
2619
                if ignored.match(filename):
2723
 
                    matches.append(filename)
 
2620
                    matches.append(filename.encode('utf-8'))
2724
2621
        tree.unlock()
2725
2622
        if len(matches) > 0:
2726
 
            self.outf.write("Warning: the following files are version controlled and"
2727
 
                  " match your ignore pattern:\n%s"
2728
 
                  "\nThese files will continue to be version controlled"
2729
 
                  " 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),)
2730
2627
 
2731
2628
 
2732
2629
class cmd_ignored(Command):
2733
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2630
    """List ignored files and the patterns that matched them.
2734
2631
 
2735
2632
    List all the ignored files and the ignore pattern that caused the file to
2736
2633
    be ignored.
2746
2643
    @display_command
2747
2644
    def run(self):
2748
2645
        tree = WorkingTree.open_containing(u'.')[0]
2749
 
        self.add_cleanup(tree.lock_read().unlock)
2750
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2751
 
            if file_class != 'I':
2752
 
                continue
2753
 
            ## XXX: Slightly inefficient since this was already calculated
2754
 
            pat = tree.is_ignored(path)
2755
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2646
        tree.lock_read()
 
2647
        try:
 
2648
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2649
                if file_class != 'I':
 
2650
                    continue
 
2651
                ## XXX: Slightly inefficient since this was already calculated
 
2652
                pat = tree.is_ignored(path)
 
2653
                self.outf.write('%-50s %s\n' % (path, pat))
 
2654
        finally:
 
2655
            tree.unlock()
2756
2656
 
2757
2657
 
2758
2658
class cmd_lookup_revision(Command):
2759
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2659
    """Lookup the revision-id from a revision-number
2760
2660
 
2761
2661
    :Examples:
2762
2662
        bzr lookup-revision 33
2769
2669
        try:
2770
2670
            revno = int(revno)
2771
2671
        except ValueError:
2772
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2773
 
                                         % revno)
2774
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2775
 
        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)
2776
2675
 
2777
2676
 
2778
2677
class cmd_export(Command):
2779
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2678
    """Export current or past revision to a destination directory or archive.
2780
2679
 
2781
2680
    If no revision is specified this exports the last committed revision.
2782
2681
 
2814
2713
        Option('root',
2815
2714
               type=str,
2816
2715
               help="Name of the root directory inside the exported file."),
2817
 
        Option('per-file-timestamps',
2818
 
               help='Set modification time of files to that of the last '
2819
 
                    'revision in which it was changed.'),
2820
2716
        ]
2821
2717
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2822
 
        root=None, filters=False, per_file_timestamps=False):
 
2718
        root=None, filters=False):
2823
2719
        from bzrlib.export import export
2824
2720
 
2825
2721
        if branch_or_subdir is None:
2832
2728
 
2833
2729
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2834
2730
        try:
2835
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2836
 
                   per_file_timestamps=per_file_timestamps)
 
2731
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2837
2732
        except errors.NoSuchExportFormat, e:
2838
2733
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2839
2734
 
2840
2735
 
2841
2736
class cmd_cat(Command):
2842
 
    __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.
2843
2738
 
2844
2739
    If no revision is nominated, the last revision is used.
2845
2740
 
2865
2760
                                         " one revision specifier")
2866
2761
        tree, branch, relpath = \
2867
2762
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2868
 
        self.add_cleanup(branch.lock_read().unlock)
2869
 
        return self._run(tree, branch, relpath, filename, revision,
2870
 
                         name_from_revision, filters)
 
2763
        branch.lock_read()
 
2764
        try:
 
2765
            return self._run(tree, branch, relpath, filename, revision,
 
2766
                             name_from_revision, filters)
 
2767
        finally:
 
2768
            branch.unlock()
2871
2769
 
2872
2770
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2873
2771
        filtered):
2874
2772
        if tree is None:
2875
2773
            tree = b.basis_tree()
2876
2774
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2877
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2878
2775
 
2879
2776
        old_file_id = rev_tree.path2id(relpath)
2880
2777
 
2915
2812
            chunks = content.splitlines(True)
2916
2813
            content = filtered_output_bytes(chunks, filters,
2917
2814
                ContentFilterContext(relpath, rev_tree))
2918
 
            self.cleanup_now()
2919
2815
            self.outf.writelines(content)
2920
2816
        else:
2921
 
            self.cleanup_now()
2922
2817
            self.outf.write(content)
2923
2818
 
2924
2819
 
2925
2820
class cmd_local_time_offset(Command):
2926
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2821
    """Show the offset in seconds from GMT to local time."""
2927
2822
    hidden = True
2928
2823
    @display_command
2929
2824
    def run(self):
2930
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2825
        print osutils.local_time_offset()
2931
2826
 
2932
2827
 
2933
2828
 
2934
2829
class cmd_commit(Command):
2935
 
    __doc__ = """Commit changes into a new revision.
 
2830
    """Commit changes into a new revision.
2936
2831
 
2937
2832
    An explanatory message needs to be given for each commit. This is
2938
2833
    often done by using the --message option (getting the message from the
3031
2926
             Option('strict',
3032
2927
                    help="Refuse to commit if there are unknown "
3033
2928
                    "files in the working tree."),
3034
 
             Option('commit-time', type=str,
3035
 
                    help="Manually set a commit time using commit date "
3036
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3037
2929
             ListOption('fixes', type=str,
3038
2930
                    help="Mark a bug as being fixed by this revision "
3039
2931
                         "(see \"bzr help bugs\")."),
3046
2938
                         "the master branch until a normal commit "
3047
2939
                         "is performed."
3048
2940
                    ),
3049
 
             Option('show-diff', short_name='p',
3050
 
                    help='When no message is supplied, show the diff along'
3051
 
                    ' 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.'),
3052
2944
             ]
3053
2945
    aliases = ['ci', 'checkin']
3054
2946
 
3073
2965
 
3074
2966
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3075
2967
            unchanged=False, strict=False, local=False, fixes=None,
3076
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2968
            author=None, show_diff=False, exclude=None):
3077
2969
        from bzrlib.errors import (
3078
2970
            PointlessCommit,
3079
2971
            ConflictsInTree,
3085
2977
            make_commit_message_template_encoded
3086
2978
        )
3087
2979
 
3088
 
        commit_stamp = offset = None
3089
 
        if commit_time is not None:
3090
 
            try:
3091
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3092
 
            except ValueError, e:
3093
 
                raise errors.BzrCommandError(
3094
 
                    "Could not parse --commit-time: " + str(e))
3095
 
 
3096
2980
        # TODO: Need a blackbox test for invoking the external editor; may be
3097
2981
        # slightly problematic to run this cross-platform.
3098
2982
 
3118
3002
        if local and not tree.branch.get_bound_location():
3119
3003
            raise errors.LocalRequiresBoundBranch()
3120
3004
 
3121
 
        if message is not None:
3122
 
            try:
3123
 
                file_exists = osutils.lexists(message)
3124
 
            except UnicodeError:
3125
 
                # The commit message contains unicode characters that can't be
3126
 
                # represented in the filesystem encoding, so that can't be a
3127
 
                # file.
3128
 
                file_exists = False
3129
 
            if file_exists:
3130
 
                warning_msg = (
3131
 
                    'The commit message is a file name: "%(f)s".\n'
3132
 
                    '(use --file "%(f)s" to take commit message from that file)'
3133
 
                    % { 'f': message })
3134
 
                ui.ui_factory.show_warning(warning_msg)
3135
 
            if '\r' in message:
3136
 
                message = message.replace('\r\n', '\n')
3137
 
                message = message.replace('\r', '\n')
3138
 
            if file:
3139
 
                raise errors.BzrCommandError(
3140
 
                    "please specify either --message or --file")
3141
 
 
3142
3005
        def get_message(commit_obj):
3143
3006
            """Callback to get commit message"""
3144
 
            if file:
3145
 
                my_message = codecs.open(
3146
 
                    file, 'rt', osutils.get_user_encoding()).read()
3147
 
            elif message is not None:
3148
 
                my_message = message
3149
 
            else:
3150
 
                # No message supplied: make one up.
3151
 
                # text is the status of the tree
3152
 
                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,
3153
3010
                        selected_list, diff=show_diff,
3154
3011
                        output_encoding=osutils.get_user_encoding())
3155
 
                # start_message is the template generated from hooks
3156
 
                # XXX: Warning - looks like hooks return unicode,
3157
 
                # make_commit_message_template_encoded returns user encoding.
3158
 
                # We probably want to be using edit_commit_message instead to
3159
 
                # avoid this.
3160
3012
                start_message = generate_commit_message_template(commit_obj)
3161
 
                my_message = edit_commit_message_encoded(text,
 
3013
                my_message = edit_commit_message_encoded(t,
3162
3014
                    start_message=start_message)
3163
3015
                if my_message is None:
3164
3016
                    raise errors.BzrCommandError("please specify a commit"
3165
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()
3166
3024
            if my_message == "":
3167
3025
                raise errors.BzrCommandError("empty commit message specified")
3168
3026
            return my_message
3169
3027
 
3170
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3171
 
        # but the command line should not do that.
3172
 
        if not selected_list:
3173
 
            selected_list = None
3174
3028
        try:
3175
3029
            tree.commit(message_callback=get_message,
3176
3030
                        specific_files=selected_list,
3177
3031
                        allow_pointless=unchanged, strict=strict, local=local,
3178
3032
                        reporter=None, verbose=verbose, revprops=properties,
3179
 
                        authors=author, timestamp=commit_stamp,
3180
 
                        timezone=offset,
 
3033
                        authors=author,
3181
3034
                        exclude=safe_relpath_files(tree, exclude))
3182
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
3183
3038
            raise errors.BzrCommandError("No changes to commit."
3184
3039
                              " Use --unchanged to commit anyhow.")
3185
3040
        except ConflictsInTree:
3190
3045
            raise errors.BzrCommandError("Commit refused because there are"
3191
3046
                              " unknown files in the working tree.")
3192
3047
        except errors.BoundBranchOutOfDate, e:
3193
 
            e.extra_help = ("\n"
3194
 
                'To commit to master branch, run update and then commit.\n'
3195
 
                'You can also pass --local to commit to continue working '
3196
 
                'disconnected.')
3197
 
            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.')
3198
3052
 
3199
3053
 
3200
3054
class cmd_check(Command):
3201
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3055
    """Validate working tree structure, branch consistency and repository history.
3202
3056
 
3203
3057
    This command checks various invariants about branch and repository storage
3204
3058
    to detect data corruption or bzr bugs.
3268
3122
 
3269
3123
 
3270
3124
class cmd_upgrade(Command):
3271
 
    __doc__ = """Upgrade branch storage to current format.
 
3125
    """Upgrade branch storage to current format.
3272
3126
 
3273
3127
    The check command or bzr developers may sometimes advise you to run
3274
3128
    this command. When the default format has changed you may also be warned
3292
3146
 
3293
3147
 
3294
3148
class cmd_whoami(Command):
3295
 
    __doc__ = """Show or set bzr user id.
 
3149
    """Show or set bzr user id.
3296
3150
 
3297
3151
    :Examples:
3298
3152
        Show the email of the current user::
3342
3196
 
3343
3197
 
3344
3198
class cmd_nick(Command):
3345
 
    __doc__ = """Print or set the branch nickname.
 
3199
    """Print or set the branch nickname.
3346
3200
 
3347
3201
    If unset, the tree root directory name is used as the nickname.
3348
3202
    To print the current nickname, execute with no argument.
3362
3216
 
3363
3217
    @display_command
3364
3218
    def printme(self, branch):
3365
 
        self.outf.write('%s\n' % branch.nick)
 
3219
        print branch.nick
3366
3220
 
3367
3221
 
3368
3222
class cmd_alias(Command):
3369
 
    __doc__ = """Set/unset and display aliases.
 
3223
    """Set/unset and display aliases.
3370
3224
 
3371
3225
    :Examples:
3372
3226
        Show the current aliases::
3436
3290
 
3437
3291
 
3438
3292
class cmd_selftest(Command):
3439
 
    __doc__ = """Run internal test suite.
 
3293
    """Run internal test suite.
3440
3294
 
3441
3295
    If arguments are given, they are regular expressions that say which tests
3442
3296
    should run.  Tests matching any expression are run, and other tests are
3469
3323
    Tests that need working space on disk use a common temporary directory,
3470
3324
    typically inside $TMPDIR or /tmp.
3471
3325
 
3472
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3473
 
    into a pdb postmortem session.
3474
 
 
3475
3326
    :Examples:
3476
3327
        Run only tests relating to 'ignore'::
3477
3328
 
3486
3337
    def get_transport_type(typestring):
3487
3338
        """Parse and return a transport specifier."""
3488
3339
        if typestring == "sftp":
3489
 
            from bzrlib.tests import stub_sftp
3490
 
            return stub_sftp.SFTPAbsoluteServer
 
3340
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3341
            return SFTPAbsoluteServer
3491
3342
        if typestring == "memory":
3492
 
            from bzrlib.tests import test_server
3493
 
            return memory.MemoryServer
 
3343
            from bzrlib.transport.memory import MemoryServer
 
3344
            return MemoryServer
3494
3345
        if typestring == "fakenfs":
3495
 
            from bzrlib.tests import test_server
3496
 
            return test_server.FakeNFSServer
 
3346
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3347
            return FakeNFSServer
3497
3348
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3498
3349
            (typestring)
3499
3350
        raise errors.BzrCommandError(msg)
3514
3365
                     Option('lsprof-timed',
3515
3366
                            help='Generate lsprof output for benchmarked'
3516
3367
                                 ' sections of code.'),
3517
 
                     Option('lsprof-tests',
3518
 
                            help='Generate lsprof output for each test.'),
3519
3368
                     Option('cache-dir', type=str,
3520
3369
                            help='Cache intermediate benchmark output in this '
3521
3370
                                 'directory.'),
3562
3411
            first=False, list_only=False,
3563
3412
            randomize=None, exclude=None, strict=False,
3564
3413
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3565
 
            parallel=None, lsprof_tests=False):
 
3414
            parallel=None):
3566
3415
        from bzrlib.tests import selftest
3567
3416
        import bzrlib.benchmarks as benchmarks
3568
3417
        from bzrlib.benchmarks import tree_creator
3583
3432
                raise errors.BzrCommandError("subunit not available. subunit "
3584
3433
                    "needs to be installed to use --subunit.")
3585
3434
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
 
            # stdout, which would corrupt the subunit stream. 
3588
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3589
 
                import msvcrt
3590
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3591
3435
        if parallel:
3592
3436
            self.additional_selftest_args.setdefault(
3593
3437
                'suite_decorators', []).append(parallel)
3597
3441
            verbose = not is_quiet()
3598
3442
            # TODO: should possibly lock the history file...
3599
3443
            benchfile = open(".perf_history", "at", buffering=1)
3600
 
            self.add_cleanup(benchfile.close)
3601
3444
        else:
3602
3445
            test_suite_factory = None
3603
3446
            benchfile = None
3604
 
        selftest_kwargs = {"verbose": verbose,
3605
 
                          "pattern": pattern,
3606
 
                          "stop_on_failure": one,
3607
 
                          "transport": transport,
3608
 
                          "test_suite_factory": test_suite_factory,
3609
 
                          "lsprof_timed": lsprof_timed,
3610
 
                          "lsprof_tests": lsprof_tests,
3611
 
                          "bench_history": benchfile,
3612
 
                          "matching_tests_first": first,
3613
 
                          "list_only": list_only,
3614
 
                          "random_seed": randomize,
3615
 
                          "exclude_pattern": exclude,
3616
 
                          "strict": strict,
3617
 
                          "load_list": load_list,
3618
 
                          "debug_flags": debugflag,
3619
 
                          "starting_with": starting_with
3620
 
                          }
3621
 
        selftest_kwargs.update(self.additional_selftest_args)
3622
 
        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()
3623
3469
        return int(not result)
3624
3470
 
3625
3471
 
3626
3472
class cmd_version(Command):
3627
 
    __doc__ = """Show version of bzr."""
 
3473
    """Show version of bzr."""
3628
3474
 
3629
3475
    encoding_type = 'replace'
3630
3476
    takes_options = [
3641
3487
 
3642
3488
 
3643
3489
class cmd_rocks(Command):
3644
 
    __doc__ = """Statement of optimism."""
 
3490
    """Statement of optimism."""
3645
3491
 
3646
3492
    hidden = True
3647
3493
 
3648
3494
    @display_command
3649
3495
    def run(self):
3650
 
        self.outf.write("It sure does!\n")
 
3496
        print "It sure does!"
3651
3497
 
3652
3498
 
3653
3499
class cmd_find_merge_base(Command):
3654
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3500
    """Find and print a base revision for merging two branches."""
3655
3501
    # TODO: Options to specify revisions on either side, as if
3656
3502
    #       merging only part of the history.
3657
3503
    takes_args = ['branch', 'other']
3663
3509
 
3664
3510
        branch1 = Branch.open_containing(branch)[0]
3665
3511
        branch2 = Branch.open_containing(other)[0]
3666
 
        self.add_cleanup(branch1.lock_read().unlock)
3667
 
        self.add_cleanup(branch2.lock_read().unlock)
3668
 
        last1 = ensure_null(branch1.last_revision())
3669
 
        last2 = ensure_null(branch2.last_revision())
3670
 
 
3671
 
        graph = branch1.repository.get_graph(branch2.repository)
3672
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3673
 
 
3674
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3512
        branch1.lock_read()
 
3513
        try:
 
3514
            branch2.lock_read()
 
3515
            try:
 
3516
                last1 = ensure_null(branch1.last_revision())
 
3517
                last2 = ensure_null(branch2.last_revision())
 
3518
 
 
3519
                graph = branch1.repository.get_graph(branch2.repository)
 
3520
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3521
 
 
3522
                print 'merge base is revision %s' % base_rev_id
 
3523
            finally:
 
3524
                branch2.unlock()
 
3525
        finally:
 
3526
            branch1.unlock()
3675
3527
 
3676
3528
 
3677
3529
class cmd_merge(Command):
3678
 
    __doc__ = """Perform a three-way merge.
 
3530
    """Perform a three-way merge.
3679
3531
 
3680
3532
    The source of the merge can be specified either in the form of a branch,
3681
3533
    or in the form of a path to a file containing a merge directive generated
3710
3562
    committed to record the result of the merge.
3711
3563
 
3712
3564
    merge refuses to run if there are any uncommitted changes, unless
3713
 
    --force is given. The --force option can also be used to create a
3714
 
    merge revision which has more than two parents.
3715
 
 
3716
 
    If one would like to merge changes from the working tree of the other
3717
 
    branch without merging any committed revisions, the --uncommitted option
3718
 
    can be given.
 
3565
    --force is given.
3719
3566
 
3720
3567
    To select only some changes to merge, use "merge -i", which will prompt
3721
3568
    you to apply each diff hunk and file change, similar to "shelve".
3733
3580
 
3734
3581
            bzr merge -r 81..82 ../bzr.dev
3735
3582
 
3736
 
        To apply a merge directive contained in /tmp/merge::
 
3583
        To apply a merge directive contained in /tmp/merge:
3737
3584
 
3738
3585
            bzr merge /tmp/merge
3739
 
 
3740
 
        To create a merge revision with three parents from two branches
3741
 
        feature1a and feature1b:
3742
 
 
3743
 
            bzr merge ../feature1a
3744
 
            bzr merge ../feature1b --force
3745
 
            bzr commit -m 'revision with three parents'
3746
3586
    """
3747
3587
 
3748
3588
    encoding_type = 'exact'
3793
3633
        verified = 'inapplicable'
3794
3634
        tree = WorkingTree.open_containing(directory)[0]
3795
3635
 
 
3636
        # die as quickly as possible if there are uncommitted changes
3796
3637
        try:
3797
3638
            basis_tree = tree.revision_tree(tree.last_revision())
3798
3639
        except errors.NoSuchRevision:
3799
3640
            basis_tree = tree.basis_tree()
3800
 
 
3801
 
        # die as quickly as possible if there are uncommitted changes
3802
3641
        if not force:
3803
 
            if tree.has_changes():
 
3642
            if tree.has_changes(basis_tree):
3804
3643
                raise errors.UncommittedChanges(tree)
3805
3644
 
3806
3645
        view_info = _get_view_info_for_change_reporter(tree)
3807
3646
        change_reporter = delta._ChangeReporter(
3808
3647
            unversioned_filter=tree.is_ignored, view_info=view_info)
3809
 
        pb = ui.ui_factory.nested_progress_bar()
3810
 
        self.add_cleanup(pb.finished)
3811
 
        self.add_cleanup(tree.lock_write().unlock)
3812
 
        if location is not None:
3813
 
            try:
3814
 
                mergeable = bundle.read_mergeable_from_url(location,
3815
 
                    possible_transports=possible_transports)
3816
 
            except errors.NotABundle:
3817
 
                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)
3818
3704
            else:
3819
 
                if uncommitted:
3820
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3821
 
                        ' with bundles or merge directives.')
3822
 
 
3823
 
                if revision is not None:
3824
 
                    raise errors.BzrCommandError(
3825
 
                        'Cannot use -r with merge directives or bundles')
3826
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3827
 
                   mergeable, None)
3828
 
 
3829
 
        if merger is None and uncommitted:
3830
 
            if revision is not None and len(revision) > 0:
3831
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3832
 
                    ' --revision at the same time.')
3833
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3834
 
            allow_pending = False
3835
 
 
3836
 
        if merger is None:
3837
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3838
 
                location, revision, remember, possible_transports, None)
3839
 
 
3840
 
        merger.merge_type = merge_type
3841
 
        merger.reprocess = reprocess
3842
 
        merger.show_base = show_base
3843
 
        self.sanity_check_merger(merger)
3844
 
        if (merger.base_rev_id == merger.other_rev_id and
3845
 
            merger.other_rev_id is not None):
3846
 
            note('Nothing to do.')
3847
 
            return 0
3848
 
        if pull:
3849
 
            if merger.interesting_files is not None:
3850
 
                raise errors.BzrCommandError('Cannot pull individual files')
3851
 
            if (merger.base_rev_id == tree.last_revision()):
3852
 
                result = tree.pull(merger.other_branch, False,
3853
 
                                   merger.other_rev_id)
3854
 
                result.report(self.outf)
3855
 
                return 0
3856
 
        if merger.this_basis is None:
3857
 
            raise errors.BzrCommandError(
3858
 
                "This branch has no commits."
3859
 
                " (perhaps you would prefer 'bzr pull')")
3860
 
        if preview:
3861
 
            return self._do_preview(merger)
3862
 
        elif interactive:
3863
 
            return self._do_interactive(merger)
3864
 
        else:
3865
 
            return self._do_merge(merger, change_reporter, allow_pending,
3866
 
                                  verified)
3867
 
 
3868
 
    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):
3869
3712
        tree_merger = merger.make_merger()
3870
3713
        tt = tree_merger.make_preview_transform()
3871
 
        self.add_cleanup(tt.finalize)
 
3714
        cleanups.append(tt.finalize)
3872
3715
        result_tree = tt.get_preview_tree()
3873
3716
        return result_tree
3874
3717
 
3875
 
    def _do_preview(self, merger):
 
3718
    def _do_preview(self, merger, cleanups):
3876
3719
        from bzrlib.diff import show_diff_trees
3877
 
        result_tree = self._get_preview(merger)
 
3720
        result_tree = self._get_preview(merger, cleanups)
3878
3721
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3879
3722
                        old_label='', new_label='')
3880
3723
 
3890
3733
        else:
3891
3734
            return 0
3892
3735
 
3893
 
    def _do_interactive(self, merger):
 
3736
    def _do_interactive(self, merger, cleanups):
3894
3737
        """Perform an interactive merge.
3895
3738
 
3896
3739
        This works by generating a preview tree of the merge, then using
3898
3741
        and the preview tree.
3899
3742
        """
3900
3743
        from bzrlib import shelf_ui
3901
 
        result_tree = self._get_preview(merger)
 
3744
        result_tree = self._get_preview(merger, cleanups)
3902
3745
        writer = bzrlib.option.diff_writer_registry.get()
3903
3746
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3904
3747
                                   reporter=shelf_ui.ApplyReporter(),
3905
3748
                                   diff_writer=writer(sys.stdout))
3906
 
        try:
3907
 
            shelver.run()
3908
 
        finally:
3909
 
            shelver.finalize()
 
3749
        shelver.run()
3910
3750
 
3911
3751
    def sanity_check_merger(self, merger):
3912
3752
        if (merger.show_base and
3972
3812
            allow_pending = True
3973
3813
        return merger, allow_pending
3974
3814
 
3975
 
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3815
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3976
3816
        """Get a merger for uncommitted changes.
3977
3817
 
3978
3818
        :param tree: The tree the merger should apply to.
3979
3819
        :param location: The location containing uncommitted changes.
3980
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.
3981
3823
        """
3982
3824
        location = self._select_branch_location(tree, location)[0]
3983
3825
        other_tree, other_path = WorkingTree.open_containing(location)
4035
3877
 
4036
3878
 
4037
3879
class cmd_remerge(Command):
4038
 
    __doc__ = """Redo a merge.
 
3880
    """Redo a merge.
4039
3881
 
4040
3882
    Use this if you want to try a different merge technique while resolving
4041
3883
    conflicts.  Some merge techniques are better than others, and remerge
4066
3908
 
4067
3909
    def run(self, file_list=None, merge_type=None, show_base=False,
4068
3910
            reprocess=False):
4069
 
        from bzrlib.conflicts import restore
4070
3911
        if merge_type is None:
4071
3912
            merge_type = _mod_merge.Merge3Merger
4072
3913
        tree, file_list = tree_files(file_list)
4073
 
        self.add_cleanup(tree.lock_write().unlock)
4074
 
        parents = tree.get_parent_ids()
4075
 
        if len(parents) != 2:
4076
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4077
 
                                         " merges.  Not cherrypicking or"
4078
 
                                         " multi-merges.")
4079
 
        repository = tree.branch.repository
4080
 
        interesting_ids = None
4081
 
        new_conflicts = []
4082
 
        conflicts = tree.conflicts()
4083
 
        if file_list is not None:
4084
 
            interesting_ids = set()
4085
 
            for filename in file_list:
4086
 
                file_id = tree.path2id(filename)
4087
 
                if file_id is None:
4088
 
                    raise errors.NotVersionedError(filename)
4089
 
                interesting_ids.add(file_id)
4090
 
                if tree.kind(file_id) != "directory":
4091
 
                    continue
 
3914
        tree.lock_write()
 
3915
        try:
 
3916
            parents = tree.get_parent_ids()
 
3917
            if len(parents) != 2:
 
3918
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3919
                                             " merges.  Not cherrypicking or"
 
3920
                                             " multi-merges.")
 
3921
            repository = tree.branch.repository
 
3922
            interesting_ids = None
 
3923
            new_conflicts = []
 
3924
            conflicts = tree.conflicts()
 
3925
            if file_list is not None:
 
3926
                interesting_ids = set()
 
3927
                for filename in file_list:
 
3928
                    file_id = tree.path2id(filename)
 
3929
                    if file_id is None:
 
3930
                        raise errors.NotVersionedError(filename)
 
3931
                    interesting_ids.add(file_id)
 
3932
                    if tree.kind(file_id) != "directory":
 
3933
                        continue
4092
3934
 
4093
 
                for name, ie in tree.inventory.iter_entries(file_id):
4094
 
                    interesting_ids.add(ie.file_id)
4095
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4096
 
        else:
4097
 
            # Remerge only supports resolving contents conflicts
4098
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4099
 
            restore_files = [c.path for c in conflicts
4100
 
                             if c.typestring in allowed_conflicts]
4101
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4102
 
        tree.set_conflicts(ConflictList(new_conflicts))
4103
 
        if file_list is not None:
4104
 
            restore_files = file_list
4105
 
        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])
4106
3959
            try:
4107
 
                restore(tree.abspath(filename))
4108
 
            except errors.NotConflicted:
4109
 
                pass
4110
 
        # Disable pending merges, because the file texts we are remerging
4111
 
        # have not had those merges performed.  If we use the wrong parents
4112
 
        # list, we imply that the working tree text has seen and rejected
4113
 
        # all the changes from the other tree, when in fact those changes
4114
 
        # have not yet been seen.
4115
 
        tree.set_parent_ids(parents[:1])
4116
 
        try:
4117
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4118
 
            merger.interesting_ids = interesting_ids
4119
 
            merger.merge_type = merge_type
4120
 
            merger.show_base = show_base
4121
 
            merger.reprocess = reprocess
4122
 
            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()
4123
3970
        finally:
4124
 
            tree.set_parent_ids(parents)
 
3971
            tree.unlock()
4125
3972
        if conflicts > 0:
4126
3973
            return 1
4127
3974
        else:
4129
3976
 
4130
3977
 
4131
3978
class cmd_revert(Command):
4132
 
    __doc__ = """Revert files to a previous revision.
 
3979
    """Revert files to a previous revision.
4133
3980
 
4134
3981
    Giving a list of files will revert only those files.  Otherwise, all files
4135
3982
    will be reverted.  If the revision is not specified with '--revision', the
4149
3996
    name.  If you name a directory, all the contents of that directory will be
4150
3997
    reverted.
4151
3998
 
4152
 
    If you have newly added files since the target revision, they will be
4153
 
    removed.  If the files to be removed have been changed, backups will be
4154
 
    created as above.  Directories containing unknown files will not be
4155
 
    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.
4156
4002
 
4157
 
    The working tree contains a list of revisions that have been merged but
4158
 
    not yet committed. These revisions will be included as additional parents
4159
 
    of the next commit.  Normally, using revert clears that list as well as
4160
 
    reverting the files.  If any files are specified, revert leaves the list
4161
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4162
 
    .`` in the tree root to revert all files but keep the recorded merges,
4163
 
    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
4164
4009
    reverting any files.
4165
 
 
4166
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4167
 
    changes from a branch in a single revision.  To do this, perform the merge
4168
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4169
 
    the content of the tree as it was, but it will clear the list of pending
4170
 
    merges.  The next commit will then contain all of the changes that are
4171
 
    present in the other branch, but without any other parent revisions.
4172
 
    Because this technique forgets where these changes originated, it may
4173
 
    cause additional conflicts on later merges involving the same source and
4174
 
    target branches.
4175
4010
    """
4176
4011
 
4177
4012
    _see_also = ['cat', 'export']
4186
4021
    def run(self, revision=None, no_backup=False, file_list=None,
4187
4022
            forget_merges=None):
4188
4023
        tree, file_list = tree_files(file_list)
4189
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4190
 
        if forget_merges:
4191
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4192
 
        else:
4193
 
            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()
4194
4032
 
4195
4033
    @staticmethod
4196
4034
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4197
4035
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4198
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4199
 
            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()
4200
4042
 
4201
4043
 
4202
4044
class cmd_assert_fail(Command):
4203
 
    __doc__ = """Test reporting of assertion failures"""
 
4045
    """Test reporting of assertion failures"""
4204
4046
    # intended just for use in testing
4205
4047
 
4206
4048
    hidden = True
4210
4052
 
4211
4053
 
4212
4054
class cmd_help(Command):
4213
 
    __doc__ = """Show help on a command or other topic.
 
4055
    """Show help on a command or other topic.
4214
4056
    """
4215
4057
 
4216
4058
    _see_also = ['topics']
4229
4071
 
4230
4072
 
4231
4073
class cmd_shell_complete(Command):
4232
 
    __doc__ = """Show appropriate completions for context.
 
4074
    """Show appropriate completions for context.
4233
4075
 
4234
4076
    For a list of all available commands, say 'bzr shell-complete'.
4235
4077
    """
4244
4086
 
4245
4087
 
4246
4088
class cmd_missing(Command):
4247
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4089
    """Show unmerged/unpulled revisions between two branches.
4248
4090
 
4249
4091
    OTHER_BRANCH may be local or remote.
4250
4092
 
4251
4093
    To filter on a range of revisions, you can use the command -r begin..end
4252
4094
    -r revision requests a specific revision, -r ..end or -r begin.. are
4253
4095
    also valid.
4254
 
            
4255
 
    :Exit values:
4256
 
        1 - some missing revisions
4257
 
        0 - no missing revisions
4258
4096
 
4259
4097
    :Examples:
4260
4098
 
4328
4166
            restrict = 'remote'
4329
4167
 
4330
4168
        local_branch = Branch.open_containing(u".")[0]
4331
 
        self.add_cleanup(local_branch.lock_read().unlock)
4332
 
 
4333
4169
        parent = local_branch.get_parent()
4334
4170
        if other_branch is None:
4335
4171
            other_branch = parent
4344
4180
        remote_branch = Branch.open(other_branch)
4345
4181
        if remote_branch.base == local_branch.base:
4346
4182
            remote_branch = local_branch
4347
 
        else:
4348
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4349
4183
 
4350
4184
        local_revid_range = _revision_range_to_revid_range(
4351
4185
            _get_revision_range(my_revision, local_branch,
4355
4189
            _get_revision_range(revision,
4356
4190
                remote_branch, self.name()))
4357
4191
 
4358
 
        local_extra, remote_extra = find_unmerged(
4359
 
            local_branch, remote_branch, restrict,
4360
 
            backward=not reverse,
4361
 
            include_merges=include_merges,
4362
 
            local_revid_range=local_revid_range,
4363
 
            remote_revid_range=remote_revid_range)
4364
 
 
4365
 
        if log_format is None:
4366
 
            registry = log.log_formatter_registry
4367
 
            log_format = registry.get_default(local_branch)
4368
 
        lf = log_format(to_file=self.outf,
4369
 
                        show_ids=show_ids,
4370
 
                        show_timezone='original')
4371
 
 
4372
 
        status_code = 0
4373
 
        if local_extra and not theirs_only:
4374
 
            message("You have %d extra revision(s):\n" %
4375
 
                len(local_extra))
4376
 
            for revision in iter_log_revisions(local_extra,
4377
 
                                local_branch.repository,
4378
 
                                verbose):
4379
 
                lf.log_revision(revision)
4380
 
            printed_local = True
4381
 
            status_code = 1
4382
 
        else:
4383
 
            printed_local = False
4384
 
 
4385
 
        if remote_extra and not mine_only:
4386
 
            if printed_local is True:
4387
 
                message("\n\n\n")
4388
 
            message("You are missing %d revision(s):\n" %
4389
 
                len(remote_extra))
4390
 
            for revision in iter_log_revisions(remote_extra,
4391
 
                                remote_branch.repository,
4392
 
                                verbose):
4393
 
                lf.log_revision(revision)
4394
 
            status_code = 1
4395
 
 
4396
 
        if mine_only and not local_extra:
4397
 
            # We checked local, and found nothing extra
4398
 
            message('This branch is up to date.\n')
4399
 
        elif theirs_only and not remote_extra:
4400
 
            # We checked remote, and found nothing extra
4401
 
            message('Other branch is up to date.\n')
4402
 
        elif not (mine_only or theirs_only or local_extra or
4403
 
                  remote_extra):
4404
 
            # We checked both branches, and neither one had extra
4405
 
            # revisions
4406
 
            message("Branches are up to date.\n")
4407
 
        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()
4408
4249
        if not status_code and parent is None and other_branch is not None:
4409
 
            self.add_cleanup(local_branch.lock_write().unlock)
4410
 
            # handle race conditions - a parent might be set while we run.
4411
 
            if local_branch.get_parent() is None:
4412
 
                local_branch.set_parent(remote_branch.base)
 
4250
            local_branch.lock_write()
 
4251
            try:
 
4252
                # handle race conditions - a parent might be set while we run.
 
4253
                if local_branch.get_parent() is None:
 
4254
                    local_branch.set_parent(remote_branch.base)
 
4255
            finally:
 
4256
                local_branch.unlock()
4413
4257
        return status_code
4414
4258
 
4415
4259
 
4416
4260
class cmd_pack(Command):
4417
 
    __doc__ = """Compress the data within a repository.
4418
 
 
4419
 
    This operation compresses the data within a bazaar repository. As
4420
 
    bazaar supports automatic packing of repository, this operation is
4421
 
    normally not required to be done manually.
4422
 
 
4423
 
    During the pack operation, bazaar takes a backup of existing repository
4424
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4425
 
    automatically when it is safe to do so. To save disk space by removing
4426
 
    the backed up pack files, the --clean-obsolete-packs option may be
4427
 
    used.
4428
 
 
4429
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4430
 
    during or immediately after repacking, you may be left with a state
4431
 
    where the deletion has been written to disk but the new packs have not
4432
 
    been. In this case the repository may be unusable.
4433
 
    """
 
4261
    """Compress the data within a repository."""
4434
4262
 
4435
4263
    _see_also = ['repositories']
4436
4264
    takes_args = ['branch_or_repo?']
4437
 
    takes_options = [
4438
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4439
 
        ]
4440
4265
 
4441
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4266
    def run(self, branch_or_repo='.'):
4442
4267
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4443
4268
        try:
4444
4269
            branch = dir.open_branch()
4445
4270
            repository = branch.repository
4446
4271
        except errors.NotBranchError:
4447
4272
            repository = dir.open_repository()
4448
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4273
        repository.pack()
4449
4274
 
4450
4275
 
4451
4276
class cmd_plugins(Command):
4452
 
    __doc__ = """List the installed plugins.
 
4277
    """List the installed plugins.
4453
4278
 
4454
4279
    This command displays the list of installed plugins including
4455
4280
    version of plugin and a short description of each.
4462
4287
    adding new commands, providing additional network transports and
4463
4288
    customizing log output.
4464
4289
 
4465
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4466
 
    for further information on plugins including where to find them and how to
4467
 
    install them. Instructions are also provided there on how to write new
4468
 
    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.
4469
4294
    """
4470
4295
    takes_options = ['verbose']
4471
4296
 
4486
4311
                doc = '(no description)'
4487
4312
            result.append((name_ver, doc, plugin.path()))
4488
4313
        for name_ver, doc, path in sorted(result):
4489
 
            self.outf.write("%s\n" % name_ver)
4490
 
            self.outf.write("   %s\n" % doc)
 
4314
            print name_ver
 
4315
            print '   ', doc
4491
4316
            if verbose:
4492
 
                self.outf.write("   %s\n" % path)
4493
 
            self.outf.write("\n")
 
4317
                print '   ', path
 
4318
            print
4494
4319
 
4495
4320
 
4496
4321
class cmd_testament(Command):
4497
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4322
    """Show testament (signing-form) of a revision."""
4498
4323
    takes_options = [
4499
4324
            'revision',
4500
4325
            Option('long', help='Produce long-format testament.'),
4512
4337
            b = Branch.open_containing(branch)[0]
4513
4338
        else:
4514
4339
            b = Branch.open(branch)
4515
 
        self.add_cleanup(b.lock_read().unlock)
4516
 
        if revision is None:
4517
 
            rev_id = b.last_revision()
4518
 
        else:
4519
 
            rev_id = revision[0].as_revision_id(b)
4520
 
        t = testament_class.from_revision(b.repository, rev_id)
4521
 
        if long:
4522
 
            sys.stdout.writelines(t.as_text_lines())
4523
 
        else:
4524
 
            sys.stdout.write(t.as_short_text())
 
4340
        b.lock_read()
 
4341
        try:
 
4342
            if revision is None:
 
4343
                rev_id = b.last_revision()
 
4344
            else:
 
4345
                rev_id = revision[0].as_revision_id(b)
 
4346
            t = testament_class.from_revision(b.repository, rev_id)
 
4347
            if long:
 
4348
                sys.stdout.writelines(t.as_text_lines())
 
4349
            else:
 
4350
                sys.stdout.write(t.as_short_text())
 
4351
        finally:
 
4352
            b.unlock()
4525
4353
 
4526
4354
 
4527
4355
class cmd_annotate(Command):
4528
 
    __doc__ = """Show the origin of each line in a file.
 
4356
    """Show the origin of each line in a file.
4529
4357
 
4530
4358
    This prints out the given file with an annotation on the left side
4531
4359
    indicating which revision, author and date introduced the change.
4552
4380
        wt, branch, relpath = \
4553
4381
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4554
4382
        if wt is not None:
4555
 
            self.add_cleanup(wt.lock_read().unlock)
4556
 
        else:
4557
 
            self.add_cleanup(branch.lock_read().unlock)
4558
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4559
 
        self.add_cleanup(tree.lock_read().unlock)
4560
 
        if wt is not None:
4561
 
            file_id = wt.path2id(relpath)
4562
 
        else:
4563
 
            file_id = tree.path2id(relpath)
4564
 
        if file_id is None:
4565
 
            raise errors.NotVersionedError(filename)
4566
 
        file_version = tree.inventory[file_id].revision
4567
 
        if wt is not None and revision is None:
4568
 
            # If there is a tree and we're not annotating historical
4569
 
            # versions, annotate the working tree's content.
4570
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4571
 
                show_ids=show_ids)
4572
 
        else:
4573
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4574
 
                          show_ids=show_ids)
 
4383
            wt.lock_read()
 
4384
        else:
 
4385
            branch.lock_read()
 
4386
        try:
 
4387
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4388
            if wt is not None:
 
4389
                file_id = wt.path2id(relpath)
 
4390
            else:
 
4391
                file_id = tree.path2id(relpath)
 
4392
            if file_id is None:
 
4393
                raise errors.NotVersionedError(filename)
 
4394
            file_version = tree.inventory[file_id].revision
 
4395
            if wt is not None and revision is None:
 
4396
                # If there is a tree and we're not annotating historical
 
4397
                # versions, annotate the working tree's content.
 
4398
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4399
                    show_ids=show_ids)
 
4400
            else:
 
4401
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4402
                              show_ids=show_ids)
 
4403
        finally:
 
4404
            if wt is not None:
 
4405
                wt.unlock()
 
4406
            else:
 
4407
                branch.unlock()
4575
4408
 
4576
4409
 
4577
4410
class cmd_re_sign(Command):
4578
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4411
    """Create a digital signature for an existing revision."""
4579
4412
    # TODO be able to replace existing ones.
4580
4413
 
4581
4414
    hidden = True # is this right ?
4588
4421
        if revision_id_list is None and revision is None:
4589
4422
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
4423
        b = WorkingTree.open_containing(u'.')[0].branch
4591
 
        self.add_cleanup(b.lock_write().unlock)
4592
 
        return self._run(b, revision_id_list, revision)
 
4424
        b.lock_write()
 
4425
        try:
 
4426
            return self._run(b, revision_id_list, revision)
 
4427
        finally:
 
4428
            b.unlock()
4593
4429
 
4594
4430
    def _run(self, b, revision_id_list, revision):
4595
4431
        import bzrlib.gpg as gpg
4640
4476
 
4641
4477
 
4642
4478
class cmd_bind(Command):
4643
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4644
 
    If no branch is supplied, rebind to the last bound location.
 
4479
    """Convert the current branch into a checkout of the supplied branch.
4645
4480
 
4646
4481
    Once converted into a checkout, commits must succeed on the master branch
4647
4482
    before they will be applied to the local branch.
4648
4483
 
4649
4484
    Bound branches use the nickname of its master branch unless it is set
4650
 
    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
4651
4486
    that of the master.
4652
4487
    """
4653
4488
 
4665
4500
                    'This format does not remember old locations.')
4666
4501
            else:
4667
4502
                if location is None:
4668
 
                    if b.get_bound_location() is not None:
4669
 
                        raise errors.BzrCommandError('Branch is already bound')
4670
 
                    else:
4671
 
                        raise errors.BzrCommandError('No location supplied '
4672
 
                            'and no previous location known')
 
4503
                    raise errors.BzrCommandError('No location supplied and no '
 
4504
                        'previous location known')
4673
4505
        b_other = Branch.open(location)
4674
4506
        try:
4675
4507
            b.bind(b_other)
4681
4513
 
4682
4514
 
4683
4515
class cmd_unbind(Command):
4684
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4516
    """Convert the current checkout into a regular branch.
4685
4517
 
4686
4518
    After unbinding, the local branch is considered independent and subsequent
4687
4519
    commits will be local only.
4698
4530
 
4699
4531
 
4700
4532
class cmd_uncommit(Command):
4701
 
    __doc__ = """Remove the last committed revision.
 
4533
    """Remove the last committed revision.
4702
4534
 
4703
4535
    --verbose will print out what is being removed.
4704
4536
    --dry-run will go through all the motions, but not actually
4744
4576
            b = control.open_branch()
4745
4577
 
4746
4578
        if tree is not None:
4747
 
            self.add_cleanup(tree.lock_write().unlock)
 
4579
            tree.lock_write()
4748
4580
        else:
4749
 
            self.add_cleanup(b.lock_write().unlock)
4750
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4581
            b.lock_write()
 
4582
        try:
 
4583
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4584
                             local=local)
 
4585
        finally:
 
4586
            if tree is not None:
 
4587
                tree.unlock()
 
4588
            else:
 
4589
                b.unlock()
4751
4590
 
4752
4591
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4753
4592
        from bzrlib.log import log_formatter, show_log
4785
4624
                 end_revision=last_revno)
4786
4625
 
4787
4626
        if dry_run:
4788
 
            self.outf.write('Dry-run, pretending to remove'
4789
 
                            ' 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')
4790
4630
        else:
4791
 
            self.outf.write('The above revision(s) will be removed.\n')
4792
 
 
4793
 
        if not force:
4794
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4795
 
                self.outf.write('Canceled')
4796
 
                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
4797
4637
 
4798
4638
        mutter('Uncommitting from {%s} to {%s}',
4799
4639
               last_rev_id, rev_id)
4800
4640
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4801
4641
                 revno=revno, local=local)
4802
 
        self.outf.write('You can restore the old tip by running:\n'
4803
 
             '  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)
4804
4644
 
4805
4645
 
4806
4646
class cmd_break_lock(Command):
4807
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4647
    """Break a dead lock on a repository, branch or working directory.
4808
4648
 
4809
4649
    CAUTION: Locks should only be broken when you are sure that the process
4810
4650
    holding the lock has been stopped.
4811
4651
 
4812
 
    You can get information on what locks are open via the 'bzr info
4813
 
    [location]' command.
 
4652
    You can get information on what locks are open via the 'bzr info' command.
4814
4653
 
4815
4654
    :Examples:
4816
4655
        bzr break-lock
4817
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4818
4656
    """
4819
4657
    takes_args = ['location?']
4820
4658
 
4829
4667
 
4830
4668
 
4831
4669
class cmd_wait_until_signalled(Command):
4832
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4670
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4833
4671
 
4834
4672
    This just prints a line to signal when it is ready, then blocks on stdin.
4835
4673
    """
4843
4681
 
4844
4682
 
4845
4683
class cmd_serve(Command):
4846
 
    __doc__ = """Run the bzr server."""
 
4684
    """Run the bzr server."""
4847
4685
 
4848
4686
    aliases = ['server']
4849
4687
 
4850
4688
    takes_options = [
4851
4689
        Option('inet',
4852
4690
               help='Serve on stdin/out for use from inetd or sshd.'),
4853
 
        RegistryOption('protocol',
4854
 
               help="Protocol to serve.",
 
4691
        RegistryOption('protocol', 
 
4692
               help="Protocol to serve.", 
4855
4693
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4856
4694
               value_switches=True),
4857
4695
        Option('port',
4866
4704
        Option('allow-writes',
4867
4705
               help='By default the server is a readonly server.  Supplying '
4868
4706
                    '--allow-writes enables write access to the contents of '
4869
 
                    'the served directory and below.  Note that ``bzr serve`` '
4870
 
                    'does not perform authentication, so unless some form of '
4871
 
                    'external authentication is arranged supplying this '
4872
 
                    'option leads to global uncontrolled write access to your '
4873
 
                    'file system.'
 
4707
                    'the served directory and below.'
4874
4708
                ),
4875
4709
        ]
4876
4710
 
4909
4743
 
4910
4744
 
4911
4745
class cmd_join(Command):
4912
 
    __doc__ = """Combine a tree into its containing tree.
 
4746
    """Combine a tree into its containing tree.
4913
4747
 
4914
4748
    This command requires the target tree to be in a rich-root format.
4915
4749
 
4955
4789
 
4956
4790
 
4957
4791
class cmd_split(Command):
4958
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4792
    """Split a subdirectory of a tree into a separate tree.
4959
4793
 
4960
4794
    This command will produce a target tree in a format that supports
4961
4795
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4981
4815
 
4982
4816
 
4983
4817
class cmd_merge_directive(Command):
4984
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4818
    """Generate a merge directive for auto-merge tools.
4985
4819
 
4986
4820
    A directive requests a merge to be performed, and also provides all the
4987
4821
    information necessary to do so.  This means it must either include a
5080
4914
 
5081
4915
 
5082
4916
class cmd_send(Command):
5083
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4917
    """Mail or create a merge-directive for submitting changes.
5084
4918
 
5085
4919
    A merge directive provides many things needed for requesting merges:
5086
4920
 
5092
4926
      directly from the merge directive, without retrieving data from a
5093
4927
      branch.
5094
4928
 
5095
 
    `bzr send` creates a compact data set that, when applied using bzr
5096
 
    merge, has the same effect as merging from the source branch.  
5097
 
    
5098
 
    By default the merge directive is self-contained and can be applied to any
5099
 
    branch containing submit_branch in its ancestory without needing access to
5100
 
    the source branch.
5101
 
    
5102
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5103
 
    revisions, but only a structured request to merge from the
5104
 
    public_location.  In that case the public_branch is needed and it must be
5105
 
    up-to-date and accessible to the recipient.  The public_branch is always
5106
 
    included if known, so that people can check it later.
5107
 
 
5108
 
    The submit branch defaults to the parent of the source branch, but can be
5109
 
    overridden.  Both submit branch and public branch will be remembered in
5110
 
    branch.conf the first time they are used for a particular branch.  The
5111
 
    source branch defaults to that containing the working directory, but can
5112
 
    be changed using --from.
5113
 
 
5114
 
    In order to calculate those changes, bzr must analyse the submit branch.
5115
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5116
 
    If a public location is known for the submit_branch, that location is used
5117
 
    in the merge directive.
5118
 
 
5119
 
    The default behaviour is to send the merge directive by mail, unless -o is
5120
 
    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.
5121
4941
 
5122
4942
    Mail is sent using your preferred mail program.  This should be transparent
5123
4943
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5125
4945
 
5126
4946
    To use a specific mail program, set the mail_client configuration option.
5127
4947
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5128
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5129
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5130
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5131
 
    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.
5132
4951
 
5133
4952
    If mail is being sent, a to address is required.  This can be supplied
5134
4953
    either on the commandline, by setting the submit_to configuration
5143
4962
 
5144
4963
    The merge directives created by bzr send may be applied using bzr merge or
5145
4964
    bzr pull by specifying a file containing a merge directive as the location.
5146
 
 
5147
 
    bzr send makes extensive use of public locations to map local locations into
5148
 
    URLs that can be used by other people.  See `bzr help configuration` to
5149
 
    set them, and use `bzr info` to display them.
5150
4965
    """
5151
4966
 
5152
4967
    encoding_type = 'exact'
5168
4983
               short_name='f',
5169
4984
               type=unicode),
5170
4985
        Option('output', short_name='o',
5171
 
               help='Write merge directive to this file or directory; '
 
4986
               help='Write merge directive to this file; '
5172
4987
                    'use - for stdout.',
5173
4988
               type=unicode),
5174
4989
        Option('strict',
5197
5012
 
5198
5013
 
5199
5014
class cmd_bundle_revisions(cmd_send):
5200
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5015
    """Create a merge-directive for submitting changes.
5201
5016
 
5202
5017
    A merge directive provides many things needed for requesting merges:
5203
5018
 
5270
5085
 
5271
5086
 
5272
5087
class cmd_tag(Command):
5273
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5088
    """Create, remove or modify a tag naming a revision.
5274
5089
 
5275
5090
    Tags give human-meaningful names to revisions.  Commands that take a -r
5276
5091
    (--revision) option can be given -rtag:X, where X is any previously
5284
5099
 
5285
5100
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5286
5101
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5287
 
 
5288
 
    If no tag name is specified it will be determined through the 
5289
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5290
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5291
 
    details.
5292
5102
    """
5293
5103
 
5294
5104
    _see_also = ['commit', 'tags']
5295
 
    takes_args = ['tag_name?']
 
5105
    takes_args = ['tag_name']
5296
5106
    takes_options = [
5297
5107
        Option('delete',
5298
5108
            help='Delete this tag rather than placing it.',
5308
5118
        'revision',
5309
5119
        ]
5310
5120
 
5311
 
    def run(self, tag_name=None,
 
5121
    def run(self, tag_name,
5312
5122
            delete=None,
5313
5123
            directory='.',
5314
5124
            force=None,
5315
5125
            revision=None,
5316
5126
            ):
5317
5127
        branch, relpath = Branch.open_containing(directory)
5318
 
        self.add_cleanup(branch.lock_write().unlock)
5319
 
        if delete:
5320
 
            if tag_name is None:
5321
 
                raise errors.BzrCommandError("No tag specified to delete.")
5322
 
            branch.tags.delete_tag(tag_name)
5323
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5324
 
        else:
5325
 
            if revision:
5326
 
                if len(revision) != 1:
5327
 
                    raise errors.BzrCommandError(
5328
 
                        "Tags can only be placed on a single revision, "
5329
 
                        "not on a range")
5330
 
                revision_id = revision[0].as_revision_id(branch)
 
5128
        branch.lock_write()
 
5129
        try:
 
5130
            if delete:
 
5131
                branch.tags.delete_tag(tag_name)
 
5132
                self.outf.write('Deleted tag %s.\n' % tag_name)
5331
5133
            else:
5332
 
                revision_id = branch.last_revision()
5333
 
            if tag_name is None:
5334
 
                tag_name = branch.automatic_tag_name(revision_id)
5335
 
                if tag_name is None:
5336
 
                    raise errors.BzrCommandError(
5337
 
                        "Please specify a tag name.")
5338
 
            if (not force) and branch.tags.has_tag(tag_name):
5339
 
                raise errors.TagAlreadyExists(tag_name)
5340
 
            branch.tags.set_tag(tag_name, revision_id)
5341
 
            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()
5342
5148
 
5343
5149
 
5344
5150
class cmd_tags(Command):
5345
 
    __doc__ = """List tags.
 
5151
    """List tags.
5346
5152
 
5347
5153
    This command shows a table of tag names and the revisions they reference.
5348
5154
    """
5376
5182
        if not tags:
5377
5183
            return
5378
5184
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
5380
 
        if revision:
5381
 
            graph = branch.repository.get_graph()
5382
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5383
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5384
 
            # only show revisions between revid1 and revid2 (inclusive)
5385
 
            tags = [(tag, revid) for tag, revid in tags if
5386
 
                graph.is_between(revid, revid1, revid2)]
5387
 
        if sort == 'alpha':
5388
 
            tags.sort()
5389
 
        elif sort == 'time':
5390
 
            timestamps = {}
5391
 
            for tag, revid in tags:
5392
 
                try:
5393
 
                    revobj = branch.repository.get_revision(revid)
5394
 
                except errors.NoSuchRevision:
5395
 
                    timestamp = sys.maxint # place them at the end
5396
 
                else:
5397
 
                    timestamp = revobj.timestamp
5398
 
                timestamps[revid] = timestamp
5399
 
            tags.sort(key=lambda x: timestamps[x[1]])
5400
 
        if not show_ids:
5401
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5402
 
            for index, (tag, revid) in enumerate(tags):
5403
 
                try:
5404
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5405
 
                    if isinstance(revno, tuple):
5406
 
                        revno = '.'.join(map(str, revno))
5407
 
                except errors.NoSuchRevision:
5408
 
                    # Bad tag data/merges can lead to tagged revisions
5409
 
                    # which are not in this branch. Fail gracefully ...
5410
 
                    revno = '?'
5411
 
                tags[index] = (tag, revno)
5412
 
        self.cleanup_now()
 
5185
        branch.lock_read()
 
5186
        try:
 
5187
            if revision:
 
5188
                graph = branch.repository.get_graph()
 
5189
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5190
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5191
                # only show revisions between revid1 and revid2 (inclusive)
 
5192
                tags = [(tag, revid) for tag, revid in tags if
 
5193
                    graph.is_between(revid, revid1, revid2)]
 
5194
            if sort == 'alpha':
 
5195
                tags.sort()
 
5196
            elif sort == 'time':
 
5197
                timestamps = {}
 
5198
                for tag, revid in tags:
 
5199
                    try:
 
5200
                        revobj = branch.repository.get_revision(revid)
 
5201
                    except errors.NoSuchRevision:
 
5202
                        timestamp = sys.maxint # place them at the end
 
5203
                    else:
 
5204
                        timestamp = revobj.timestamp
 
5205
                    timestamps[revid] = timestamp
 
5206
                tags.sort(key=lambda x: timestamps[x[1]])
 
5207
            if not show_ids:
 
5208
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5209
                for index, (tag, revid) in enumerate(tags):
 
5210
                    try:
 
5211
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5212
                        if isinstance(revno, tuple):
 
5213
                            revno = '.'.join(map(str, revno))
 
5214
                    except errors.NoSuchRevision:
 
5215
                        # Bad tag data/merges can lead to tagged revisions
 
5216
                        # which are not in this branch. Fail gracefully ...
 
5217
                        revno = '?'
 
5218
                    tags[index] = (tag, revno)
 
5219
        finally:
 
5220
            branch.unlock()
5413
5221
        for tag, revspec in tags:
5414
5222
            self.outf.write('%-20s %s\n' % (tag, revspec))
5415
5223
 
5416
5224
 
5417
5225
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5226
    """Reconfigure the type of a bzr directory.
5419
5227
 
5420
5228
    A target configuration must be specified.
5421
5229
 
5451
5259
            ),
5452
5260
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5453
5261
        Option('force',
5454
 
            help='Perform reconfiguration even if local changes'
5455
 
            ' will be lost.'),
5456
 
        Option('stacked-on',
5457
 
            help='Reconfigure a branch to be stacked on another branch.',
5458
 
            type=unicode,
5459
 
            ),
5460
 
        Option('unstacked',
5461
 
            help='Reconfigure a branch to be unstacked.  This '
5462
 
                'may require copying substantial data into it.',
5463
 
            ),
 
5262
               help='Perform reconfiguration even if local changes'
 
5263
               ' will be lost.')
5464
5264
        ]
5465
5265
 
5466
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5467
 
            stacked_on=None,
5468
 
            unstacked=None):
 
5266
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5469
5267
        directory = bzrdir.BzrDir.open(location)
5470
 
        if stacked_on and unstacked:
5471
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5472
 
        elif stacked_on is not None:
5473
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5474
 
        elif unstacked:
5475
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5476
 
        # At the moment you can use --stacked-on and a different
5477
 
        # reconfiguration shape at the same time; there seems no good reason
5478
 
        # to ban it.
5479
5268
        if target_type is None:
5480
 
            if stacked_on or unstacked:
5481
 
                return
5482
 
            else:
5483
 
                raise errors.BzrCommandError('No target configuration '
5484
 
                    'specified')
 
5269
            raise errors.BzrCommandError('No target configuration specified')
5485
5270
        elif target_type == 'branch':
5486
5271
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5487
5272
        elif target_type == 'tree':
5506
5291
 
5507
5292
 
5508
5293
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
 
5294
    """Set the branch of a checkout and update.
5510
5295
 
5511
5296
    For lightweight checkouts, this changes the branch being referenced.
5512
5297
    For heavyweight checkouts, this checks that there are no local commits
5524
5309
    /path/to/newbranch.
5525
5310
 
5526
5311
    Bound branches use the nickname of its master branch unless it is set
5527
 
    locally, in which case switching will update the local nickname to be
 
5312
    locally, in which case switching will update the the local nickname to be
5528
5313
    that of the master.
5529
5314
    """
5530
5315
 
5531
 
    takes_args = ['to_location?']
 
5316
    takes_args = ['to_location']
5532
5317
    takes_options = [Option('force',
5533
5318
                        help='Switch even if local commits will be lost.'),
5534
 
                     'revision',
5535
5319
                     Option('create-branch', short_name='b',
5536
5320
                        help='Create the target branch from this one before'
5537
5321
                             ' switching to it.'),
5538
 
                    ]
 
5322
                     ]
5539
5323
 
5540
 
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5324
    def run(self, to_location, force=False, create_branch=False):
5542
5325
        from bzrlib import switch
5543
5326
        tree_location = '.'
5544
 
        revision = _get_one_revision('switch', revision)
5545
5327
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
 
        if to_location is None:
5547
 
            if revision is None:
5548
 
                raise errors.BzrCommandError('You must supply either a'
5549
 
                                             ' revision or a location')
5550
 
            to_location = '.'
5551
5328
        try:
5552
5329
            branch = control_dir.open_branch()
5553
5330
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5558
5335
            if branch is None:
5559
5336
                raise errors.BzrCommandError('cannot create branch without'
5560
5337
                                             ' source branch')
5561
 
            to_location = directory_service.directories.dereference(
5562
 
                              to_location)
5563
5338
            if '/' not in to_location and '\\' not in to_location:
5564
5339
                # This path is meant to be relative to the existing branch
5565
5340
                this_url = self._get_branch_location(control_dir)
5567
5342
            to_branch = branch.bzrdir.sprout(to_location,
5568
5343
                                 possible_transports=[branch.bzrdir.root_transport],
5569
5344
                                 source_branch=branch).open_branch()
 
5345
            # try:
 
5346
            #     from_branch = control_dir.open_branch()
 
5347
            # except errors.NotBranchError:
 
5348
            #     raise BzrCommandError('Cannot create a branch from this'
 
5349
            #         ' location when we cannot open this branch')
 
5350
            # from_branch.bzrdir.sprout(
 
5351
            pass
5570
5352
        else:
5571
5353
            try:
5572
5354
                to_branch = Branch.open(to_location)
5574
5356
                this_url = self._get_branch_location(control_dir)
5575
5357
                to_branch = Branch.open(
5576
5358
                    urlutils.join(this_url, '..', to_location))
5577
 
        if revision is not None:
5578
 
            revision = revision.as_revision_id(to_branch)
5579
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5359
        switch.switch(control_dir, to_branch, force)
5580
5360
        if had_explicit_nick:
5581
5361
            branch = control_dir.open_branch() #get the new branch!
5582
5362
            branch.nick = to_branch.nick
5602
5382
 
5603
5383
 
5604
5384
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5385
    """Manage filtered views.
5606
5386
 
5607
5387
    Views provide a mask over the tree so that users can focus on
5608
5388
    a subset of a tree when doing their work. After creating a view,
5756
5536
 
5757
5537
 
5758
5538
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5539
    """Show hooks."""
5760
5540
 
5761
5541
    hidden = True
5762
5542
 
5775
5555
                    self.outf.write("    <no hooks installed>\n")
5776
5556
 
5777
5557
 
5778
 
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
5780
 
 
5781
 
    This will remove the branch from the specified location but 
5782
 
    will keep any working tree or repository in place.
5783
 
 
5784
 
    :Examples:
5785
 
 
5786
 
      Remove the branch at repo/trunk::
5787
 
 
5788
 
        bzr remove-branch repo/trunk
5789
 
 
5790
 
    """
5791
 
 
5792
 
    takes_args = ["location?"]
5793
 
 
5794
 
    aliases = ["rmbranch"]
5795
 
 
5796
 
    def run(self, location=None):
5797
 
        if location is None:
5798
 
            location = "."
5799
 
        branch = Branch.open_containing(location)[0]
5800
 
        branch.bzrdir.destroy_branch()
5801
 
        
5802
 
 
5803
5558
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5559
    """Temporarily set aside some changes from the current tree.
5805
5560
 
5806
5561
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5562
    ie. out of the way, until a later time when you can bring them back from
5849
5604
        if writer is None:
5850
5605
            writer = bzrlib.option.diff_writer_registry.get()
5851
5606
        try:
5852
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5853
 
                file_list, message, destroy=destroy)
5854
 
            try:
5855
 
                shelver.run()
5856
 
            finally:
5857
 
                shelver.finalize()
 
5607
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5608
                              message, destroy=destroy).run()
5858
5609
        except errors.UserAbort:
5859
5610
            return 0
5860
5611
 
5861
5612
    def run_for_list(self):
5862
5613
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
5864
 
        manager = tree.get_shelf_manager()
5865
 
        shelves = manager.active_shelves()
5866
 
        if len(shelves) == 0:
5867
 
            note('No shelved changes.')
5868
 
            return 0
5869
 
        for shelf_id in reversed(shelves):
5870
 
            message = manager.get_metadata(shelf_id).get('message')
5871
 
            if message is None:
5872
 
                message = '<no message>'
5873
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5874
 
        return 1
 
5614
        tree.lock_read()
 
5615
        try:
 
5616
            manager = tree.get_shelf_manager()
 
5617
            shelves = manager.active_shelves()
 
5618
            if len(shelves) == 0:
 
5619
                note('No shelved changes.')
 
5620
                return 0
 
5621
            for shelf_id in reversed(shelves):
 
5622
                message = manager.get_metadata(shelf_id).get('message')
 
5623
                if message is None:
 
5624
                    message = '<no message>'
 
5625
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5626
            return 1
 
5627
        finally:
 
5628
            tree.unlock()
5875
5629
 
5876
5630
 
5877
5631
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5632
    """Restore shelved changes.
5879
5633
 
5880
5634
    By default, the most recently shelved changes are restored. However if you
5881
5635
    specify a shelf by id those changes will be restored instead.  This works
5889
5643
            enum_switch=False, value_switches=True,
5890
5644
            apply="Apply changes and remove from the shelf.",
5891
5645
            dry_run="Show changes, but do not apply or remove them.",
5892
 
            preview="Instead of unshelving the changes, show the diff that "
5893
 
                    "would result from unshelving.",
5894
 
            delete_only="Delete changes without applying them.",
5895
 
            keep="Apply changes but don't delete them.",
 
5646
            delete_only="Delete changes without applying them."
5896
5647
        )
5897
5648
    ]
5898
5649
    _see_also = ['shelve']
5899
5650
 
5900
5651
    def run(self, shelf_id=None, action='apply'):
5901
5652
        from bzrlib.shelf_ui import Unshelver
5902
 
        unshelver = Unshelver.from_args(shelf_id, action)
5903
 
        try:
5904
 
            unshelver.run()
5905
 
        finally:
5906
 
            unshelver.tree.unlock()
 
5653
        Unshelver.from_args(shelf_id, action).run()
5907
5654
 
5908
5655
 
5909
5656
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
 
5657
    """Remove unwanted files from working tree.
5911
5658
 
5912
5659
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
5660
    files are never deleted.
5941
5688
 
5942
5689
 
5943
5690
class cmd_reference(Command):
5944
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5691
    """list, view and set branch locations for nested trees.
5945
5692
 
5946
5693
    If no arguments are provided, lists the branch locations for nested trees.
5947
5694
    If one argument is provided, display the branch location for that tree.
5987
5734
            self.outf.write('%s %s\n' % (path, location))
5988
5735
 
5989
5736
 
5990
 
def _register_lazy_builtins():
5991
 
    # register lazy builtins from other modules; called at startup and should
5992
 
    # be only called once.
5993
 
    for (name, aliases, module_name) in [
5994
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5995
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5996
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5997
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5998
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
5999
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6000
 
        ]:
6001
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5737
# these get imported and then picked up by the scan for cmd_*
 
5738
# TODO: Some more consistent way to split command definitions across files;
 
5739
# we do need to load at least some information about them to know of
 
5740
# aliases.  ideally we would avoid loading the implementation until the
 
5741
# details were needed.
 
5742
from bzrlib.cmd_version_info import cmd_version_info
 
5743
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5744
from bzrlib.bundle.commands import (
 
5745
    cmd_bundle_info,
 
5746
    )
 
5747
from bzrlib.foreign import cmd_dpush
 
5748
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5749
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5750
        cmd_weave_plan_merge, cmd_weave_merge_text